Get Started

This page serves as a quick start guide to take you through the essential steps for a fresh installation and upgrade of Portworx Backup.

Install

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:

   • Using Portworx Central where you generate the specifications using Portworx spec generator tool.
     For more information, see Install Portworx Backup Using Portworx Central.
   • Using Argo CD where you use the Argo CD web console to configure a continuous delivery setup for Portworx Backup installation.
     For more information, see Deploy Portworx Backup Using Argo CD.

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, refer to 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 are done with installation and configuration tasks, access Portworx Backup web console and refer to Configure and Operate module to start off with configuration and operational tasks.

Upgrade

1. On Portworx Backup cluster:

   • Upgrade Portworx Backup in internet-connected environment
     
     OR
     

   • Upgrade Portworx Backup in air-gapped environment

2. On application cluster, Upgrade Stork.

   Post upgrade, refer to Configure and Operate module for the next steps.