Chapter 3. Installing Red Hat Developer Hub on OpenShift Container Platform in an air-gapped environment with the Helm chart

Procedure

1. Create an ImageSetConfiguration file to specify the resources that you want to mirror. For example:

   apiVersion: mirror.openshift.io/v1alpha2
   kind: ImageSetConfiguration
   mirror:
     helm:
       repositories:
              - name: <repository_name> (1)
           url: <repository_url> (2)
           charts:
             - name: <chart_name> (3)
               version: "<rhdh_version>" (4)

   Copy to Clipboard Toggle word wrap

   The name of the repository that you want to mirror, for example, openshift-charts.

   The URL for the repository that you want to mirror, for example, https://charts.openshift.io.

   The name of the Helm chart that you want to mirror, for example, redhat-developer-hub.

   The version of Red Hat Developer Hub that you want to use, for example, 1.6

2. Mirror the resources specified in the ImageSetConfiguration.yaml file by running the oc-mirror command. For example:

   oc-mirror --config=<mirror_config_directory>/ImageSetConfiguration.yaml <mirror_archive_directory>/

   Copy to Clipboard Toggle word wrap

   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 mirror configuration yaml file, for example, mirror-config.yaml

   <mirror_archive_directory>

   Specifies the location of your directory where the mirror archive will be created, for example,file://.user.

   Note

   Running the oc-mirror command generates a local workspace containing the mirror archive file, the Helm chart, and a ImageContentSourcePolicy (ICSP) manifest. The ICSP manifest contains an imageContentSourcePolicy.yaml file that you must apply against the cluster in a later step.

   Example output

   Creating archive /path/to/mirror-archive/mirror_seq1_000000.tar

   Copy to Clipboard Toggle word wrap

3. Transfer the generated archive file (for example, mirror_seq1_000000.tar) to the air-gapped environment.

4. Connect to your air-gapped environment and make sure that you are also connected to the following objects:

   • The local target registry
   • The target OpenShift Container Platform cluster

5. From your air-gapped environment, mirror the resources from the archive to the target registry by running the oc-mirror command. For example:

   oc-mirror --from <mirror-archive-file> <target-registry>

   Copy to Clipboard Toggle word wrap

   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

   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

   Copy to Clipboard Toggle word wrap

6. In your workspace, locate the imageContentSourcePolicy.yaml file by running the ls command. For example:

   ls <workspace_directory>/<results_directory>

   Copy to Clipboard Toggle word wrap

   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.

7. To mirror the Helm chart, deploy the imageContentSourcePolicy.yaml file in the disconnected cluster by running the oc apply command. For example:

   oc apply -f <workspace_directory>/<results_directory>/ImageContentSourcePolicy.yaml

   Copy to Clipboard Toggle word wrap

   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.

8. In your air-gapped environment, deploy the Helm chart to the namespace that you want to use by running the helm install command with namespace and set options. For example:

   CLUSTER_ROUTER_BASE=$(oc get route console -n openshift-console -o=jsonpath='{.spec.host}' | sed 's/[.]*\.//')
   
   helm install <rhdh_instance> <workspace_directory>/<results_directory>/charts/<archive_file> --namespace <your_namespace> --create-namespace \
     --set global.clusterRouterBase="$CLUSTER_ROUTER_BASE"

   Copy to Clipboard Toggle word wrap

   where:

   <rhdh_instance>

   Specifies the name of your Red Hat Developer Hub instance, for example, my-rhdh.

   <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.

   <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-rhdh-project.

Procedure

1. Log in to your OpenShift Container Platform account using the OpenShift CLI (oc) by running the following command:

   oc login -u <user> -p <password> https://api.<hostname>:6443

   Copy to Clipboard Toggle word wrap
2. From your disconnected cluster, log in to the image registry that you want to mirror, for example, the OpenShift Container Platform image registry.
3. Create an ImageSetConfiguration.yaml file.

4. In your ImageSetConfiguration.yaml file, specify the resources that you want to mirror. For example:

   apiVersion: mirror.openshift.io/v1alpha2
   kind: ImageSetConfiguration
   mirror:
     helm:
       repositories:
         - name: <repository_name> (1)
           url: <repository_url> (2)
           charts:
             - name: <chart_name> (3)
               version: "<rhdh_version>" (4)

   Copy to Clipboard Toggle word wrap

   The name of the repository containing the Helm chart that you want to mirror, for example, openshift-charts.

   The URL for the repository containing the Helm chart that you want to mirror, for example, https://charts.openshift.io.

   The name of the Helm chart containing the images that you want to mirror, for example, redhat-developer-hub.

   The Red Hat Developer Hub version that you want to use, for example, 1.6

5. Mirror the resources specified in the image set configuration file directly to the target registry by running the oc-mirror command. For example:

   oc-mirror --config=<mirror_config_directory>/ImageSetConfiguration.yaml <target-mirror-registry>

   Copy to Clipboard Toggle word wrap

   where:

   <mirror_config_directory>

   Specifies the location of your image set configuration file on your system, for example, .user.

   <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 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

   Writing image mapping to oc-mirror-workspace/results-1738070846/mapping.txt
   Writing ICSP manifests to oc-mirror-workspace/results-1738070846

   Copy to Clipboard Toggle word wrap

6. In your workspace, locate the imageContentSourcePolicy.yaml file by running the ls command. For example:

   ls <workspace_directory>/<results_directory>

   Copy to Clipboard Toggle word wrap

   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.

7. To mirror the Helm chart, deploy the imageContentSourcePolicy.yaml file in the disconnected cluster by running the oc apply command. For example:

   oc apply -f <workspace_directory>/<results_directory>/ImageContentSourcePolicy.yaml

   Copy to Clipboard Toggle word wrap

   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.

8. In your air-gapped environment, deploy the Helm chart to the namespace that you want to use by running the helm install command with namespace and set options. For example:

   CLUSTER_ROUTER_BASE=$(oc get route console -n openshift-console -o=jsonpath='{.spec.host}' | sed 's/[.]*\.//')
   
   helm install <rhdh_instance> <workspace_directory>/<results_directory>/charts/<archive_file> --namespace <your_namespace> --create-namespace \
     --set global.clusterRouterBase="$CLUSTER_ROUTER_BASE"

   Copy to Clipboard Toggle word wrap

   where:

   <rhdh_instance>

   Specifies the name of your Red Hat Developer Hub instance, for example, my-rhdh.

   <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.

   <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-rhdh-project.