|
| 1 | +:_mod-docs-content-type: PROCEDURE |
| 2 | +[id="proc-install-rhdh-operator-airgapped-full.adoc_{context}"] |
| 3 | += Installing {product} in a fully disconnected environment with the Operator |
| 4 | + |
| 5 | +In environments without internet access — whether for security, compliance, or operational reasons — a fully disconnected installation ensures that {product} can run reliably without external dependencies. |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +.Prerequisites |
| 10 | + |
| 11 | +* You have installed Podman 5.3 or later. For more information, see link:https://podman.io/docs/installation[Podman Installation Instructions]. |
| 12 | +* You have installed Skopeo 1.17 or later. |
| 13 | +* You have installed `yq` 4.44 or later. |
| 14 | +* You have installed the GNU `sed` command line text editor. |
| 15 | +* You have installed `umoci` CLI tool. |
| 16 | +* 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]. |
| 17 | +* 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]. |
| 18 | +
|
| 19 | +.Procedure |
| 20 | +. Download the mirroring script to disk by running the following command: |
| 21 | ++ |
| 22 | +[source,terminal,subs="attributes+"] |
| 23 | +---- |
| 24 | +curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs/heads/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh |
| 25 | +---- |
| 26 | ++ |
| 27 | +. Run the mirroring script by using the `bash` command with the appropriate set of options: |
| 28 | ++ |
| 29 | +[source,terminal,subs="attributes+"] |
| 30 | +---- |
| 31 | +bash prepare-restricted-environment.sh |
| 32 | + --filter-versions "{product-version}" |
| 33 | + --to-dir _<my_pulled_image_location>_ <1> |
| 34 | + [--use-oc-mirror true] <2> |
| 35 | +---- |
| 36 | +<1> 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`. |
| 37 | +<2> (Optional) Uses the `oc-mirror` {ocp-short} CLI plugin to mirror images. |
| 38 | ++ |
| 39 | +[NOTE] |
| 40 | +==== |
| 41 | +The script can take several minutes to complete as it copies multiple images to the mirror registry. |
| 42 | +==== |
| 43 | ++ |
| 44 | +. Transfer the directory specified by the `--to-dir` option to your disconnected environment. |
| 45 | +. From a machine in your disconnected environment that has access to both the cluster and the target mirror registry, run the mirroring script by using the `bash` command with the appropriate set of options: |
| 46 | ++ |
| 47 | +[source,terminal,subs="+quotes,+attributes"] |
| 48 | +---- |
| 49 | +bash _<my_pulled_image_location>_/install.sh <1> |
| 50 | + --from-dir _<my_pulled_image_location>_ <2> |
| 51 | + [--to-registry _<my.registry.example.com>_] <3> |
| 52 | + [--use-oc-mirror true] <4> |
| 53 | +---- |
| 54 | +<1> The downloaded image and the absolute path to the directory where it is stored on your system. |
| 55 | +<2> Specifies the directory where you want to pull all of the necessary images with the `--to-dir` option. |
| 56 | +<3> Specifies the URL for the target mirror registry where you want to mirror the images. |
| 57 | +<4> (Optional) Uses the `oc-mirror` {ocp-short} CLI plugin to mirror images. |
| 58 | ++ |
| 59 | +[IMPORTANT] |
| 60 | +==== |
| 61 | +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. |
| 62 | +==== |
| 63 | ++ |
| 64 | +[NOTE] |
| 65 | +==== |
| 66 | +The script can take several minutes to complete as it automatically installs the {product} Operator. |
| 67 | +==== |
| 68 | + |
| 69 | +.Verification |
| 70 | +* If you are using {ocp-brand-name}, the {product} Operator is in the *Installed Operators* list in the web console. |
| 71 | +* If you are using a supported Kubernetes platform, you can check the list of pods running in the `rhdh-operator` namespace by running the following command in your terminal: |
| 72 | ++ |
| 73 | +[source,terminal,subs="+quotes,+attributes"] |
| 74 | +---- |
| 75 | +kubectl -n rhdh-operator get pods |
| 76 | +---- |
| 77 | +
|
| 78 | +.Next steps |
| 79 | +* Use the Operator to create a {product} instance on a supported platform. For more information, see the following documentation for the platform that you want to use: |
| 80 | +** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_container_platform/assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator] |
| 81 | +** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-operator_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Operator] |
| 82 | +** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator] |
| 83 | +** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator] |
| 84 | +** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-operator.adoc_title-install-rhdh-gke#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator] |
0 commit comments