Skip to main content
Version: 3.0

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​

In a non-air-gapped environment, Portworx Backup can be installed using any of the following methods:

  • Portworx Central Spec Generator — A web-based tool that guides you through configuring and generating Helm installation specifications. For more information, see Install Portworx Backup Using Portworx Central.
  • Argo CD — A continuous delivery tool that lets you manage the Portworx Backup installation declaratively through the Argo CD web console, without relying on the Spec Generator. For more information, see Deploy Portworx Backup Using Argo CD.

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 Environment Setup for Portworx Backup Installation.

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

  5. Get Portworx Backup ready for operations. For more information, see Set up Portworx Backup for Operations.

  6. On your application cluster, perform the following additional actions:

  • Install Stork: Stork must be running on each application cluster that you want to back up. If the cluster already has Portworx Enterprise installed, Stork is included. If the cluster uses a different CSI driver, you must install Stork manually to enable KDMP-based backups.
  • (Optional) Add service account: if a user wants to generate kube-config with certificates.
  • (Optional) Grant access to a namespace for non-admin user: if an admin wants any of their users to add the cluster to Portworx Backup with limited scope for selected namespace.
  • (Optional) Configure admin namespace: only if you want to change the default namespace where Stork deploys custom resources.
  • Create a VSC if it does not exist.
    For more information on VSC status in various Kubernetes provider environments, see VSC matrix.
note

You can also install Portworx Backup from the cloud marketplace. Note that cloud marketplace deployments still require additional manual configuration steps specific to each cloud provider, such as IAM setup and UI-driven post-install tasks. For more information, see Install Portworx Backup from Cloud Marketplaces.

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

The following topics provide detailed information on the Portworx Backup installation process.

Last updated on