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. Refer the following topics before you begin:

   • Support matrices

   • Install prerequisites

2. On your Portworx Backup cluster

   a. Pre-installation

   • (Optional) Configure Prometheus: if you want to use your own Prometheus or Portworx Backup Prometheus

   b. Installation

   • Install in internet-connected environment
     OR
     
   • Install in air-gapped environment

   c. Post installation

   • Configure access to the Portworx Backup web console

   • Configure and integrate external authorization providers

   • Configure certificates in Keycloak

   • (Optional) Add local users and groups

   • (Optional) Add Portworx Backup roles

   • (Optional) Map roles to users and user groups

   • (Optional) Map AD group with Portworx Backup group

   • (Optional) Map Azure AD groups to Portworx Backup roles

   • (Optional) Configure email alerts through SMTP server

   • (Optional) Configure Portworx Backup for S3 object store with TLS

   • (Optional) Configure REST API

3. On your application cluster
   a. Installation

   • (Optional) Install Portworx: if you need to back up Portworx volumes

   • (Optional) Add service account: if 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 user 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

   • Install Stork

   b. Post-installation

   • Create a VSC if it does not exist.

   For more information on VSC status in various Kubernetes provider environments, refer to VSC matrix.

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.