RHIDP-5351: Apply changes based on feature demos

linfraze · linfraze · commit 8180a905b5f9 · 2025-02-04T16:02:07.000-05:00
diff --git a/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc b/modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc
@@ -6,15 +6,19 @@
 
 You can install {product} in a fully disconnected or partially disconnected environment using the {product} Helm chart.
 
+[role="_additional-resources"]
+.Additional resources
+* For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
+
 == Installing {product} on {ocp-short} in a partially disconnected environment with the Helm chart
 
-If your network has access to the `registry.redhat.io` registry and the `charts.openshift.io` Helm Chart repository, you can deploy your {product} instance in your partially disconnected environment by mirroring the specified resources directly to the target registry.
+If your network has access to the `registry.redhat.io` registry and the `charts.openshift.io` Helm chart repository, you can deploy your {product} instance in your partially disconnected environment by mirroring the specified resources directly to the target registry.
 
 .Prerequisites
 
 * You have installed {ocp-brand-name} {ocp-version-min} or later.
-* You have access to the `registry.redhat.io`.
 * You have access to the `charts.openshift.io` Helm chart repository.
+* You have access to the `registry.redhat.io`.
 * You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} 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].
 * You are logged in to your target mirror registry and have permissions to push images to it. For more information, see link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored].
 * You have installed the {openshift-cli} on your workstation.
@@ -30,7 +34,7 @@ oc login -u <user> -p <password> https://api.<hostname>:6443
 ----
 
 . From your disconnected cluster, log in to the image registry that you want to mirror, for example, the {ocp-short} image registry.
-. Create an `ImageSetConfiguration` file, for example, `ImageSetConfiguration.yaml`.
+. Create an image set configuration file, for example, `ImageSetConfiguration.yaml`.
 . In your `ImageSetConfiguration.yaml` file, specify the resources that you want to mirror. For example:
 +
 [source,terminal,subs="attributes+"]
@@ -46,29 +50,31 @@ mirror:
           - name: <chart-name> (3)
             version: "<{product-very-short}-version>" (4)
 ----
-<1> The name of the repository that you want to mirror, for example, `openshift-charts`.
-<2> The URL for the repository that you want to mirror, for example, `https://charts.openshift.io`.
-<3> The name of the chart that you want to mirror, for example, `redhat-developer-hub`.
-<4> The version of {product} that you want to use, for example, `{product-version}`
+<1> The name of the repository containing the Helm chart that you want to mirror, for example, `openshift-charts`.
+<2> The URL for the repository containing the Helm chart that you want to mirror, for example, `https://charts.openshift.io`.
+<3> The name of the Helm chart containing the images that you want to mirror, for example, `redhat-developer-hub`.
+<4> The {product} version that you want to use, for example, `{product-version}`
 
-. Mirror the resources specified in the`ImageSetConfiguration` file directly to the target registry using the `oc-mirror` command. For example:
+. Mirror the resources specified in the image set configuration file directly to the target registry by running the `oc-mirror` command. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
-oc-mirror --config=<mirror-configuration-file> <target-mirror-registry>
+oc-mirror --config=<mirror-config-directory>/<mirror-configuration-file> <target-mirror-registry>
 ----
 +
 --
 where:
 
-`<mirror-configuration-file>` :: Specifies the name of your mirror configuration yaml file, for example, `mirror-config.yaml`
+`<mirror-config-directory>` :: Specifies the location of your image set configuration file on your system, for example, `.user`.
+
+`<mirror-configuration-file>` :: Specifies the name of your image set configuration file, for example, `ImageSetConfiguration.yaml`.
 
 `<target-mirror-registry>` :: Specifies the location and name of your target mirror registry, for example,`docker://registry.example:5000`.
 --
 +
 [NOTE]
 ====
-Running the `oc-mirror` command creates a `ImageContentSourcePolicy` (ICSP) manifest that you can apply against the cluster in a later step.
+Running the `oc-mirror` command creates a local workspace containing the Helm chart and a `ImageContentSourcePolicy` (ICSP) manifest. The ICSP manifest contains an automatically-generated `imageContentSourcePolicy.yaml` file that you must apply against the cluster in a later step.
 ====
 +
 .Example output
@@ -78,24 +84,57 @@ Writing image mapping to oc-mirror-workspace/results-1738070846/mapping.txt
 Writing ICSP manifests to oc-mirror-workspace/results-1738070846
 ----
 +
-. In the `oc-mirror` command output, find the directory containing the Helm chart that you want to use, for example, `mapping.txt`.
-. Locate the `ImageContentSourcePolicy` (ICSP) manifest that was automatically generated by running the `oc-mirror` command and apply it against the cluster by running the `oc create` command. For example:
+. In your workspace, locate the `imageContentSourcePolicy.yaml` file by running the `ls` command. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
-oc create -f oc-mirror-workspace/results-1738070846/ImageContentSourcePolicy.yaml
+ls <workspace-directory>/<results-directory>
 ----
++
+--
+where:
 
-. In your air-gapped environment, deploy the Helm chart to the namespace that you want to use by running the `helm install` command. For example:
+`<workspace-directory>` :: Specifies the name of your workspace directory, for example, `oc-mirror-workspace`.
+
+`<results-directory>` :: Specifies the name of your results directory, for example, `results-1738070846`.
+--
++
+. To mirror the Helm chart, deploy the `imageContentSourcePolicy.yaml` file in the disconnected cluster by running the `oc apply` command. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
-helm install rhdh ./mirror-archive/oc-mirror-workspace/src/charts/redhat-developer-hub-{product-version}.tgz --namespace <your-namespace> --create-namespace
+oc apply -f <workspace-directory>/<results-directory>/<image-content-policy-file>
 ----
 +
 --
 where:
 
+`<workspace-directory>` :: Specifies the name of your workspace directory, for example, `oc-mirror-workspace`.
+
+`<results-directory>` :: Specifies the name of your results directory, for example, `results-1738070846`.
+
+`<results-directory>` :: Specifies the name of the image content source policy file, for example, `ImageContentSourcePolicy.yaml `.
+--
+. In your air-gapped environment, deploy the Helm chart to the namespace that you want to use by running the `helm install` command and `namespace` options. For example:
++
+[source,terminal,subs="attributes+"]
+----
+helm install <rhdh-instance> <workspace-directory>/<results-directory>/<charts-directory>/<archive-file> --namespace <your-namespace> --create-namespace
+----
++
+--
+where:
+
+`<rhdh-instance>` :: Specifies the name of your {product} instance, for example, `my-rhdh`
+
+`<workspace-directory>` :: Specifies the name of your workspace directory, for example, `oc-mirror-workspace`.
+
+`<charts-directory>` :: Specifies the name of the charts directory, for example, `charts`.
+
+`<results-directory>` :: Specifies the name of your results directory, for example, `results-1738070846`.
+
+`<archive-file>` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`.
+
 `<your-namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
 --
 
@@ -113,7 +152,7 @@ helm install redhat-developer-hub./mirror-archive/oc-mirror-workspace/src/charts
 
 == Installing {product} on {ocp-short} in a fully disconnected environment with the Helm chart
 
-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.
+If your network has access to the registry through a bastion host or physical disk, 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.
 
 .Prerequisites
 
@@ -143,27 +182,33 @@ mirror:
 ----
 <1> The name of the repository that you want to mirror, for example, `openshift-charts`.
 <2> The URL for the repository that you want to mirror, for example, `https://charts.openshift.io`.
-<3> The name of the chart that you want to mirror, for example, `redhat-developer-hub`.
+<3> The name of the Helm chart that you want to mirror, for example, `redhat-developer-hub`.
 <4> The version of {product} that you want to use, for example, `{product-version}`
 
-. Mirror the resources specified in the `ImageSetConfiguration` file by running the following command:
+. Mirror the resources specified in the `ImageSetConfiguration` file by running the `oc-mirror` command. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
-oc-mirror --config=mirror-config.yaml <mirror-archive-file>
+oc-mirror --config=<mirror-config-directory>/<mirror-configuration-file> <mirror-archive-directory>/<mirror-archive-file>
 ----
 +
 --
 where:
 
+`<mirror-config-directory>` :: Specifies the location of your image set configuration file on your system, for example, `.user`.
+
+`<mirror-configuration-file>` :: Specifies the name of your image set configuration file, for example, `ImageSetConfiguration.yaml`.
+
 `<mirror-configuration-file>` :: Specifies the name of your mirror configuration yaml file, for example, `mirror-config.yaml`
 
-`<mirror-archive-file>` :: Specifies the location and name of `.tar` file containing the mirror archive, for example,`file://mirror-archive`.
+`<mirror-archive-directory>` :: Specifies the location of your `.tar` file containing the mirror archive, for example,`.user`.
+
+`<mirror-archive-file>` :: Specifies the location and name of your `.tar` file containing the mirror archive, for example,`file://mirror-archive`.
 --
 +
 [NOTE]
 ====
-Running the `oc-mirror` command creates a `ImageContentSourcePolicy` (ICSP) manifest that you can apply against the cluster in a later step.
+Running the `oc-mirror` command creates a local workspace containing the Helm chart and a `ImageContentSourcePolicy` (ICSP) manifest. The ICSP manifest contains an automatically-generated `imageContentSourcePolicy.yaml` file that you must apply against the cluster in a later step.
 ====
 +
 .Example output
@@ -173,41 +218,96 @@ Creating archive /path/to/mirror-archive/mirror_seq1_000000.tar
 ----
 +
 . Transfer the generated `.tar` archive file (for example, `mirror_seq1_000000.tar`) to the air-gapped environment.
-. Connect to following your air-gapped environment and make sure that you are also connected to the following objects:
+. Connect to your air-gapped environment and make sure that you are also connected to the following objects:
 +
-* The target registry
+* The local target registry
 * The target {ocp-short} cluster
 +
-. From the air-gapped environment, mirror the resources from the archive to the target registry by running the `oc-mirror` command. For example:
+. From your air-gapped environment, mirror the resources from the archive to the target registry by running the `oc-mirror` command. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
-oc-mirror --from /path/to/mirror_seq1_000000.tar docker://registry.example.com:5000
+oc-mirror --from <mirror-archive-file> <target-registry>
 ----
 +
+--
+where:
+
+`<mirror-archive-file>` :: Specifies the name of the file containing the resources that you want to mirror, for example,`mirror_seq1_0000.tar`.
+
+`<target-registry>` :: Specifies the name of the target registry that you want to push the mirrored images to, for example, `docker://registry.localhost:5000`.
+--
++
 .Example output
 [source,terminal,subs="attributes+"]
 ----
 Wrote release signatures to oc-mirror-workspace/results-1738075410
 Writing image mapping to oc-mirror-workspace/results-1738075410/mapping.txt
 Writing ICSP manifests to oc-mirror-workspace/results-1738075410
 ----
-. In the `oc-mirror` command output, find the directory containing the Helm chart that you want to use, for example, `mapping.txt`.
-. Locate the `ImageContentSourcePolicy` (ICSP) manifest that was automatically generated by running the `oc-mirror` command and apply it against the cluster by running the `oc apply` command. For example:
++
+. In your workspace, locate the `imageContentSourcePolicy.yaml` file by running the `ls` command. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
-oc apply -f oc-mirror-workspace/results-1738070846/ImageContentSourcePolicy.yaml
+ls <workspace-directory>/<results-directory>
 ----
-. In your air-gapped environment, deploy the {product} Helm chart. For example:
++
+--
+where:
+
+`<workspace-directory>` :: Specifies the name of your workspace directory, for example, `oc-mirror-workspace`.
+
+`<results-directory>` :: Specifies the name of your results directory, for example, `results-1738070846`.
+--
++
+. To mirror the Helm chart, deploy the `imageContentSourcePolicy.yaml` file in the disconnected cluster by running the `oc apply` command. For example:
++
+[source,terminal,subs="attributes+"]
+----
+oc apply -f <workspace-directory>/<results-directory>/<image-content-policy-file>
+----
++
+--
+where:
+
+`<workspace-directory>` :: Specifies the name of your workspace directory, for example, `oc-mirror-workspace`.
+
+`<results-directory>` :: Specifies the name of your results directory, for example, `results-1738070846`.
+
+`<results-directory>` :: Specifies the name of the image content source policy file, for example, `ImageContentSourcePolicy.yaml `.
+--
+. In your air-gapped environment, deploy the Helm chart to the namespace that you want to use by running the `helm install` command and `namespace` options. For example:
++
+[source,terminal,subs="attributes+"]
+----
+helm install <rhdh-instance> <workspace-directory>/<results-directory>/<charts-directory>/<archive-file> --namespace <your-namespace> --create-namespace
+----
++
+--
+where:
+
+`<rhdh-instance>` :: Specifies the name of your {product} instance, for example, `my-rhdh`
+
+`<workspace-directory>` :: Specifies the name of your workspace directory, for example, `oc-mirror-workspace`.
 
+`<charts-directory>` :: Specifies the name of the charts directory, for example, `charts`.
+
+`<results-directory>` :: Specifies the name of your results directory, for example, `results-1738070846`.
+
+`<archive-file>` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`.
+
+`<your-namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
+--
+
+.Verification
+. To verify that all resources are successfully deployed and running, check the status of your deployments and pods in the cluster.
+. View the router base URL by entering the following command:
++
 [source,terminal,subs="attributes+"]
 ----
 CLUSTER_ROUTER_BASE=$(oc get route console -n openshift-console -o=jsonpath='{.spec.host}' | sed 's/^[^.]*\.//')
 helm install redhat-developer-hub./mirror-archive/oc-mirror-workspace/src/charts/redhat-developer-hub-1.4.1.tgz \
     --set global.clusterRouterBase="$CLUSTER_ROUTER_BASE"
 ----
-
-[role="_additional-resources"]
-.Additional resources
-* For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
+. Ensure that the route matches the expected URL based on the router base of the cluster. If necessary, update the route to align with your expected configuration.
