-
Story
-
Resolution: Done
-
Major
-
None
-
None
-
2
-
False
-
None
-
False
-
SECFLOWOTL-24 - Openshift Builds (Shipwright) : GA v1.0
-
-
-
Pipeline Integrations #3247
-
1
Story (Required)
As a user I want to run a s2i build, I need to find a technical detailed documentation listing the steps to do so
<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?>
Background (Required)
Openshift builds offers a capability to build an image using the s2i strategy.
To make onboarding to openshift-builds easier and enhance the user experience around openshift-builds, we need to document real user use cases.
Out of scope
- Document openshift-builds installation: samples documentation should assume a running openshift cluster with openshift-builds installed
- Document troubelshooting any issue related to installtion or a running openshift builds controller
Approach (Required)
- Withing a running openshift cluster and installed build controller
- Document and install redhat s2i strategy https://github.com/shipwright-io/build/blob/main/samples/buildstrategy/source-to-image/buildstrategy_source-to-image-redhat_cr.yaml
- Create and document a build object using an example
- Create and document a buildrun object
- Show the resulting image
Dependencies
<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>
Acceptance Criteria (Mandatory)
- A google docs documentation created with detailed steps on how to run s2i build using openshift-builds
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