Skip to main content
Version: 2.7

Install on air-gapped environments

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 below Docker images to either your docker registry or your server. If you are using your own Prometheus and Alertmanager with Portworx Backup, you do not have to pull the last four images from the following list:

ImageVersion
docker.io/portworx/pxcentral-onprem-api2.7.3
docker.io/portworx/pxcentral-onprem-ui-frontend2.7.3
docker.io/portworx/pxcentral-onprem-ui-backend2.7.3
docker.io/portworx/pxcentral-onprem-ui-lhbackend2.7.3
docker.io/portworx/pxcentral-onprem-post-setup2.7.3
docker.io/portworx/pxcentral-onprem-pre-upgrade-base2.7.3
docker.io/portworx/px-backup2.7.3
docker.io/portworx/postgresql11.19.0-debian-11-r1
docker.io/portworx/keycloak21.1.2
docker.io/portworx/keycloak-login-theme2.7.0
docker.io/portworx/busybox1.35.0
docker.io/portworx/mysql8.0.37
docker.io/portworx/mongodb5.0.24-debian-11-r20
docker.io/portworx/mongodb6.0.13-debian-11-r21
docker.io/portworx/mongodb7.0.14-debian-12-r0
docker.io/portworx/kopiaexecutor1.2.14
docker.io/portworx/nfsexecutor1.2.14
docker.io/portworx/filesystemctl1.2.14
docker.io/portworx/prometheusv2.53.0
docker.io/portworx/alertmanagerv0.26.0
docker.io/portworx/prometheus-operatorv0.75.0
docker.io/portworx/prometheus-config-reloaderv0.75.0
note

Refer to the Install Stork in air-gapped environments 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.7.x&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. Access Portworx Central specgen.

  6. From the home page, navigate to Backup Services under Explore our Products.

  7. Click on I agree to EULA and go through the Portworx Products Terms of Use carefully.

  8. Navigate back to the Portworx Central portal and click Start Free Trial.

  9. In the Spec Details provide the following values:

    • Backup Version: select the required version of Portworx Backup from the drop-down
    • Namespace: provide the name of the namespace where you want an instance of Portworx Backup to be installed
    • Install using: choose Helm 3
    • Select your environment: choose On-Premises or Cloud based on your storage environment
    • StorageClass Name: name of the StorageClass, refer tooltip for more details
    • Use your OIDC: select this option only if your external authorization provider is Auth0 and key in the following fields
      • Endpoint
      • Client ID
      • Client Secret

  • Use existing Prometheus: select this checkbox if you have to use your existing Prometheus stack to monitor Portworx Backup and enter the values for the following fields:

    • Prometheus Endpoint: enter details of the endpoint where your Prometheus is installed
    • Alertmanager Endpoint: enter details of the endpoint where your Alertmanager is installed
    • Prometheus secret name: enter secret name of your Prometheus stack
    • Alertmanager secret name: enter secret name of your Alertmanager
    • Custom email template from PX-Backup: select to upload Portworx Backup's custom email template to your pre-configured Alertmanager for email notifications

    These values can be fetched from the Auth0 web console.

    • Use custom registry: for air-gapped environments
      • Custom Image Repository Location: path of custom image repository
      • Image Pull Secret(s): create a secret only if image pulling from an internal repository requires credentials

  1. Click Next to navigate to Finish tab.

  2. Under Step 2 of the web console, click values-px-central.yaml file to download the default options.

  3. 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.7.x.tgz
    • Modify the Helm command generated from second option of Step 2 (of Portworx Backup web console) 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.7.x -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.7.x.tgz --namespace central --create-namespace --version 2.7.x -f values-px-central.yaml
Last updated on
Was this page helpful?