OCP/Telco Definition of Done
Epic Template descriptions and documentation.

<--- Cut-n-Paste the entire contents of this description into your new Epic --->

Epic Goal

• Add a "Status" column for `LVMCluster` objects in the `oc get` output.

Why is this important?

• It's not readily apparent what the status is of an LVMCluster object (e.g. pending vs created).

Scenarios

1. Cluster admin creates an LVMCluster object and needs to know when it is successfully created or if it has failed to create.
2. When provisioning a new PV fails, for example due to lack of storage, the admin currently sees only a "ScheduleFailed" event with "not enough storage" from the kube scheduler.

It can be hard to debug and understand whats going on behind the scenes, esp. when "spare-gb" setting is used. Looking at the VG the admin sees space available, still the provision fails (correctly).

The goal of this epic to provide more detailed error messages to the admin. A "natural" place to look for is the "status" field of the PVC. Can we have a Error message like

"Can't create PV because not enough storage. Node X has Y amount of storage free (Z Gb blocked by spare capacity) [repeat for all nodes]"

Other error messages should also show up there (e.g. if PV creation fails due to invalid pvcreate options, errors from LVM, LVMD etc.)

Acceptance Criteria

• CI - MUST be running successfully with tests automated
• Release Technical Enablement - Provide necessary release enablement details and documents.
• ...

Dependencies (internal and external)

1. ...

Previous Work (Optional):

1. …

Open questions::

1. …

Done Checklist

• CI - CI is running, tests are automated and merged.
• Release Enablement <link to Feature Enablement Presentation>
• DEV - Upstream code and tests merged: <link to meaningful PR or GitHub Issue>
• DEV - Upstream documentation merged: <link to meaningful PR or GitHub Issue>
• DEV - Downstream build attached to advisory: <link to errata>
• QE - Test plans in Polarion: <link or reference to Polarion>
• QE - Automated tests merged: <link or reference to automated tests>
• DOC - Downstream documentation merged: <link to meaningful PR>