Install Portworx Backup on air-gapped environment


This topic explains how you can prepare your clusters in an air-gapped environment and install Portworx Backup on-premises.

Prepare air-gapped environments

If your cluster is internet-connected, skip this section. If your cluster is air-gapped, you must pull the following Docker images to either your docker registry, or your server:

  • docker.io/portworx/pxcentral-onprem-api:2.3.2
  • docker.io/portworx/pxcentral-onprem-ui-frontend:2.3.2
  • docker.io/portworx/pxcentral-onprem-ui-backend:2.3.2
  • docker.io/portworx/pxcentral-onprem-ui-lhbackend:2.3.2
  • docker.io/portworx/pxcentral-onprem-post-setup:2.3.2
  • docker.io/portworx/postgresql:11.18.0-debian-11-r0
  • docker.io/portworx/keycloak:16.1.1
  • docker.io/portworx/keycloak-login-theme:2.2.0
  • docker.io/portworx/busybox:1.31
  • docker.io/portworx/mysql:5.7.40
  • docker.io/portworx/px-backup:2.3.2
  • docker.io/portworx/mongodb:5.0.14-debian-11-r1
  • docker.io/portworx/kopiaexecutor:1.2.2
Note: Refer to the Prepare air-gapped environment section to know more about the Stork and other openstorage images in your air-gapped environment, before installing Portworx Backup.

To pull the above Docker images and push them to an internal registry:

  1. Download the pxcentral-ag-install-backup.sh air-gapped bootstrap Portworx Backup install script.

    curl -o pxcentral-ag-install-backup.sh -L "https://install.portworx.com/pxcentral-air-gapped?px-backup=true"

    You can also download the install script for a specific release by specifying a version query. For example:

    curl -o pxcentral-ag-install-backup.sh -L "https://install.portworx.com/pxcentral-air-gapped?version=2.3.2&px-backup=true"
  2. Provide execute permission for the install script:

    chmod +x pxcentral-ag-install-backup.sh
  3. Pull the container images using the pxcentral-ag-install-backup.sh script:

    ./pxcentral-ag-install-backup.sh pull
  4. Push the images to a local registry server, accessible by the air-gapped nodes. Replace <repo> with your registry location.

    ./pxcentral-ag-install-backup.sh push <repo>
  5. Generate the Portworx Backup installation spec (Helm command) from https://central.portworx.com/specGen/wizard. Select the Use custom registry button and provide the values for registry, repository, and image pull secret (create a secret only if image pulling from an internal repository requires credentials).

  6. From the machine where you run the helm3 command:

    • Download the latest px-central package with the following command.

      curl -O https://raw.githubusercontent.com/portworx/helm/master/stable/px-central-2.3.2.tgz
    • Modify the Helm command generated from Step 2 to provide the helm package, instead of providing the repository. For example:

      helm install px-central portworx/px-central --namespace central --create-namespace --version 2.3.2 -f values-px-central.yaml

      Following is the modified command for air gapped environment using the downloaded helm package:

      helm install px-central px-central-2.3.2.tgz --namespace central --create-namespace --version 2.3.2 -f values-px-central.yaml

After performing the above steps, refer to Install Portworx Backup section to install Portworx Backup on-premises.


Last edited: Tuesday, Dec 20, 2022