Plan for installation

Portworx Backup deployment as Helm

Helm package helps to define, install, and upgrade any Kubernetes application. Helm is a template engine that creates Kubernetes manifests. Helm can upgrade and scale applications well. Helm is a package manager for Kubernetes applications that includes template and lifecycle management functionality. It is essentially a package manager for Kubernetes manifests (such as Deployments, ConfigMaps, Services, and so on) that are grouped into charts.

Helm automates creation, packaging, configuration, and deployment of Portworx Backup by combining the configuration files into a single reusable package. Helm also helps to configure external authorization providers with customization parameters. In addition, with Helm user can also provide custom registry parameters. The parameters provided by the user are added to the Helm set command during Portworx Backup installation.

For more information, refer to the following sections:

• Helm quick start guide
• Helm documentation
• Helm installation

Portworx Backup vs Portworx Central

Portworx Central provides a deployment environment to install Portworx Backup through Helm. Portworx Central acts as a hosting environment for the user to deploy Portworx Backup, Portworx Enterprise, enable License Server, and Metrics to monitor Portworx through Portworx Central web console.

Prepare Portworx Backup cluster

1. Make sure Helm is installed on the client machine

2. If you want to use your own Prometheus Operator with Portworx Backup, then 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 configuration settings outlined here based on your cluster-type:

• OCP cluster
• Rancher cluster
• Kubernetes Vanilla cluster

4. Install Portworx Backup with the Helm command.

5. (Optional) Configure external authorization provider if you want to integrate an external auth provider component.

   Portworx Backup enables you to install and integrate the following authorization providers either during or after installing Portworx Backup.

   • During installation:

     • Auth0

   • After installation:

     • Azure AD
     • Open LDAP
     • External Keycloak
     • Openshift v4

6. Make sure that the following ports are open or enabled in Portworx Backup cluster:

   Port	Purpose
   10001	Portworx Backup
   10002	Portworx Backup
   10005	Portworx Central API Server
   10006	Portworx Central API Server

Prepare application cluster

Installation

1. With Portworx

   • Install Portworx
     

     note

     By default when you install Portworx, default version of Stork is installed, make sure that Stork is upgraded to the latest version compatible with Portworx Backup version. Refer to Install prerequisites to figure out the compatible Stork version more information.

   • Upgrade Stork

2. Without Portworx

   • Install Stork or upgrade Stork