Skip to content

Commit 5586fa2

Browse files
committed
RHIDP-5494: Apply SME comments
1 parent b8a4a26 commit 5586fa2

File tree

1 file changed

+39
-57
lines changed

1 file changed

+39
-57
lines changed

modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc

Lines changed: 39 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
You can install {product} in a fully disconnected or partially disconnected environment using the {product} Operator. For a list of supported platforms, see the link:https://access.redhat.com/support/policy/updates/developerhub[{product} Life Cycle page].
99

10-
== Installing {product} on {ocp-short} in a partially disconnected environment with the Operator
10+
== Installing {product} in a partially disconnected environment with the Operator
1111

1212
On an {ocp-short} cluster operating on a restricted network, public resources are not available. However, deploying the {product} Operator and running {product-short} requires the following public resources:
1313

@@ -21,10 +21,19 @@ You can use a helper script that mirrors the necessary images and provides the n
2121
If you are connected to a {ocp-short} cluster, the helper script will detect it and will automatically expose the cluster registry. However, if you are connected to a Kubernetes cluster, you can manually specify the target registry that you want to mirror the images to.
2222

2323
.Prerequisites
24-
* You have an active `oc registry` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
24+
* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
25+
* You have installed Skopeo 1.17 or later.
26+
* You have installed yq 4.44 or later.
27+
* You have installed the GNU sed command line text editor.
28+
* You have installed umoci CLI tool.
29+
* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
2530
* You have an active `skopeo` session with administrative access to the target mirror registry. For more information, see link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry].
2631
* You have installed the `opm` CLI tool. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI].
27-
* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
32+
* If you are using an {ocp-short} cluster, you have the following prerequisites:
33+
** (Optional) You have installed the `oc-mirror` {ocp-short} CLI plugin if you want to use it to mirror images.
34+
* If you are using a supported Kubernetes cluster, you have the following prerequisites:
35+
** You have installed the Operator Lifecycle Manager (OLM) on the disconnected cluster.
36+
** You have a mirror registry that is reachable from the disconnected cluster.
2837

2938
.Procedure
3039
. In your terminal, navigate to the directory where you want to save the mirroring script.
@@ -36,27 +45,15 @@ curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs
3645
----
3746
+
3847
. Run the mirroring script by running the `bash` command with the appropriate set of options:
39-
* If you do not already have a target mirror registry and want the script to create one for you, use the following example:
4048
+
4149
[source,terminal,subs="+quotes,+attributes"]
4250
----
43-
bash prepare-restricted-environment.sh \
44-
--prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v{ocp-version}" \
45-
--prod_operator_package_name "rhdh" \
46-
--prod_operator_bundle_name "rhdh-operator" \
47-
--prod_operator_version "v{product-bundle-version}" \
48-
----
49-
* If you want to use an existing target mirror registry, specify it with the `--use_existing_mirror_registry` option. For example:
50-
+
51-
[source,terminal,subs="+quotes,+attributes"]
52-
----
53-
bash prepare-restricted-environment.sh \
54-
--prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v{ocp-version}" \
55-
--prod_operator_package_name "rhdh" \
56-
--prod_operator_bundle_name "rhdh-operator" \
57-
--prod_operator_version "v{product-bundle-version}" \
58-
--use_existing_mirror_registry "_<my_registry>_"
51+
bash prepare-restricted-environment.sh \ (1)
52+
[--to-registry _<my.registry.example.com>_]] \ (2)
53+
[--use-oc-mirror true]
5954
----
55+
<1> Specifies the URL for the target mirror registry where you want to mirror the images.
56+
<2> (Optional) Uses the `oc-mirror` {ocp-short} CLI plugin to mirror images.
6057
+
6158
[NOTE]
6259
====
@@ -72,21 +69,21 @@ The script can take several minutes to complete as it copies multiple images to
7269
kubectl -n rhdh-operator get pods
7370
----
7471

75-
== Installing {product} on {ocp-short} in a fully disconnected environment with the Operator
72+
== Installing {product} in a fully disconnected environment with the Operator
7673

77-
If your network has access to the registry through a bastion host or physical disk, you can use the Operator to install {product} by mirroring specified resources and transferring them to your air-gapped environment without any connection to the internet.
74+
If your network has access to the registry through a bastion host, you can use the helper script to install {product} by mirroring the Operator-related images to disk and transferring them to your air-gapped environment without any connection to the internet.
7875

7976
.Prerequisites
8077

81-
* You have set up your disconnected environment.
82-
** You have mirrored all of the required images to disk.
83-
** You have manually transferred the mirror folder to the network of the disconnected mirror registry.
84-
** You have mirrored the images from disk to the target mirror registry in your disconnected environment.
85-
** You have installed the Operator in your disconnected environment.
86-
* You have set up your workstation.
87-
** You have an active `oc registry` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
88-
** You have installed the `opm` CLI tool. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI].
89-
** You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
78+
* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
79+
* You have installed Skopeo 1.17 or later.
80+
* You have installed yq 4.44 or later.
81+
* You have installed the GNU sed command line text editor.
82+
* You have installed umoci CLI tool.
83+
* You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
84+
* You have an active `oc registry` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
85+
* You have installed the `opm` CLI tool. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI].
86+
* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions].
9087

9188
.Procedure
9289
. Download the mirroring script to disk by running the following command:
@@ -101,47 +98,32 @@ curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs
10198
[source,terminal,subs="+quotes,+attributes"]
10299
----
103100
bash prepare-restricted-environment.sh \
104-
--index-image "quay.io/rhdh/iib:next-v4.18-x86_64" \
105-
--ci-index true \
106-
--to-dir _<my_pulled_image_location>_ \
107-
[--filter-versions '*'] \
108-
[--use-oc-mirror true]
101+
--to-dir _<my_pulled_image_location>_
109102
----
110103
+
111104
where
112105

113-
_<my_pulled_image_location>_ :: Specifies the directory where you want to pull all of the necessary images with the `--to-dir` option, for example, my.registry.example.com/namespace
106+
_<my_pulled_image_location>_ :: Specifies the absolute path to a directory where you want to pull all of the necessary images with the `--to-dir` option, for example, `/home/user/rhdh-operator-mirror-dir`.
114107
+
115108
[NOTE]
116109
====
117110
The script can take several minutes to complete as it copies multiple images to the mirror registry.
118111
====
119112
+
120113
. Transfer the directory specified by the `--to-dir` option to your disconnected environment.
121-
. From a machine in your disconnected environment that has access to both the cluster and the target mirror registry, download the mirroring script from disk by running the following command:
122-
+
123-
[source,terminal,subs="attributes+"]
124-
----
125-
curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs/heads/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh
126-
----
127-
+
128-
. Run the mirroring script by running the `bash` command with the appropriate set of options:
114+
. From a machine in your disconnected environment that has access to both the cluster and the target mirror registry, run the mirroring script by running the `bash` command with the appropriate set of options:
129115
+
130116
[source,terminal,subs="+quotes,+attributes"]
131117
----
132-
bash prepare-restricted-environment.sh \
133-
--from-dir _<my_pulled_image_location>_ \
134-
[--to-registry _<my.registry.example.com>_/_<namespace>_] \
135-
[--use-oc-mirror true]
118+
bash _<my_pulled_image_location>_/install.sh \ (1)
119+
--from-dir _<my_pulled_image_location>_ \ (2)
120+
[--to-registry _<my.registry.example.com>_] \ (3)
121+
[--use-oc-mirror true] (4)
136122
----
137-
+
138-
where
139-
140-
_<my_pulled_image_location>_ :: Specifies the directory where you want to pull all of the necessary images with the `--to-dir` option.
141-
142-
_<my.registry.example.com>_ :: Specifies the URL for the target mirror registry where you want to mirror the images.
143-
144-
_<namespace>_ :: Specifies the target namespace where you want to mirror the images.
123+
<1> The downloaded image and the absolute path to the directory where it is stored on your system.
124+
<2> Specifies the directory where you want to pull all of the necessary images with the `--to-dir` option.
125+
<3> Specifies the URL for the target mirror registry where you want to mirror the images.
126+
<4> (Optional) Uses the `oc-mirror` {ocp-short} CLI plugin to mirror images.
145127
+
146128
[NOTE]
147129
====

0 commit comments

Comments
 (0)