Skip to main content
Version: 2.7

Install on-premises

You can install Portworx Backup on any Kubernetes cluster using Helm charts, as long as you meet the prerequisites. This can be one of your application clusters or a dedicated cluster. Since it is a multi-cluster backup solution, you need not install Portworx Backup on every cluster that you back up. Instead, other clusters are added through the Portworx Backup web console.

Install Portworx Backup in internet-connected system

  1. If you are installing Portworx Backup alone -- without Portworx Enterprise -- skip this step. If you want to install Portworx Backup with Portworx Enterprise, you must first Install Portworx, then create the following storage class on your Kubernetes cluster:

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
    name: portworx-sc
    provisioner: kubernetes.io/portworx-volume
    parameters:
    repl: "3"
  2. From the CLI, install helm:

    curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
    chmod 700 get_helm.sh
    ./get_helm.sh
  3. Access Portworx Central portal.

  4. From the home page, navigate to Backup Services under Explore our Products.

  5. Click on I agree to EULA and go through the Portworx Products Terms of Use carefully.

  6. Navigate back to the Portworx Central portal and click Start Free Trial.

  7. In the Spec Details provide the following values:

    • Backup Version: select the required version of Portworx Backup from the dropdown list
    • Namespace: provide the name of the namespace where you want an instance of Portworx Backup to be installed
    • Install using: choose Helm 3
    • Select your environment: choose On-Premises or Cloud based on your storage environment
    • StorageClass Name: name of the StorageClass, refer tooltip for more details
    • Use your OIDC: select this checkbox only if your external authorization provider is Auth0 and key in the following fields:
      • Endpoint
      • Client ID
      • Client Secret

These values can be fetched from the Auth0 web console.

  • Use existing Prometheus: select this checkbox if you have to use your existing Prometheus stack to monitor Portworx Backup and enter the values for the following fields:

    * **Prometheus Endpoint**: enter details of the endpoint where your Prometheus is installed
    * **Alertmanager Endpoint**: enter details of the endpoint where your Alertmanager is installed
    * **Prometheus secret name**: enter secret name of your Prometheus stack
    * **Alertmanager secret name**: enter secret name of your Alertmanager
    * **Custom email template from PX-Backup**: select to upload Portworx Backup's custom email template to your pre-configured Alertmanager for email notifications
    • Use custom registry: for air-gapped environments
      • Custom Image Repository Location: path of custom image repository
      • Image Pull Secret(s): create a secret only if image pulling from an internal repository requires credentials
    note

    Create a secret only if image pulling from an internal repository requires credentials.

  1. Click Next to navigate to Finish tab.

  2. Execute the command in Step 1 of web console to add the repo to your cluster and update it:

    helm repo add portworx http://charts.portworx.io/ && helm repo update
  3. You can install Portworx Backup either with default options or with advanced options based on your environment:

    • To Install Portworx Backup with default options:
      Execute the command under Step 2 of web console under Install using the ‘set’ command.

      OR

    • To Install Portworx Backup with advanced options:
      Click values-px-central.yaml file to download and modify the default options.

  4. Click Finish to complete the installation.

You can find more information about the Portworx Backup Helm chart in the helm section.

Configure external OIDC endpoints

If you enabled an external OIDC during the Portworx Backup installation, you must manually configure the redirect URI in your OIDC provider.

Refer to the Set up login redirects section of the Portworx Enterprise documentation for instructions.

Was this page helpful?