chore: Improve the airgap env preparation script [RHIDP-1442][RHIDP-4415]

[rm3l]

Description

This improves the airgap env preparation script so that:

1. it can work on both OCP (regular, ROSA or with hosted control planes) and vanilla K8s clusters.
2. it can work with partially or fully disconnected environments. For example, to support the fully disconnected environment case, it can mirror everything to disk and start from an existing input folder. This makes it work with bastion hosts.
   It also has the option to leverage the oc-mirror tool since this is the recommended way to mirror on OCP.

Which issue(s) does this PR fix or relate to

• Fixes https://issues.redhat.com/browse/RHIDP-1442
• Fixes https://issues.redhat.com/browse/RHIDP-4415

PR acceptance criteria

• Tests
• Documentation

How to test changes / Special notes to the reviewer

Follow the procedure in https://github.com/rm3l/redhat-developer-hub-operator/blob/RHIDP-4415--airgap-install-script-improvements/.rhdh/docs/airgap.adoc

Note that this introduces new options to the script, but for backward compatibility, the previous ones are preserved (but deprecated) as much as possible (except --helper_mirror_registry_storage, --use_existing_mirror_registry, --prod_operator_package_name, and prod_operator_bundle_name, which no longer make sense here).

Usage

$ .rhdh/scripts/prepare-restricted-environment.sh --help

This script streamlines the installation of the Red Hat Developer Hub Operator in a disconnected OpenShift or Kubernetes cluster.
It supports partially disconnected as well as fully disconnected environments.
In a partially disconnected environment, the host from which this script is executed has access to the Internet and the Red Hat ecosystem catalog,
and can push the images directly to the mirror registry and the cluster.
In a fully disconnected environment however, everything needs to be mirrored to disk first, then transferred to the
disconnected environment (usually via a bastion host), from where we can connect to the mirror registry and the cluster.

Usage:
  .rhdh/scripts/prepare-restricted-environment.sh [OPTIONS]

Options:
  --index-image <operator-index-image>   : Operator index image (default: registry.redhat.io/redhat/redhat-operator-index:v4.17)
  --filter-versions <list>               : Comma-separated list of operator minor versions to keep in the catalog (default: 1.3,1.4)
  --to-registry <registry_url>           : Mirror the images into the specified registry, assuming you are already logged into it.
                                            If this is not set and --to-dir is not set, it will attempt to use the builtin OCP registry
                                            if the target cluster is OCP. Otherwise, it will error out.
                                            It also assumes you are logged into the target cluster as well.
  --to-dir </absolute/path/to/dir>       : Mirror images into the specified directory. Needs to be an absolute path.
                                            This is useful if you are working in a fully disconnected environment and
                                            you must manually transfer the images to your network.
                                            From there, you will be able to re-run this script with '--from-dir' to push
                                            the images to your private registry.
  --from-dir </absolute/path/to/dir>     : Load images from the specified directory. Needs to be an absolute path.
                                            This is useful if you are working in a fully disconnected environment.
                                            In this case, you would use '--to-dir' first to mirror images to a specified directory,
                                            then transfer this dir over to your disconnected network.
                                            From there, you will be able to re-run this script with '--from-dir' to push
                                            the images to your private registry.
  --install-operator <true|false>        : Install the RHDH operator right after creating the CatalogSource (default: true)
  --extra-images <list>                  : Comma-separated list of extra images to mirror
  --use-oc-mirror <true|false>           : Whether to use the 'oc-mirror' tool (default: false).
                                            This is the recommended way for mirroring on regular OpenShift clusters.
                                            Bear in mind however that this relies on resources like ImageContentSourcePolicy,
                                            which don't seem to work well on ROSA clusters or clusters with hosted control
                                            planes (like HyperShift or Red Hat OpenShift on IBM Cloud).

Examples:

  # Install the Catalog Source by pushing the images to the internal OCP mirror registry,
  #   because it detected that it is connected to an OCP cluster.
  .rhdh/scripts/prepare-restricted-environment.sh

  # Install the Catalog Source by pushing the images to the specified mirror registry, assuming the user is already logged into it.
  .rhdh/scripts/prepare-restricted-environment.sh \
    --to-registry registry.example.com

  # Extract all the images needed into the specified directory.
  .rhdh/scripts/prepare-restricted-environment.sh \
    --to-dir  /path/to/my/dir

  # From a bastion host connected to the disconnected network,
  # install the operator by using the images from the specified directory.
  .rhdh/scripts/prepare-restricted-environment.sh \
    --from-dir  /path/to/my/dir \
    --to-registry registry.example.com

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from rm3l. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[rm3l]

/cc @zdrapela

[rm3l]

The script has been tested successfully on our airgapped OCP environment (via a bastion host):

Creating a CR also works by pulling the images from the internal OCP registry:

[azureuser@bastion4 zdrapela]$ oc get po -o wide
NAME                                       READY   STATUS    RESTARTS   AGE     IP             NODE                                            NOMINATED NODE   READINESS GATES
backstage-developer-hub-7f7c58cdc5-h8d2b   0/1     Running   0          3m17s   10.131.1.78    aro-disconnected-4-j8mbr-worker-eastus1-lbj56   <none>           <none>
backstage-psql-developer-hub-0             1/1     Running   0          3m16s   10.130.2.111   aro-disconnected-4-j8mbr-worker-eastus3-2btbl   <none>           <none>
rhdh-operator-5f997f959-wzw6g              1/1     Running   0          8m21s   10.130.2.110   aro-disconnected-4-j8mbr-worker-eastus3-2btbl   <none>           <none>

[azureuser@bastion4 zdrapela]$ oc get pod backstage-psql-developer-hub-0 -o=jsonpath='{.spec.containers[*].name}{" => "}{.spec.containers[*].image}{"\n"}{.spec.initContainers[*].name}{" => "}{.spec.initContainers[*].image}{"\n"}'
postgresql => image-registry.openshift-image-registry.svc:5000/rhel9/postgresql-15:44a08b83a6c50714b52f4cf1c3476bc16b66faec21dd9a9bc07d1be5f97b8150

[azureuser@bastion4 zdrapela]$ oc get pod backstage-developer-hub-7f7c58cdc5-h8d2b -o=jsonpath='{.spec.containers[*].name}{" => "}{.spec.containers[*].image}{"\n"}{.spec.initContainers[*].name}{" => "}{.spec.initContainers[*].image}{"\n"}'
backstage-backend => image-registry.openshift-image-registry.svc:5000/rhdh/rhdh-hub-rhel9:d8268197ba0466643efb818fcad8f0fc29e32463f75b0f7f51d9ce75ec717572
install-dynamic-plugins => image-registry.openshift-image-registry.svc:5000/rhdh/rhdh-hub-rhel9:d8268197ba0466643efb818fcad8f0fc29e32463f75b0f7f51d9ce75ec717572

And I also tested it successfully on both vanilla K8s and ROSA clusters.

Merging it, to unblock #751