diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index d678669fddef..97fa718edec9 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -49,14 +49,8 @@ Name: Configure Dir: configuring Distros: openshift-builds Topics: -- Name: Configuring Builds +- Name: Customize your build strategy and runtime options File: configuring-openshift-builds -- Name: Configuring build strategies - File: configuring-build-strategies -- Name: Configuring build runs - File: configuring-build-runs -- Name: Isolate build workloads for security and compliance - File: isolate-build-workloads-for-security-and-compliance --- Name: Work with Builds Dir: work_with_builds diff --git a/about/build-strategies.adoc b/about/build-strategies.adoc index 97537f0802c0..d3d84ccd8ee3 100644 --- a/about/build-strategies.adoc +++ b/about/build-strategies.adoc @@ -29,5 +29,4 @@ include::modules/ob-about-buildpacks.adoc[leveloffset=+1] * xref:../installing/installing-openshift-builds.adoc#installing-builds-with-operator_installing-openshift-builds[Installing {builds-shortname} by using the web console] * xref:../installing/installing-openshift-builds.adoc#installing-builds-using-CLI_installing-openshift-builds[Installing {builds-shortname} by using the CLI] -* xref:../configuring/configuring-build-strategies.adoc#configuring-build-strategies[Configuring build strategies] * xref:../installing/installing-openshift-builds.adoc#creating-a-shipwright-build-resource-console_installing-openshift-builds[Creating a ShipwrightBuild resource by using the web console] diff --git a/configuring/configuring-build-runs.adoc b/configuring/configuring-build-runs.adoc deleted file mode 100644 index 0e1c9d88df77..000000000000 --- a/configuring/configuring-build-runs.adoc +++ /dev/null @@ -1,54 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="configuring-build-runs"] -= Configuring build runs - -include::_attributes/common-attributes.adoc[] -:context: configuring-build-runs - -toc::[] - -[role="_abstract"] -Platform engineers configure build runs by defining the build reference, parameters, service account, output settings, retention rules, and volumes in a `BuildRun` custom resource (CR). A `BuildRun` CR manages how individual builds execute within a namespace, controlling runtime behavior. - -include::modules/ob-configurable-fields-in-build-run.adoc[leveloffset=+1] - -include::modules/ob-defining-the-build-reference.adoc[leveloffset=+1] - -include::modules/ob-defining-the-build-specification.adoc[leveloffset=+1] - -include::modules/ob-defining-param-values-in-build-run.adoc[leveloffset=+1] - -include::modules/ob-defining-the-service-account.adoc[leveloffset=+1] - -include::modules/ob-defining-retention-parameters-in-build-run.adoc[leveloffset=+1] - -include::modules/ob-defining-volumes-in-build-run.adoc[leveloffset=+1] - -include::modules/ob-specifying-environment-variables.adoc[leveloffset=+1] - -include::modules/ob-build-run-status.adoc[leveloffset=+1] - -include::modules/ob-understanding-the-status-of-a-build-run.adoc[leveloffset=+2] - -include::modules/ob-understanding-failed-build-runs.adoc[leveloffset=+2] - -include::modules/ob-step-results-in-build-run-status.adoc[leveloffset=+2] - -include::modules/ob-build-snapshot.adoc[leveloffset=+2] - -include::modules/ob-relationship-of-build-run-with-tekton-tasks.adoc[leveloffset=+1] - -include::modules/ob-canceling-a-build-run.adoc[leveloffset=+1] - -include::modules/ob-automatic-build-run-deletion.adoc[leveloffset=+1] - -include::modules/ob-configuring-pods-in-build-run.adoc[leveloffset=+1] - -// [role="_additional-resources"] -// == Additional resources -[role="_additional-resources"] -[id="additional-resources_installing-openshift-builds"] -== Additional resources - -* xref:../work_with_builds/creating-container-images.adoc#creating-container-images[Creating container images] - diff --git a/configuring/configuring-build-strategies.adoc b/configuring/configuring-build-strategies.adoc deleted file mode 100644 index 48caa2b507b7..000000000000 --- a/configuring/configuring-build-strategies.adoc +++ /dev/null @@ -1,36 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="configuring-build-strategies"] -= Configuring build strategies - -include::_attributes/common-attributes.adoc[] -:context: configuring-build-strategies - -toc::[] - -[role="_abstract"] -Platform engineers can define consistent build strategies by specifying parameters, system settings, resource requirements, annotations, and volumes in `BuildStrategy` or `ClusterBuildStrategy` custom resources (CRs). These strategies enable controlled and reusable build execution across the cluster. - -include::modules/ob-defining-strategy-parameters.adoc[leveloffset=+1] - -include::modules/ob-defining-system-parameters.adoc[leveloffset=+1] - -include::modules/ob-defining-step-resources.adoc[leveloffset=+1] - -include::modules/ob-strategies-with-different-resources.adoc[leveloffset=+2] - -include::modules/ob-resource-management-in-tekton-pipelines.adoc[leveloffset=+2] - -include::modules/ob-defining-annotations.adoc[leveloffset=+1] - -include::modules/ob-securely-referencing-string-parameters.adoc[leveloffset=+1] - -include::modules/ob-defining-system-results.adoc[leveloffset=+1] - -include::modules/ob-defining-volumes-and-volume-mounts.adoc[leveloffset=+1] - - - -// [role="_additional-resources"] -// [id="additional-resources_configuring-build-strategies"] -// == Additional resources - diff --git a/configuring/configuring-openshift-builds.adoc b/configuring/configuring-openshift-builds.adoc index b2645fa8d2cf..b09a3efc19e9 100644 --- a/configuring/configuring-openshift-builds.adoc +++ b/configuring/configuring-openshift-builds.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="configuring-openshift-builds"] -= Configuring Builds += Customize your build strategy and runtime options include::_attributes/common-attributes.adoc[] :context: configuring-openshift-builds @@ -10,25 +10,57 @@ toc::[] [role="_abstract"] Platform engineers can define source code location, build strategy, parameters, output settings, retention rules, and volumes in a `Build` custom resource (CR). A `Build` CR enables consistent build pod configuration and provides a namespace-scoped method for managing build execution on the cluster. -include::modules/ob-configurable-fields-in-build.adoc[leveloffset=+1] +include::modules/ob-define-build-inputs-and-source-code.adoc[leveloffset=+1] -include::modules/ob-defining-the-source.adoc[leveloffset=+1] +include::modules/ob-defining-the-source.adoc[leveloffset=+2] -include::modules/ob-defining-the-strategy.adoc[leveloffset=+1] +include::modules/ob-defining-the-strategy.adoc[leveloffset=+2] -include::modules/ob-defining-param-values.adoc[leveloffset=+1] +include::modules/ob-defining-the-container-file.adoc[leveloffset=+2] -include::modules/ob-example-configuration-for-defining-parameter-values.adoc[leveloffset=+2] +include::modules/ob-defining-the-build-specification.adoc[leveloffset=+2] -include::modules/ob-defining-the-container-file.adoc[leveloffset=+1] +include::modules/ob-configuring-pods-in-build.adoc[leveloffset=+2] -include::modules/ob-defining-the-output.adoc[leveloffset=+1] +include::modules/ob-defining-the-service-account.adoc[leveloffset=+2] -include::modules/ob-defining-retention-parameters.adoc[leveloffset=+1] +include::modules/ob-specifying-environment-variables.adoc[leveloffset=+2] -include::modules/ob-defining-volumes.adoc[leveloffset=+1] +include::modules/ob-defining-volumes.adoc[leveloffset=+2] -include::modules/ob-configuring-pods-in-build.adoc[leveloffset=+1] +include::modules/ob-resource-management-in-tekton-pipelines.adoc[leveloffset=+2] + +include::modules/ob-configure-build-inputs-and-outputs.adoc[leveloffset=+1] + +include::modules/ob-defining-the-output.adoc[leveloffset=+2] + +include::modules/ob-defining-param-values.adoc[leveloffset=+2] + +include::modules/ob-example-configuration-for-defining-parameter-values.adoc[leveloffset=+3] + +include::modules/ob-defining-the-build-reference.adoc[leveloffset=+2] + +include::modules/ob-run-and-customize-build-execution.adoc[leveloffset=+1] + +include::modules/ob-configuring-pods-in-build-run.adoc[leveloffset=+2] + +include::modules/ob-defining-volumes-in-build-run.adoc[leveloffset=+2] + +include::modules/ob-defining-param-values-in-build-run.adoc[leveloffset=+2] + +include::modules/ob-defining-retention-parameters-in-build-run.adoc[leveloffset=+2] + +include::modules/ob-track-build-progress-and-manage-running-builds.adoc[leveloffset=+1] + +include::modules/ob-build-run-status.adoc[leveloffset=+2] + +include::modules/ob-canceling-a-build-run.adoc[leveloffset=+2] + +include::modules/ob-defining-system-results.adoc[leveloffset=+2] + +include::modules/ob-capture-and-reuse-build-information.adoc[leveloffset=+1] + +include::modules/ob-build-snapshot.adoc[leveloffset=+2] // [role="_additional-resources"] diff --git a/configuring/isolate-build-workloads-for-security-and-compliance.adoc b/configuring/isolate-build-workloads-for-security-and-compliance.adoc deleted file mode 100644 index 0b60b6f7e2bc..000000000000 --- a/configuring/isolate-build-workloads-for-security-and-compliance.adoc +++ /dev/null @@ -1,28 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY - -[id="isolate-build-workloads-for-security-and-compliance_{context}"] -= Isolate build workloads for security and compliance - -include::_attributes/common-attributes.adoc[] - -:context: isolate-build-workloads - -toc::[] - -[role="_abstract"] -Configure builds to run with alternative container runtimes by using the `runtimeClassName` field to improve workload isolation or meet specific compliance requirements. - -:FeatureName: Builds in sandbox containers -include::snippets/technology-preview.adoc[] - -include::modules/ob-runtimeclass-prerequisites-and-precedence.adoc[leveloffset=+1] - -include::modules/ob-isolate-all-project-builds-using-a-specific-runtimeclass.adoc[leveloffset=+1] - -include::modules/ob-override-runtimeclass-for-specific-build-run.adoc[leveloffset=+1] - -[role="_additional-resources"] -== Additional resources - -* link:https://docs.redhat.com/en/documentation/openshift_sandboxed_containers/[OpenShift Sandboxed Containers documentation] -* link:https://kubernetes.io/docs/concepts/containers/runtime-class/[Kubernetes RuntimeClass documentation] diff --git a/modules/ob-capture-and-reuse-build-information.adoc b/modules/ob-capture-and-reuse-build-information.adoc new file mode 100644 index 000000000000..95c4b26b2375 --- /dev/null +++ b/modules/ob-capture-and-reuse-build-information.adoc @@ -0,0 +1,10 @@ +// This module is included in the following assembly: +// +// * configuring/configuring-openshift-builds.adoc + +:_mod-docs-content-type: CONCEPT +[id="ob-capture-and-reuse-build-information_{context}"] += Capture and reuse build information + +[role="_abstract"] +Access build snapshots for debugging and reproducibility. The `BuildRun` custom resource (CR) captures a snapshot of the build configuration at execution time, enabling you to reproduce builds with the exact same settings and troubleshoot issues by examining the configuration used during a specific build run. diff --git a/modules/ob-configure-build-inputs-and-outputs.adoc b/modules/ob-configure-build-inputs-and-outputs.adoc new file mode 100644 index 000000000000..f2076190a328 --- /dev/null +++ b/modules/ob-configure-build-inputs-and-outputs.adoc @@ -0,0 +1,10 @@ +// This module is included in the following assembly: +// +// * configuring/configuring-openshift-builds.adoc + +:_mod-docs-content-type: CONCEPT +[id="ob-configure-build-inputs-and-outputs_{context}"] += Configure build inputs and outputs + +[role="_abstract"] +Define parameters, outputs, and references for your builds. The `Build` custom resource (CR) enables you to specify where the built container image should be pushed, define parameter values that customize build behavior, and reference existing builds for reuse. diff --git a/modules/ob-define-build-inputs-and-source-code.adoc b/modules/ob-define-build-inputs-and-source-code.adoc new file mode 100644 index 000000000000..f0108da162df --- /dev/null +++ b/modules/ob-define-build-inputs-and-source-code.adoc @@ -0,0 +1,10 @@ +// This module is included in the following assembly: +// +// * configuring/configuring-openshift-builds.adoc + +:_mod-docs-content-type: CONCEPT +[id="ob-define-build-inputs-and-source-code_{context}"] += Define build inputs and source code + +[role="_abstract"] +Configure the source code location, build strategy, and runtime settings for your builds. The `Build` custom resource (CR) provides fields to specify where your source code resides, which build strategy to use, and how to configure the build environment including container files, service accounts, environment variables, and volumes. diff --git a/modules/ob-run-and-customize-build-execution.adoc b/modules/ob-run-and-customize-build-execution.adoc new file mode 100644 index 000000000000..57a730bac335 --- /dev/null +++ b/modules/ob-run-and-customize-build-execution.adoc @@ -0,0 +1,10 @@ +// This module is included in the following assembly: +// +// * configuring/configuring-openshift-builds.adoc + +:_mod-docs-content-type: CONCEPT +[id="ob-run-and-customize-build-execution_{context}"] += Run and customize a build execution + +[role="_abstract"] +Configure runtime settings and parameters for individual build runs. The `BuildRun` custom resource (CR) allows you to override build-level settings for specific executions, including pod configuration, volumes, parameter values, and retention policies. diff --git a/modules/ob-track-build-progress-and-manage-running-builds.adoc b/modules/ob-track-build-progress-and-manage-running-builds.adoc new file mode 100644 index 000000000000..622bac37db08 --- /dev/null +++ b/modules/ob-track-build-progress-and-manage-running-builds.adoc @@ -0,0 +1,10 @@ +// This module is included in the following assembly: +// +// * configuring/configuring-openshift-builds.adoc + +:_mod-docs-content-type: CONCEPT +[id="ob-track-build-progress-and-manage-running-builds_{context}"] += Track build progress and manage running builds + +[role="_abstract"] +Monitor build status and control running builds. The `BuildRun` custom resource (CR) provides status information to track build execution progress, allows you to cancel running builds, and stores system-generated results from the build process. diff --git a/troubleshooting/troubleshooting-runtime-class.adoc b/troubleshooting/troubleshooting-runtime-class.adoc index 1e36283878ae..16e2dd93bfef 100644 --- a/troubleshooting/troubleshooting-runtime-class.adoc +++ b/troubleshooting/troubleshooting-runtime-class.adoc @@ -23,5 +23,4 @@ include::modules/ob-troubleshoot-runtimeclass-not-found.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* xref:../configuring/isolate-build-workloads-for-security-and-compliance.adoc#isolate-build-workloads-for-security-and-compliance[Isolate build workloads for security and compliance] * link:https://docs.redhat.com/en/documentation/openshift_sandboxed_containers/[OpenShift Sandboxed Containers documentation]