Skip to content

Commit b83444e

Browse files
committed
RHIDP-5351: Update airgrapped helm install procedure and differentiate between fully and partially disconnected env
1 parent bd78c7d commit b83444e

File tree

1 file changed

+100
-13
lines changed

1 file changed

+100
-13
lines changed

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

Lines changed: 100 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
// no assembly
33

44
[id="proc-install-rhdh-airgapped-environment-ocp-helm_{context}"]
5-
= Installing {product} in an air-gapped environment with the Helm Chart
5+
= Installing {product} in an air-gapped environment with the Helm chart
66

7-
An air-gapped environment, also known as an air-gapped network or isolated network, ensures security by physically segregating the system or network. This isolation is established to prevent unauthorized access, data transfer, or communication between the air-gapped system and external sources.
7+
You can install {product} in a fully disconnected or partially disconnected environment using the {product} Helm chart.
88

9-
You can install {product} in an air-gapped environment to ensure security and meet specific regulatory requirements.
9+
== Installing {product} in a partially disconnected environment with the Helm chart
1010

11-
To install {product-short} in an air-gapped environment, you must have access to the `registry.redhat.io` and the registry for the air-gapped environment.
11+
If your network has access to the internal {company-name} registries, you can deploy your {product} instance in your partially disconnected environment by mirroring the specified resources directly to the target registry.
1212

1313
.Prerequisites
1414

@@ -21,15 +21,14 @@ To install {product-short} in an air-gapped environment, you must have access to
2121
* You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
2222

2323
.Procedure
24-
25-
. Log in to your {ocp-short} account using the {openshift-cli}, by running the following command:
24+
. Log in to your {ocp-short} account using the {openshift-cli} by running the following command:
2625
+
2726
[source,terminal]
2827
----
2928
oc login -u <user> -p <password> https://api.<hostname>:6443
3029
----
3130

32-
. Log in to the {ocp-short} image registry using the `podman` command line tool, by running the following command:
31+
. Log in to the {ocp-short} image registry using the `podman` command line tool by running the following command:
3332
+
3433
[source,terminal]
3534
----
@@ -58,11 +57,95 @@ podman login -u kubeadmin -p $(oc whoami -t) $REGISTRY_HOST
5857
podman login registry.redhat.io
5958
----
6059
+
61-
For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
62-
6360
. Create an `ImageSetConfiguration` file to specify the resources that you want to mirror. For example:
6461
+
62+
[source,terminal]
63+
----
64+
apiVersion: mirror.openshift.io/v1alpha2
65+
kind: ImageSetConfiguration
66+
storageConfig:
67+
local:
68+
path: ./mirror-output
69+
mirror:
70+
helm:
71+
repositories:
72+
- name: openshift-charts
73+
url: https://charts.openshift.io
74+
charts:
75+
- name: redhat-developer-hub
76+
version: "{product-version}"
77+
----
78+
. Mirror the resources specified in the`ImageSetConfiguration` file directly to the target registry by running the following command:
79+
+
80+
[source,terminal]
81+
----
82+
oc-mirror --config=mirror-config.yaml file://mirror-archive
83+
----
84+
. In your air-gapped environment, deploy the Helm chart to the `rhdh` namespace by running the `helm install` command. For example:
85+
+
86+
[source,terminal,subs="attributes+"]
87+
----
88+
helm install rhdh ./mirror-archive/oc-mirror-workspace/src/charts/redhat-developer-hub-{product-version}.tgz --namespace rhdh --create-namespace
89+
----
90+
91+
.Verification
92+
. To verify that all resources are successfully deployed and running, check the status of your deployments and pods in the cluster.
93+
. To validate the route, ensure that the route matches the expected URL based on the router base of the cluster.
94+
.. If necessary, update the route to align with your expected configuration.
95+
96+
== Installing {product} in a fully disconnected environment with the Helm chart
97+
98+
You can use the Helm chart to install {product} by mirroring specified resources and transferring them to your air-gapped environment without any connection to the internet.
99+
100+
.Prerequisites
101+
102+
* You have installed {ocp-brand-name} {ocp-version-min} or later.
103+
* You have access to the `registry.redhat.io`.
104+
* You have access to the {ocp-brand-name} image registry for your cluster. For more information about exposing the image registry, see the {ocp-brand-name} documentation about https://docs.openshift.com/container-platform/{ocp-version}/registry/securing-exposing-registry.html[Exposing the registry].
105+
* You have installed the {openshift-cli} on your workstation.
106+
* You have installed the `podman` command line tools on your workstation.
107+
* 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].
108+
* You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
109+
110+
.Procedure
111+
112+
. Log in to your {ocp-short} account using the {openshift-cli} by running the following command:
113+
+
114+
[source,terminal]
115+
----
116+
oc login -u <user> -p <password> https://api.<hostname>:6443
117+
----
118+
119+
. Log in to the {ocp-short} image registry using the `podman` command line tool by running the following command:
120+
+
121+
[source,terminal]
122+
----
123+
podman login -u kubeadmin -p $(oc whoami -t) default-route-openshift-image-registry.<hostname>
124+
----
125+
+
126+
[NOTE]
127+
====
128+
You can run the following commands to get the full host name of the {ocp-short} image registry, and then use the host name in a command to log in:
129+
130+
[source,terminal]
131+
----
132+
REGISTRY_HOST=$(oc get route default-route -n openshift-image-registry --template='{{ .spec.host }}')
133+
----
134+
135+
[source,terminal]
136+
----
137+
podman login -u kubeadmin -p $(oc whoami -t) $REGISTRY_HOST
138+
----
139+
====
65140

141+
. Log in to the `registry.redhat.io` in `podman` by running the following command:
142+
+
143+
[source,terminal]
144+
----
145+
podman login registry.redhat.io
146+
----
147+
+
148+
. Create an `ImageSetConfiguration` file to specify the resources that you want to mirror. For example:
66149
+
67150
[source,terminal]
68151
----
@@ -92,20 +175,24 @@ oc-mirror --config=mirror-config.yaml file://mirror-archive
92175
----
93176
scp ./mirror-archive/mirror_seq1_000000.tar /tmp
94177
----
95-
. Extract the contents of the archive into a directory by running the following command:
178+
. Extract the contents of the archive into a directory (for example, `/tmp`) by running the `tar` command. For example:
96179
+
97180
[source,terminal]
98181
----
99182
tar -xvf /mirror-archive/mirror_seq1_000000.tar -C /tmp
100183
----
101-
. Deploy the Helm chart in the air-gapped environment by running the following command:
184+
. In your air-gapped environment, deploy the Helm chart to the `rhdh` namespace by running the `helm install` command. For example:
102185
+
103-
[source,terminal]
186+
[source,terminal,subs="attributes+"]
104187
----
105-
helm install rhdh ./mirror-archive/oc-mirror-workspace/src/charts/redhat-developer-hub-1.4.1.tgz --namespace rhdh --create-namespace
188+
helm install rhdh ./mirror-archive/oc-mirror-workspace/src/charts/redhat-developer-hub-{product-version}.tgz --namespace rhdh --create-namespace
106189
----
107190

108191
.Verification
109192
. To verify that all resources are successfully deployed and running, check the status of your deployments and pods in the cluster.
110193
. To validate the route, ensure that the route matches the expected URL based on the router base of the cluster.
111194
.. If necessary, update the route to align with your expected configuration.
195+
196+
[role="_additional-resources"]
197+
.Additional resources
198+
* For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].

0 commit comments

Comments
 (0)