Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion about/build-strategies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
54 changes: 0 additions & 54 deletions configuring/configuring-build-runs.adoc

This file was deleted.

36 changes: 0 additions & 36 deletions configuring/configuring-build-strategies.adoc

This file was deleted.

54 changes: 43 additions & 11 deletions configuring/configuring-openshift-builds.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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"]
Expand Down

This file was deleted.

10 changes: 10 additions & 0 deletions modules/ob-capture-and-reuse-build-information.adoc
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions modules/ob-configure-build-inputs-and-outputs.adoc
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions modules/ob-define-build-inputs-and-source-code.adoc
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions modules/ob-run-and-customize-build-execution.adoc
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions modules/ob-track-build-progress-and-manage-running-builds.adoc
Original file line number Diff line number Diff line change
@@ -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.
1 change: 0 additions & 1 deletion troubleshooting/troubleshooting-runtime-class.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]