Skip to main content
Version: 3.1

Install Portworx Backup on an On-premise or Cloud Cluster

Applicable to Classic mode only

You can install Portworx Backup on any Kubernetes cluster (on-premise or on cloud) using Helm charts. The Kubernetes cluster can be either one of your application clusters or a dedicated cluster. You do not need to install Portworx Backup on every application cluster that you back up. After installing Portworx Backup on one cluster, you can add other application clusters that you want to back up using the Portworx Backup web console.

Supported environments​

You can install Portworx Backup in both non-air-gapped and air-gapped environments.

Air-gapped environment​

Air-gapped environments are isolated networks that are completely disconnected from the internet. Portworx Backup installation in an air-gapped environment requires careful planning and preparation to ensure successful deployment.

The air-gapped installation follows a structured approach that begins with comprehensive preparation outside the isolated environment. Start by identifying and downloading all required container images, then transfer them into your air-gapped network and load them into your private registry.

Key considerations for air-gapped installations​

The fundamental difference between air-gapped and internet-connected installations lies in image sourcing and dependency management. Instead of pulling images from public registries, your deployment will reference your private registry for all container images. This requires careful attention to image tagging and registry configuration.

Image preparation must be completed outside the air-gapped environment. Pull all required images, save them to portable media, and then load them into your private registry. This process includes the main Portworx Backup images as well as any dependencies and supporting components.

Network isolation, while providing security benefits, means that any troubleshooting or updates must be planned and executed without external connectivity. This makes thorough testing and validation even more important than in connected environments.

Security and compliance benefits​

Air-gapped deployments provide additional security because they eliminate external network dependencies. The isolation reduces the attack surface and ensures that your backup infrastructure operates within your organization's security boundaries. However, this security comes with the responsibility of maintaining image integrity and managing updates manually.

Non-air-gapped environment​

To install Portworx Backup on on-premises or cloud clusters in a non-air-gapped environment, first Generate Portworx Backup Spec. Then install using one of the following methods:

Installation workflow​

The following installation workflow applies for a fresh installation of Portworx Backup.

  1. Check the following information:

    • Support matrices - Provides compatibility and interoperability information for Portworx Backup, Portworx Enterprise, Stork, Kubernetes versions, and Argo CD. It also includes interoperability details for supported Linux versions and storage types.
    • Portworx Backup Image Repositories - Provides a list of image repositories that you must pull to your Docker registry or server when installing Portworx Backup in an air-gapped environment.

  2. Check the Requirements for Portworx Backup Installation.
    The backup cluster must meet all hardware, software, database, networking, and observability requirements listed in this section.

  3. Prepare the environment for Portworx Backup installation by setting up the backup cluster, observability components, certificates, proxy support, and a private container registry for air-gapped environments to host the required images.
    For more information, see Set up the installation environment.

  4. Generate the Portworx Backup spec. For more information, see Generate Portworx Backup Spec.

  5. Install Portworx Backup using any of the following methods:

  6. Get Portworx Backup ready for operations. For more information, see Configure Portworx Backup for Operations.

After you complete the installation and configuration tasks, access the Portworx Backup web console and see the Operate module to begin operational tasks.

The following topics provide detailed information on the Portworx Backup installation process, in the order you perform them:

  • Requirements — This topic outlines the necessary hardware and software prerequisites for installing Portworx Backup, ensuring optimal performance and support for various backup workloads. It covers requirements for different backup scales.
  • Set up the installation environment — Learn how to prepare your clusters, whether they are internet-connected or in an air-gapped environment, before installing Portworx Backup.
  • Generate Portworx Backup Spec — Learn how to use the Portworx Central portal to generate the Portworx Backup spec (the values-px-central.yaml file and pxc-credentials secret) used by both the Helm and Argo CD methods.
  • Install using Helm — Learn how to install Portworx Backup using Helm, in both internet-connected and air-gapped environments, and how to verify that the installation completed successfully.
  • Install using Argo CD — Learn how to install Portworx Backup in both internet-connected and air-gapped environments using Argo CD, a GitOps continuous delivery tool for Kubernetes. This guide walks you through setting up Argo CD with Helm and configuring applications for Portworx Backup deployment.
Last updated on
In this topic: