Skip to main content
Version: 2.11

Set up the installation environment

You must set up the environment before you install Portworx Backup on an on-premise Kubernetes cluster or cloud cluster.

To set up the environment for Portworx Backup installation, follow these steps:

  1. Setup Helm on the backup cluster.
    Install Helm 3.x or later package manager on your local machine or bastion host with access to the cluster for managing deployments. For more information, see Helm Setup.

  2. To use your own Prometheus operator with Portworx Backup, ensure that you add the following argument to Prometheus operator spec (spec.template.spec.containers[0].args):

    --deny-namespaces=<name-of-px-backup-installed-namespace> 
  3. Perform the following observability configurations based on your cluster-type:

  4. Configure certificates to securely integrate Portworx Backup with TLS-enabled services. For more information, see Configure Certificates.

  5. Configure proxy support for external communication to pass through a proxy server. For more information, see Enable Proxy Support.

  6. (Optional) To install Portworx Backup with Portworx Enterprise, you must first Install Portworx Enterprise, then create the following storage class on your Kubernetes cluster:

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
    name: portworx-sc
    provisioner: pxd.portworx.com
    parameters:
    repl: "3"
    note

    You can skip this step for a standalone installation of Portworx Backup.

  7. (Optional) Enable mutual TLS (mTLS) for Portworx Backup to ensure secure and trusted communication between services within the cluster. For more information, see Enable Mutual TLS.

  8. Configure external OIDC endpoints.
    If you enable an external OIDC during the Portworx Backup installation, you must manually configure the redirect URI in your OIDC provider. Refer to the Setup login redirects section of the Portworx Enterprise documentation for instructions.

  9. (For air-gapped environment only) Pull the required Docker images to your private registry or server. For the complete list of images, including notes on which images to skip if you use your own Prometheus and Alertmanager, see Portworx Backup Image Repositories.

  10. (For air-gapped environment only) Set up a private container registry (an internal container registry) such as Harbor, Nexus, or Docker registry, that cluster nodes can reach to pull container images.
    To pull the 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=<Variable name="pxbVer_2.11.0"/>&px-backup=true"
    2. Provide execute permission for the install script:

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

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

      ./pxcentral-ag-install-backup.sh push <repo>
  11. Configure the Kubernetes command-line tool (kubectl) with cluster credentials to run commands for the backup cluster.

  12. Set up the backup cluster administrator privileges or sufficient RBAC permissions to create namespaces, deploy applications, and manage cluster-wide resources.

What to do next

Install Portworx Backup Using Portworx Central or Install Portworx Backup Using Argo CD.