Skip to main content
Version: 2.10

Overview

The Portworx Backup Spec Generator is a web-based tool that helps you configure and generate installation specifications for Portworx Backup. The interface consists of two main tabs: Spec Details and Finish, guiding you through the complete configuration and installation process.

Install Portworx Backup on Kubernetes Cluster​

Spec Details Tab​

  1. Access Portworx Central portal.

  2. Enter user credentials and make sure that you go through End-User License Agreement (EULA).

    If you are new to Portworx Central, click on Create account to generate your login credentials. You can also sign in with your organization’s OIDC identity provider, Google or Github account.

  3. Click Sign In to access the Portworx Central portal.

  4. On the home page, under Explore our Products, navigate to the Portworx Backup card. Then click Generate Backup Spec to open the Portworx Backup Install/upgrade page (Spec Details tab).

  5. In the Spec Details tab provide the following values:

    1. Release Information

      • Backup Version: select the required version of Portworx Backup from the drop-down list
      • Namespace: provide the name of the namespace where you want an instance of Portworx Backup to be installed
      • Select your environment: choose On-Premises or Cloud based on your storage environment

    2. Configuration

      • StorageClass Name: name of the StorageClass, refer tooltip for more details
      note

      Defining the namespace and StorageClass is a one-time configuration step that should be completed during the initial installation. PVCs will be created using Namespace and StorageClass values you define in the SpecGen, and these values cannot be modified later during an upgrade.

      • Enable Rancher RBAC: select this checkbox if you are using Rancher for managing your Kubernetes clusters and want to enable Rancher's Role-Based Access Control (RBAC) for Portworx Backup. This feature can be enabled only if you have LDAP or PingIdentity as your identity provider. For more information, refer to PXB Rancher RBAC and Rancher RBAC.

      • 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. For more information on integrating external authorization providers, refer to Integrate Auth Providers

      • 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
        • Use Custom email template from PX-Backup: select to upload Portworx Backup's custom email template to your pre-configured Alertmanager for email notifications

      • Proxy Configuration: select this checkbox if you have proxy server configured in your environment and enter the values for the following fields:

        • Unathenticated: choose this if you have unathenticated proxy server

          • HTTP Proxy: proxy server URL for http proxy
          • HTTPS Proxy: proxy server URL for https proxy
          • NO PROXY: comma separated list of hostnames IPs or domains that should bypass the proxy settings

        • Authenticated/CA: choose this option if your cluster is behind a proxy server with authentication or CA

          • Proxy configuration secret: name of the kubernetes proxy configuration secret created in pxb namespace holding the proxy configuration

    3. Custom Registry


      • Use custom registry: applicable only for air-gapped environments, do not select this check-box if you are on non-airgapped system.

    4. Database Credentials: This section configures database passwords for the various database components used by Portworx Backup. For more information on password guidelines, refer to Password Policy.

      • MySQL Root User Password: root password for MySQL database

      • Postgres User Password: password for PostgreSQL user

      • MongoDB PX-Backup User Password: password for MongoDB PX-Backup user

      • MongoDB Root User Password: root password for MongoDB database

      • MongoDB Replica Set Key: key for MongoDB replica set authentication

      • Encrypt MongoDB: select this checkbox to enable encryption at rest for MongoDB database

      • MongoDB Master Encryption Key: Master encryption key for MongoDB encryption at rest

        caution

        Safeguarding your encryption key is vital to prevent permanent data loss. If the key is lost, you will be unable to access your encrypted data, as it is the only means of decryption. Without it, the data is rendered completely inaccessible and cannot be recovered. Note that encryption keys cannot be rotated after they are set.

  6. Click Next to navigate to Finish tab.

Navigate to the Finish tab at the top to execute few commands to complete the installation.