Install PXB through Argo CD

This topic details how to deploy Portworx Backup (PXB) using Argo CD, a GitOps-based continuous delivery tool for Kubernetes. It supports two types of environments:

• Internet-connected environments

• Air-gapped (offline) environments

The deployment leverages Helm charts and integrates with Git repositories or Helm repositories depending on the installation approach. It also emphasizes proper configuration, sync management, and customizations for smooth operations and upgrades.

For more information refer to the following topics in Argo CD documentation:

• Getting started

• Argo CD installation

Prerequisites

• Access to Argo CD web console

• Helm-generated values using spec-gen

• (For air-gapped setups) Internal Git repository and downloaded .tgz Helm chart package

Install PXB (Internet-connected)

1. Login and access Argo CD web console.

2. Click NEW APP or CREATE APPLICATION.

3. Configure the application:

   1. In the Create Application page, provide the following details:

   • General Settings:

     • Application Name: provide a meaningful name to your application (for example, pxb-deploy).
     • Project: choose the appropriate project from the drop-down.
     • Sync Policy: select Manual.
     • Sync Option: check the options Respect Ignore Differences, Auto-Create Namespace, Server-Side Apply

   • Source Configuration (Choose One Option):

     • Option A: using Git Repository (for latest versions)

       • Repository URL: https://github.com/portworx/helm
       • Revision: master
       • Path: charts/px-central

       Recommended if you want to install or upgrade to the latest Portworx Backup version.

     • Option B: using Helm Repository (for older or specific versions)

       • Repository URL: http://charts.portworx.io/
       • Chart: px-central
       • Version: specify the desired version (Example: 2.9.1)

       Recommended for installing or upgrading to older or pinned PXB versions.

   • Destination Configuration:

     • Cluster URL: select the target Kubernetes cluster.
     • Namespace: enter the target namespace (example: px-backup)

   • Helm Configuration:

     • Under the Helm section:
       • Paste the values generated from spec-gen OR
       • Manually configure values in the Parameters section

4. Click CREATE to proceed with application creation.

5. After creating the application, perform the following steps to configure the differences:

6. Open the created Application Card. For example: px-backup

7. Go to the DETAILS → MANIFEST section.

8. Click EDIT and append the following configuration:

   ignoreDifferences:
     - kind: ConfigMap
       name: pxcentral-ui-configmap
       namespace: px-backup
       jsonPointers:
         - /data/FRONTEND_ENABLED_MODULES
     - group: apiextensions.k8s.io
       kind: CustomResourceDefinition
       jsonPointers:
         - /metadata/annotations
         - /metadata/labels
         - /spec

9. Click SAVE.

10. Click SYNC to deploy Portworx Backup.

11. After initial deployment, navigate to Applications → DETAILS → PARAMETERS. Set the Helm parameter isUpgrade to true, which is required for further syncs.

Install PXB (Air-gapped)

Prerequisite

From the node where you run the helm3 command:

1. Download the latest px-central package with the following command:

curl -O https://raw.githubusercontent.com/portworx/helm/master/stable/px-central-<pxb-version>.tgz

Replace <pxb-version> with the PXB version you want to install. Example: 2.9.0 or 2.9.1

2. Extract the above downloaded file and commit it to the internal git repository.

To start the actual installation, carry out the following steps:

1. Login and access Argo CD web console.

2. Click NEW APP or CREATE APPLICATION.

3. Configure the application:

   1. In the Create Application page, provide the following details:

   • General Settings:

     • Application Name: provide a meaningful name to your application (for example, pxb-deploy).
     • Project: choose the appropriate project from the drop-down.
     • Sync Policy: select Manual.
     • Sync Option: check the options Respect Ignore Differences, Auto-Create Namespace, and Server-Side Apply

   • Source Configuration (Choose One Option): Using Local Git Repository

     • Repository URL: https://github.com/portworx/helm
     • Revision: master (or use a specific branch)
     • Path: charts/px-central

   • Destination Configuration:

     • Cluster URL: select the target Kubernetes cluster.
     • Namespace: enter the target namespace (example: px-backup)

   • Helm Configuration:

     • Under the Helm section:

       • Paste the values generated from spec-gen. OR
       • Manually configure values in the Parameters section.
       note

       1. For installation through Argo CD, set the below helm parameter:
          isArgoCD=true
       2. If the cluster where you are planning to deploy PXB is OpenShift with Argo CD then, set the following helm parameters to true:
          isArgoCD=true
isOpenshift=true

4. Click CREATE to proceed with application creation.

5. After creating the application, perform the following steps to configure the differences:

6. Open the created Application Card.

7. Go to the DETAILS → MANIFEST section.

3. Click EDIT and append the following configuration:

   ignoreDifferences:
     - kind: ConfigMap
       name: pxcentral-ui-configmap
       namespace: px-backup
       jsonPointers:
         - /data/FRONTEND_ENABLED_MODULES
     - group: apiextensions.k8s.io
       kind: CustomResourceDefinition
       jsonPointers:
         - /metadata/annotations
         - /metadata/labels
         - /spec

4. Click SAVE.

5. Click SYNC to deploy Portworx Backup.

6. After initial deployment, navigate to Applications → DETAILS → PARAMETERS. Set the Helm parameter isUpgrade to true, which is required for further syncs.

Upgrade PXB in internet-connected and air-gapped environments

To upgrade PXB through Argo CD web console either in internet-connected or air-gapped environments, From the Argo CD web console:

1. Navigate to Applications > PXB application card > Details > MANIFEST > Edit.

2. Ensure that isUpgrade parameter is set to true.

3. Replace the targetRevision parameter value to the PXB version you want to upgrade to.

4. Click Save.

5. Click SYNC.

After sometime Argo CD web console upgrades PXB version to the required version.