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
6 changes: 3 additions & 3 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ Topics:
File: configuring-build-strategies
- Name: Configuring build runs
File: configuring-build-runs
- Name: Using Builds in a network-restricted environment
File: using-builds-in-a-network-restricted-environment
---
Name: Work with Builds
Dir: work_with_builds
Distros: openshift-builds
Topics:
- Name: Managing Builds
File: using-builds
File: managing-builds
- Name: Managing Builds in a network restricted environment
File: managing-builds-in-a-network-restricted-environment
---
Name: Work with Shared Resources
Dir: work_with_shared_resources
Expand Down
21 changes: 0 additions & 21 deletions configuring/using-builds-in-a-network-restricted-environment.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion installing/installing-openshift-builds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ include::modules/ob-disabling-shipwrightBuilds-components.adoc[leveloffset=+1]
== Additional resources

* link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
* xref:../work_with_builds/using-builds.adoc[Managing Builds]
* xref:../work_with_builds/managing-builds.adoc[Managing Builds]
1 change: 1 addition & 0 deletions modules/ob-creating-a-buildah-build.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ EOF
----
<1> The `spec.build.name` field denotes the respective build to run, which is expected to be available in the same namespace.
+

.Example: Using `shp` CLI
[source,terminal]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
= Creating buildah build in a network-restricted environment

[role="_abstract"]
You can create a `buildah` build in a network-restricted environment by mirroring the images required by the `buildah` build strategy.
You can create a `buildah` build in a network-restricted environment by mirroring the images required by the `buildah` build strategy. Mirroring the images eliminates the need to access public registries and ensures that your clusters only use container images that comply with your organization's controls on external content.

.Prerequisites

* Your cluster can connect and interact with the git source that you can use to create the buildah build.
* Your cluster can connect and interact with the Git source that you can use to create the buildah build.

.Procedure

Expand All @@ -25,3 +25,7 @@ $ oc image mirror --insecure -a <registry_authentication> registry.redhat.io/ubi

. Perform the steps mentioned in the "Creating a buildah build" section.

[role="_additional-resources"]
.Additional resources

* xref:../work_with_builds/managing-builds.adoc#ob-creating-buildah-build-in-a-network-restricted-environment_using-builds[Creating a buildah build]
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
= Creating source-to-image build in a network-restricted environment

[role="_abstract"]
You can create a `source-to-image` build in a network-restricted environment by mirroring the images required by the `source-to-image` build strategy.
You can create a `source-to-image` build in a network-restricted environment by mirroring the images required by the `source-to-image` build strategy. By mirroring the images required by the `source-to-image` build strategy, you eliminate dependency on public registries and ensure your clusters utilize container images that strictly comply with your organization's external content policies.

.Prerequisites

* Your cluster can connect and interact with the git source that you can use to create the source-to-image build.
* You have the builder-image required to create the `source-to-image` build in your local registry. If you do not have the builder-image in the local registry, mirror the source image.
* Your cluster can connect and interact with the Git source used to create the `source-to-image` build.
* You have the builder-image required to create the `source-to-image` build in your local registry. If the builder-image is not present in the local registry, mirror the source image.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/ob-deleting-a-buildrun-resource.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can delete a `buildrun` resource if it is not required in your project.

.Procedure

* Delete a `build` resource by using one of the following CLIs:
* Delete the `buildrun` resource by using one of the following CLIs:

** Using `oc` CLI
+
Expand Down
2 changes: 1 addition & 1 deletion modules/ob-verifying-cluster-wide-proxy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Verifying cluster-wide proxy

[role="_abstract"]
As a cluster administrator, you can verify the cluster-wide proxy settings.
If you operate your cluster behind a proxy, you must verify that the {builds-title} use the {ocp-product-title}'s cluster-wide proxy settings. This ensures that all the {builds-shortname} traffic, including cloning Git repositories for application source code and pulling container base images, is correctly routed through your existing, monitored corporate egress gateway. As a cluster administrator, you can verify the cluster-wide proxy settings.

.Procedure

Expand Down
10 changes: 10 additions & 0 deletions modules/ob-verifying-proxy-details.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// This module is included in the following assembly:
//
// * configuring/using-builds-in-a-restricted-environment.adoc

:_mod-docs-content-type: CONCEPT
[id="ob-verifying-proxy-details_{context}"]
= Verifying proxy-details

[role="_abstract"]
If you operate your cluster behind a proxy, you must verify that the {builds-title} use the {ocp-product-title}'s cluster-wide proxy settings. This ensures that all the {builds-shortname} traffic, including cloning Git repositories for application source code and pulling container base images, is correctly routed through your existing, monitored corporate egress gateway.
2 changes: 1 addition & 1 deletion modules/ob-verifying-proxy-environment-variables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As a cluster administrator, you can verify the environment variables to ensure t
$ oc set env deployment/openshift-builds-operator --list -n openshift-builds | grep PROXY
----
+
The following example output lists the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables:
_Example output_
+
[source,terminal]
----
Expand Down
4 changes: 2 additions & 2 deletions work_with_builds/docinfo.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<title>Work with Builds</title>
<productname>{product-title}</productname>
<productnumber>{product-version}</productnumber>
<subtitle>Using Builds</subtitle>
<subtitle>Managing Builds</subtitle>
<abstract>
<para>This document provides procedural examples for using Builds.</para>
<para>This document provides procedural examples for managing Builds.</para>
</abstract>
<authorgroup>
<orgname>Red Hat OpenShift Documentation Team</orgname>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:_mod-docs-content-type: ASSEMBLY
[id="managing-builds-in-a-network-restricted-environment"]
include::_attributes/common-attributes.adoc[]
= Managing {builds-shortname} in a network-restricted environment
:context: using-builds

toc::[]

[role="_abstract"]
Configure {ocp-product-title} with an HTTP or HTTPS proxy to prevent direct internet access. This setup enforces organizational security policies by ensuring that the build processes securely pull external dependencies, base images, and source code from repositories through a monitored and controlled egress gateway.

include::modules/ob-creating-buildah-build-in-a-network-restricted-environment.adoc[leveloffset=+1]

include::modules/ob-creating-s2i-build-in-a-network-restricted-environment.adoc[leveloffset=+1]

include::modules/ob-verifying-cluster-wide-proxy.adoc[leveloffset=+1]

include::modules/ob-verifying-proxy-environment-variables.adoc[leveloffset=+2]

[role="_additional-resources"]
[id="additional-resources_using-builds-in-a-network-restricted-environment"]
== Additional resources

* link:https://docs.openshift.com/pipelines/1.16/install_config/installing-pipelines.html#op-pipelines-operator-in-restricted-environment_installing-pipelines[Red Hat OpenShift Pipelines Operator in a restricted environment]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/configuring_network_settings/enable-cluster-wide-proxy[Configuring cluster-wide proxy]
* link:https://docs.openshift.com/container-platform/latest/disconnected/mirroring/installing-mirroring-installation-images.html[Mirroring images for a disconnected installation by using the oc adm command]
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,8 @@ After installing {builds-shortname}, you can create builds using `buildah`, `sou

include::modules/ob-creating-a-buildah-build.adoc[leveloffset=+1]

include::modules/ob-creating-buildah-build-in-a-network-restricted-environment.adoc[leveloffset=+2]

include::modules/ob-creating-a-s2i-build.adoc[leveloffset=+1]

include::modules/ob-creating-s2i-build-in-a-network-restricted-environment.adoc[leveloffset=+2]

include::modules/ob-creating-a-buildpacks-build.adoc[leveloffset=+1]

include::modules/ob-creating-a-build-with-oci-artifacts.adoc[leveloffset=+1]
Expand All @@ -39,4 +35,3 @@ include::modules/ob-deleting-a-buildstrategy-resource.adoc[leveloffset=+2]

* xref:../authenticating/understanding-authentication-at-runtime.adoc#ob-authentication-to-container-registries_understanding-authentication-at-runtime[Authentication to container registries]
* xref:../installing/installing-openshift-builds.adoc#creating-a-shipwright-build-resource-console_installing-openshift-builds[Creating a ShipwrightBuild resource by using the web console]
* link:https://docs.openshift.com/container-platform/latest/disconnected/mirroring/installing-mirroring-installation-images.html[Mirroring images for a disconnected installation by using the oc adm command]