-
Story
-
Resolution: Done
-
Major
-
None
-
2
-
False
-
None
-
False
-
SECFLOWOTL-24 - Openshift Builds (Shipwright) : GA v1.0
-
-
-
Pipeline Integrations #3246, Pipeline Integrations #3247
-
2
Story (Required)
<Describes high level purpose and goal for this story. Answers the questions: Who is impacted, what is it and why do we need it? How does it improve the customer's experience?>
As a developer trying to build containers with Shipwright I want to use a set of supported Red Hat ClusterBuildStrategies so that I can quickly build my applications with Shipwright.
Background (Required)
<Describes the context or background related to this story>
Shipwright has an upstream set of example build strategies.
When we provide Shipwright downstream, we will want to give clear guidance as to which ClusterBuildStrategies are supported.
We will also want to provide a quick way for customers to install cluster build strategies - for instance, via a single `oc apply` command.
Out of scope
<Defines what is not included in this story>
- Automate installation of cluster build strategies
- BuildPacks build strategy (Taken care of by https://issues.redhat.com/browse/BUILD-631)
- CI Testing that includes strategies from this catalog
Approach (Required)
<Description of the general technical path on how to achieve the goal of the story. Include details like json schema, class definitions>
- Establish a GitHub repository to store our set of supported cluster build strategies
- Add strategies for s2i, buildah.
- Update our documentation to only reference our catalog for installing cluster build strategies
- "Installing Sample Build Strategies" - remove strategies that are not in this catalog, update commands to reference the correct YAML location
- "Configuring Build Strategies" - update to provide an example for buildah, and showcase buildah with small, medium, and large memory consumption.
- Add patch description to the csv to invite the user to install the build strategies from the catalog
Dependencies
<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>
Acceptance Criteria (Mandatory)
<Describe edge cases to consider when implementing the story and defining tests>
<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>
- Creation of the redhat-developer/openshift-builds-catalog repository
- S2I build strategy listed in the catalog within the redhat-developer/openshift-builds-catalog repository
- Buildah strategy listed in the catalog within the redhat-developer/openshift-builds-catalog repository
- Each strategy has a README.md file explaining all the parameters for a given strategy
- The README.md also has a basic example explaining the usage of respective buildStrategy.
- Installation instructions provided within the README.md file of the redhat-developer/openshift-builds-catalog repository
INVEST Checklist
Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated
Legend
Unknown
Verified
Unsatisfied
Done Checklist
- Code is completed, reviewed, documented and checked in
- Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
- Continuous Delivery pipeline(s) is able to proceed with new code included
- Customer facing documentation, API docs etc. are produced/updated, reviewed and published
- Acceptance criteria are met