You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc
+39-57Lines changed: 39 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
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].
9
9
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
11
11
12
12
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:
13
13
@@ -21,10 +21,19 @@ You can use a helper script that mirrors the necessary images and provides the n
21
21
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.
22
22
23
23
.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].
25
30
* 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].
26
31
* 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.
28
37
29
38
.Procedure
30
39
. In your terminal, navigate to the directory where you want to save the mirroring script.
<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.
60
57
+
61
58
[NOTE]
62
59
====
@@ -72,21 +69,21 @@ The script can take several minutes to complete as it copies multiple images to
72
69
kubectl -n rhdh-operator get pods
73
70
----
74
71
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
76
73
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.
78
75
79
76
.Prerequisites
80
77
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].
90
87
91
88
.Procedure
92
89
. Download the mirroring script to disk by running the following command:
_<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`.
114
107
+
115
108
[NOTE]
116
109
====
117
110
The script can take several minutes to complete as it copies multiple images to the mirror registry.
118
111
====
119
112
+
120
113
. 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:
. 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:
0 commit comments