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

• Create example code repositories for OpenShift core components that allow platform specific customization. These examples repositories will contain code for core components with the platform specific functions replaced by templates that partners can use to implement their platform specific business logic. The repositories will also contain documentation and build artifacts to instruct on the best practices for deploying and managing these components. This will allow partners to more rapidly create replacement components for their specific infrastructure needs.

Why is this important?

• For partners wishing to create platform specific integrations with OpenShift there is a high level of complexity in understanding how to replace the core components. By providing examples for the core components that allow platform specific customization we will accelerate our partner's understanding of the complexity and help them to create their custom components. This will result in more partners being able to create platform specific installations of OpenShift without the need to integrate code directly with Red Hat.

Scenarios

1. A partner wishes to use their own network solutions for egress traffic from the container network. They use the example the Cloud Network Config Controller (CNCC) repository to create a new project that can perform this functionality. By following the code samples and documentation in the project they are able to quickly bootstrap a replacement for the Red Hat CNCC which performs infrastructure specific actions on the partner's platform.
2. A partner wishes to create a Machine controller for Machine API so that they can enable node auto-healing and cluster autoscaling on their platform for OpenShift. They use the example Machine controller repository to create a controller specifically for their infrastructure. By following the code samples and documentation in the project they are able to quickly produce a Machine controller that interacts with their infrastructure.

Acceptance Criteria

• Partners can use example code repositories to bootstrap any of the supplementable/replaceable components in their OpenShift installations.

Dependencies (internal and external)

1. This work will depend on the team conversations that take place in OCPPLAN-9429, some action could be taken to begin the process but the specifics of what will be in the example repositories will be highly informed by the owning teams.

Previous Work (Optional):

1. Identifying OpenShift Components for Install Flexibility

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>