Skip to content

Commit 2a349f3

Browse files
committed
RHIDP-5494: Doc air-gapped installation using Operator
1 parent 1d090f5 commit 2a349f3

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
lines changed

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

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,33 @@
33

44
:_mod-docs-content-type: PROCEDURE
55
[id="proc-install-rhdh-airgapped-environment-ocp-operator_{context}"]
6-
= Installing {product} in an air-gapped environment with the Operator
6+
= Installing {product} on {ocp-short} in an air-gapped environment with the Operator
7+
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+
10+
== Installing {product} on {ocp-short} in a partially disconnected environment with the Operator
711

812
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:
913

1014
* Operator images (bundle, operator, catalog)
1115
* Operands images ({product-very-short}, PostgreSQL)
1216

13-
To make these resources available, replace them with their equivalent resources in a mirror registry accessible to the {ocp-short} cluster.
17+
To make these resources available, replace them with their equivalent resources in a mirror registry accessible to your cluster.
1418

15-
You can use a helper script that mirrors the necessary images and provides the necessary configuration to ensure those images will be used when installing the {product} Operator and creating {product-short} instances.
19+
You can use a helper script that mirrors the necessary images and provides the necessary configuration to ensure those images will be used when installing the {product} Operator and creating {product-short} instances. This script requires a target mirror registry. You likely have a target mirror registry ready to use if your cluster is already operating on a disconnected network. If you do not already have a target registry, and if you have an {ocp-short} cluster, you might want to expose and leverage the internal cluster registry.
1620

17-
[NOTE]
18-
====
19-
This script requires a target mirror registry which you should already have installed if your {ocp-short} cluster is ready to operate on a restricted network. However, if you are preparing your cluster for disconnected usage, you can use the script to deploy a mirror registry in the cluster and use it for the mirroring process.
20-
====
21+
If you are connected to a {ocp-short} cluster, the helper script will detect it and will automatically expose the cluster registry. However, you can manually specify any target registry that you want to mirror the images to.
2122

2223
.Prerequisites
23-
* You have an active {openshift-cli} session with administrative permissions to the {ocp-short} cluster. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-getting-started[Getting started with the OpenShift CLI].
24-
* You have an active `oc registry` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. See link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
25-
* The `opm` CLI tool is installed. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#olm-about-opm_cli-opm-install[Installing the opm CLI].
26-
* The jq package is installed. See link:https://jqlang.github.io/jq/download/[Download jq].
27-
* Podman is installed. See link:https://podman.io/docs/installation[Podman Installation Instructions].
28-
* Skopeo version 1.14 or higher is installed. link:https://github.com/containers/skopeo/blob/main/install.md[See Installing Skopeo].
29-
* If you already have a mirror registry for your cluster, an active Skopeo session with administrative access to this registry is required. See link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_installation_mirroring/index#prerequisites_installing-mirroring-installation-images[Mirroring images for a disconnected installation].
30-
31-
[NOTE]
32-
====
33-
The internal {ocp-short} cluster image registry cannot be used as a target mirror registry. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_installation_mirroring/index#installation-about-mirror-registry_installing-mirroring-installation-images[About the mirror registry].
34-
====
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].
25+
* 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+
* 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].
3528

36-
* If you prefer to create your own mirror registry, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_installation_mirroring/index#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red Hat OpenShift].
37-
38-
* If you do not already have a mirror registry, you can use the helper script to create one for you and you need the following additional prerequisites:
39-
+
40-
** The cURL package is installed. For {rhel}, the curl command is available by installing the curl package. To use curl for other platforms, see the link:https://curl.se/[cURL website].
41-
** The `htpasswd` command is available. For {rhel}, the `htpasswd` command is available by installing the `httpd-tools` package.
4229

30+
//stop here
4331
.Procedure
44-
. Download and run the mirroring script to install a custom Operator catalog and mirror the related images: `prepare-restricted-environment.sh` (link:https://github.com/redhat-developer/rhdh-operator/blob/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh[source]).
32+
. Download and run the mirroring script to install the Operator catalog and mirror the related images: `prepare-restricted-environment.sh` link:../scripts/prepare-restricted-environment.sh[(source)].
4533
+
4634
[source,yaml,subs="attributes+"]
4735
----
@@ -70,3 +58,22 @@ bash prepare-restricted-environment.sh \
7058
====
7159
The script can take several minutes to complete as it copies multiple images to the mirror registry.
7260
====
61+
62+
== Installing {product} on {ocp-short} in a fully disconnected environment with the Operator
63+
64+
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.
65+
66+
.Prerequisites
67+
68+
* You have set up your workstation.
69+
** You have access to the registry.redhat.io.
70+
** You have access to the charts.openshift.io Helm chart repository.
71+
** You have installed the {openshift-cli} on your workstation.
72+
** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
73+
** You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
74+
* You have set up your intermediary host.
75+
** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry].
76+
** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
77+
** You have installed {ocp-brand-name} {ocp-version-min} or later.
78+
** You have installed the {openshift-cli} on your workstation.
79+

0 commit comments

Comments
 (0)