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

• Allow cluster admins to gauge the functional and performance health of OVN-Kubernetes from OCP console and using support documentation, it can resolve any abnormal indicators. 

What needs to be done

• Find out how the dashboard will be exposed to the user via OCP console.
  • Can we leverage observabilities existing dashboards or do we go a separate route?
• Identify stakeholders that will give input and direction
• Identify metrics and alerts we would like to expose to gauge OVN-Kubernetes functional and performance health
• Create dashboard mockup
• Get agreement from stakeholders using the mockup before development
• Create dashboard
• Identify where dashboard supporting documentation will live.
  • This will help SREs and/or cluster admins interpret the dashboard and what to do when its not normal
• Create the support documentation

Why is this important?

• OVN-Kubernetes is complex. Networking is complex. Cluster admins / SREs need a place to quickly gauge the health of their networking.

Scenarios

1. ...

Acceptance Criteria

• CI - MUST be running successfully with tests automated
• Release Technical Enablement - Provide necessary release enablement details and documents.
• Dashboard is consumable via console
• Support documentation is available

Dependencies (internal and external)

1. ...

Previous Work (Optional):

1.  Current metrics descriptions: https://docs.google.com/document/d/1lItYV0tTt5-ivX77izb1KuzN9S8-7YgO9ndlhATaVUg/edit

Open questions::

1. How will it be exposed to users via the OCP console?
2. Who will help guide what the dashboard contains?
3. What do we want to expose to measure OVNs function and performance?
4. How can we create tests for the dashboard which will be executed for each release?
5. Where will the dashboards support docs be located?
6. How can the docs be accessible/linkable from the OCP console?

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>