Skip to content
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include::snip-installing-the-orchestrator-common-prerequisites.adoc[]

.Procedure

. Create an `ImageSetConfiguration.yaml` file for `oc-mirror`. You must use an `ImageSetConfiguration` file to include all mirrored images required, as shown in the following example:
. Create an `ImageSetConfiguration.yaml` file for `oc mirror`. You must use an `ImageSetConfiguration` file to include all mirrored images required, as shown in the following example:
+
[source,yaml,subs="+attributes,+quotes"]
----
Expand Down Expand Up @@ -76,16 +76,17 @@ unpack "registry.access.redhat.com/rhdh/plugin-catalog-index:{product-version}"
# you can then find the `dynamic-plugins.default.yaml` under /tmp/registry.access.redhat.com/rhdh/plugin-catalog-index_{product-version}/dynamic-plugins.default.yaml
----

. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example:
. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc mirror` command. For example:
+
[source,terminal,subs="+attributes,+quotes"]
----
$ oc-mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile --v2
$ oc mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile --v2
----
+
[NOTE]
====
The `oc-mirror` command pulls the charts listed in the `ImageSetConfiguration` file and makes them available as `tgz` archives under the `/path/to/mirror-archive` directory.
. The `--v2` flag is required for {ocp-short} 4.21 and later.
. The `oc mirror` command pulls the charts listed in the `ImageSetConfiguration` file and makes them available as `tgz` archives under the `/path/to/mirror-archive` directory.
====
+
. Apply the cluster-wide resources generated during the push step to redirect all image pulls to your local registry, as shown in the following example:
Expand All @@ -102,7 +103,7 @@ $ oc apply -f .
+
[source,terminal,subs="+attributes,+quotes"]
----
$ oc-mirror --v2 --from <mirror-archive-file> docker://<target-registry-url:port> --workspace file://<workspace folder> --authfile /path/to/authfile
$ oc mirror --v2 --from <mirror-archive-file> docker://<target-registry-url:port> --workspace file://<workspace folder> --authfile /path/to/authfile
----
+
where:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ include::snip-installing-the-orchestrator-common-prerequisites.adoc[]

.Procedure

. Create an `ImageSetConfiguration` file for `oc-mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as shown in the following example:
. Create an `ImageSetConfiguration` file for `oc mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as shown in the following example:
+
[source,yaml,subs="+attributes,+quotes"]
----
Expand Down Expand Up @@ -71,16 +71,17 @@ unpack "registry.access.redhat.com/rhdh/plugin-catalog-index:{product-version)"
# you can then find the `dynamic-plugins.default.yaml` under /tmp/registry.access.redhat.com/rhdh/plugin-catalog-index_{product-version)/dynamic-plugins.default.yaml
----

. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example:
. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc mirror` command. For example:
+
[source,terminal,subs="+attributes,+quotes"]
----
$ oc-mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile --v2
$ oc mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile --v2
----
+
[NOTE]
====
The `oc-mirror` command generates a local workspace containing the mirror archive files and the required cluster manifests.
. The `--v2` flag is required for {ocp-short} 4.21 and later.
. The `oc mirror` command generates a local workspace containing the mirror archive files and the required cluster manifests.
====
+
. Transfer the directory specified by `/path/to/mirror-archive` to a bastion host within your disconnected environment.
Expand All @@ -89,7 +90,7 @@ The `oc-mirror` command generates a local workspace containing the mirror archiv
+
[source,yaml,subs="+attributes,+quotes"]
----
$ oc-mirror --v2 --from <mirror-archive-file> docker://<target-registry-url:port> --workspace file://<workspace folder> --authfile /path/to/authfile
$ oc mirror --v2 --from <mirror-archive-file> docker://<target-registry-url:port> --workspace file://<workspace folder> --authfile /path/to/authfile
----
+
where:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ You can install {product} ({product-very-short}) with the Orchestrator plugin in

A disconnected installation prevents unauthorized access, data transfer, or communication with external sources.

You can use the `oc-mirror` command to mirror resources directly to your accessible local registry and apply the generated cluster resources.
You can use the `oc mirror` command to mirror resources directly to your accessible local registry and apply the generated cluster resources.

.Prerequisites

include::snip-installing-the-orchestrator-common-prerequisites.adoc[]

.Procedure

. Create an `ImageSetConfiguration.yaml` file for `oc-mirror`. You must use an `ImageSetConfiguration` file to include all mirrored images required, as shown in the following example:
. Create an `ImageSetConfiguration.yaml` file for `oc mirror`. You must use an `ImageSetConfiguration` file to include all mirrored images required, as shown in the following example:
+
[source,yaml,subs="+attributes,+quotes"]
----
Expand Down Expand Up @@ -54,16 +54,17 @@ mirror:
maxVersion: {rhoserverless-version}
----

. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command to pull images and charts, and push the images directly to the target registry. For example:
. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc mirror` command to pull images and charts, and push the images directly to the target registry. For example:
+
[source,terminal,subs="+attributes,+quotes"]
----
$ oc-mirror --config=imagesetconfiguration.yaml docker://<registry URL:port> --workspace file://<workspace folder> --authfile /path/to/authfile --v2
$ oc mirror --config=imagesetconfiguration.yaml docker://<registry URL:port> --workspace file://<workspace folder> --authfile /path/to/authfile --v2
----
+
[NOTE]
====
The `oc-mirror` command pulls the charts listed in the `ImageSetConfiguration` file and makes them available as `tgz` archives under the `<workspace folder>` directory.
. The `--v2` flag is required for {ocp-short} 4.21 and later.
. The `oc mirror` command pulls the charts listed in the `ImageSetConfiguration` file and makes them available as `tgz` archives under the `<workspace folder>` directory.
====

. Apply the generated cluster resources to the disconnected cluster. For example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can install {product} with Orchestrator plugin in a partial air-gapped envir

A disconnected installation prevents unauthorized access, data transfer, or communication with external sources.

You can use the `oc-mirror` command to mirror resources directly to your accessible local mirror registry and apply the generated cluster resources.
You can use the `oc mirror` command to mirror resources directly to your accessible local mirror registry and apply the generated cluster resources.

.Prerequisites

Expand All @@ -18,7 +18,7 @@ include::snip-installing-the-orchestrator-common-prerequisites.adoc[]

.Procedure

. Create an `ImageSetConfiguration` file for `oc-mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as shown in the following example:
. Create an `ImageSetConfiguration` file for `oc mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as shown in the following example:
+
[source,yaml,subs="+attributes,+quotes"]
----
Expand Down Expand Up @@ -71,15 +71,20 @@ unpack "registry.access.redhat.com/rhdh/plugin-catalog-index:{product-version)"
# you can then find the `dynamic-plugins.default.yaml` under /tmp/registry.access.redhat.com/rhdh/plugin-catalog-index_{product-version)/dynamic-plugins.default.yaml
----

. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example:
. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc mirror` command. For example:
+
[source,terminal,subs="+attributes,+quotes"]
----
$ oc-mirror --config=imagesetconfiguration.yaml docker://<registry URL:port> --workspace file://<workspace folder> --authfile /path/to/authfile --v2
$ oc mirror --config=imagesetconfiguration.yaml docker://<registry URL:port> --workspace file://<workspace folder> --authfile /path/to/authfile --v2
$ cd <workspace folder>/working-dir/cluster-resources/
$ oc apply -f .
----
+
[NOTE]
====
The `--v2` flag is required for {ocp-short} 4.21 and later.
====
+
. Install the OpenShift Serverless Operator and OpenShift Serverless Logic Operators using `OperatorHub`.

. Create a {product-custom-resource-type} custom resource (CR).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

* You have permissions to push OCI images to your internal container registry.

* You have installed the {ocp-docs-link}/html-single/disconnected_environments/index#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[`oc-mirror`] tool, with a version corresponding to the version of your {ocp-short} cluster.
* You have installed the {ocp-docs-link}/html-single/disconnected_environments/index#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[`oc mirror`] tool, with a version corresponding to the version of your {ocp-short} cluster.
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ where:
`_<my_pulled_image_location>_/install.sh`:: Enter the downloaded installation script and the absolute path to the directory where you stored it on your system.
`--from-dir _<my_pulled_image_location>_`:: Enter the directory where you want to pull all of the necessary images.
`--to-registry`:: (Optional) Enter the URL for the target mirror registry where you want to mirror the images.
`--use-oc-mirror true`:: Recommended on {ocp-short}: Use the `oc-mirror` {ocp-short} CLI plugin to mirror images.
`--use-oc-mirror true`:: Recommended on {ocp-short}: Use the `oc mirror` {ocp-short} CLI plugin to mirror images.
+
[IMPORTANT]
====
If you used `oc-mirror` to mirror the images to disk, you must also use `oc-mirror` to mirror the images from disk due to the folder layout that `oc-mirror` uses.
If you used `oc mirror` to mirror the images to disk, you must also use `oc mirror` to mirror the images from disk due to the folder layout that `oc mirror` uses.
====
+
[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For more information, see link:https://access.redhat.com/articles/RegistryAuthen
* You have installed the `opm` CLI tool.
For more information, see {ocp-docs-link}/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI].
* If you are using an {ocp-short} cluster, you have the following prerequisites:
** Recommended: You have installed the `oc-mirror` tool, with a version corresponding to the version of your {ocp-short} cluster.
** Recommended: You have installed the `oc mirror` tool, with a version corresponding to the version of your {ocp-short} cluster.
* If you are using a supported Kubernetes cluster, you have the following prerequisites:
** You have installed the Operator Lifecycle Manager (OLM) on the disconnected cluster.
** You have a mirror registry that is reachable from the disconnected cluster.
Expand All @@ -61,7 +61,7 @@ $ bash prepare-restricted-environment.sh \
----
where:
`--to-registry _<my.registry.example.com>`:: Enter the URL for the target mirror registry where you want to mirror the images.
`--use-oc-mirror true`:: Optional: Use the `oc-mirror` {ocp-short} CLI plugin to mirror images.
`--use-oc-mirror true`:: Optional: Use the `oc mirror` {ocp-short} CLI plugin to mirror images.
+
[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ mirror:
where:
`version: "{product-version}"`:: Enter the {product} version to mirror.

. Mirror the resources specified in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example:
. Mirror the resources specified in the `ImageSetConfiguration.yaml` file by running the `oc mirror` command. For example:
+
[source,terminal,subs="+quotes"]
----
Expand All @@ -59,7 +59,8 @@ where:
+
[NOTE]
====
Running the `oc-mirror` command generates a local workspace containing the mirror archive file, the Helm chart, `ImageDigestMirrorSet` (IDMS) and `ImageTagMirrorSet` (ITMS) manifests. The IDMS and ITMS manifests contain files that you must apply against the cluster in a later step.
. The `--v2` flag is required for {ocp-short} 4.21 and later.
. Running the `oc mirror` command generates a local workspace containing the mirror archive file, the Helm chart, `ImageDigestMirrorSet` (IDMS) and `ImageTagMirrorSet` (ITMS) manifests. The IDMS and ITMS manifests contain files that you must apply against the cluster in a later step.
====
+
Example output:
Expand All @@ -75,7 +76,7 @@ Creating archive /path/to/mirror-archive/mirror_seq1_000000.tar
. The local target registry
. The target {ocp-short} cluster
+
. From your air-gapped environment, mirror the resources from the archive to the target registry by running the `oc-mirror` command. For example:
. From your air-gapped environment, mirror the resources from the archive to the target registry by running the `oc mirror` command. For example:
+
[source,terminal,subs="+quotes"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ where:
+
[NOTE]
====
Running the `oc mirror` command generates a local workspace containing the Helm chart, `ImageDigestMirrorSet` (IDMS) and `ImageTagMirrorSet` (ITMS) manifests. The IDMS and ITMS manifests contain files that you must apply against the cluster in a later step.
. The `--v2` flag is required for {ocp-short} 4.21 and later.
. Running the `oc mirror` command generates a local workspace containing the Helm chart, `ImageDigestMirrorSet` (IDMS) and `ImageTagMirrorSet` (ITMS) manifests. The IDMS and ITMS manifests contain files that you must apply against the cluster in a later step.
====
+
. In your workspace, locate the `ImageDigestMirrorSet` (IDMS) and `ImageTagMirrorSet` (ITMS) files by running the `ls` command. For example:
Expand Down
Loading