Skip to main content
Version: 3.1

Install Portworx Backup using Argo CD

Applicable to Classic mode only

This topic details how to install Portworx Backup using Argo CD. Argo CD is a GitOps-based continuous delivery tool for Kubernetes.
Using Argo CD, you can install Portworx Backup in both air-gapped and non-air-gapped environments.

The Portworx Backup installation using Argo CD leverages Helm charts and integrates with Git repositories or Helm repositories depending on the deployment approach. It also emphasizes proper configuration and sync management for smooth operations.

To upgrade an existing Portworx Backup deployment using Argo CD, see Upgrade Portworx Backup using Argo CD.

For more information on Argo CD, see the following Argo CD documentation:

Prerequisites​

Ensure that the setup meets the following requirements before you install Portworx Backup using Argo CD:

  • The compatible Argo CD version is available. For more information, see Portworx Backup Argo CD Compatibility Matrix.

  • Access to Argo CD web console is available.

  • The pxc-credentials secret is created in the target namespace. For more information, see Create PXC credentials secret.

  • You have generated the Portworx Backup spec (the Helm values) using Portworx Central. For more information, see Generate Portworx Backup Spec.

  • The required Portworx Backup ports are open on the cluster network: 10001 and 10002 (Portworx Backup) and 10005 and 10006 (Portworx Central API server), listed under What to do next, in addition to the standard Kubernetes, Argo CD, and ingress or load balancer ports for your environment. For the complete networking requirements, see Requirements for Portworx Backup Installation.

  • (For air-gapped environment only) An internal Git repository is available where you extract and commit the px-central-<pxb-version>.tgz Helm chart package.

    1. Run the following command on the node where helm3 is installed to download the px-central-<pxb-version>.tgz Helm chart package.

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

      Replace <pxb-version> with the Portworx Backup version. For example, 3.1.2

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

note

To deploy Portworx Backup using Argo CD, set the following helm parameters:

  • isArgoCD=true
  • isOpenshift=true
    This setting is required only if the cluster where you deploy Portworx Backup is an Openshift cluster.

Decide the exposure scope before you sync​

caution

Before you sync the application, decide how the Portworx Backup UI and API are exposed. Keep internal services on ClusterIP, and expose the administrative UI only through an ingress or gateway with TLS (and OIDC where possible), or an internal load balancer restricted by source ranges. Do not expose the UI or API broadly to the VPC or the public internet. For the supported access models and how to configure them, see Choose an access model for the Portworx Backup web console.

Install Portworx Backup using Argo CD​

To install Portworx Backup using Argo CD, follow these steps:

  1. Log in and access the 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:

      • Git Repository (Applicable for both air-gapped and non-air-gapped environments)

        • Repository URL:
          • For non-air-gapped environment, specify https://github.com/portworx/helm.
          • For air-gapped environment, specify the local git repository URL where you extracted the px-central package.
        • Revision:
          • For non-air-gapped environment, specify master.
          • For air-gapped environment, specify master or the git branch name where you extracted the px-central-<pxb-version>.tgz package.
        • Path:
          • For non-air-gapped environment, specify stable/px-central (the chart subdirectory within the portworx/helm repository).
          • For air-gapped environment, specify the subdirectory path within your internal Git repository where you extracted the chart (for example, stable/px-central).

        To install or upgrade to the latest Portworx Backup version in a non-air-gapped environment, Portworx recommends that you use a Git repository.

      • Helm Repository (Applicable for non-air-gapped environment only)

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

        To install or upgrade to an older or pinned Portworx Backup version in a non-air-gapped environment, Portworx recommends that you use a Helm repository as source.

    • Destination Configuration:

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

      • Under the Helm section, provide the Portworx Backup configuration values. These are the same Helm values used by the Helm install method — the spec you generate in Portworx Central applies to Argo CD in exactly the same way. You can either:
        • Paste the values generated from spec-gen (recommended). This carries over the same options you would set for a Helm install — for example, Backup Version, Namespace, StorageClass, custom registry (air-gapped), proxy configuration, external OIDC, telemetry, service mesh (Istio/Linkerd), and the database credentials — OR
        • Manually configure values in the Parameters section.
      • Set the same UI network-exposure options you would use with Helm to match your intended exposure scope (see the Decide the exposure scope before you sync caution above): pxBackupUIServiceType and pxCentralUIServiceType (ClusterIP or LoadBalancer), the internal load balancer annotations, and pxBackupUILoadBalancerSourceRanges. For the full list of spec options, see Generate Portworx Backup Spec; for the UI exposure and service-type options, see Choose an access model for the Portworx Backup web console.
  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: pxb-deploy

  7. Go to the DETAILS → MANIFEST section.

  8. Click EDIT and append the following configuration:

    syncPolicy:
    syncOptions:
    - RespectIgnoreDifferences=true
    - CreateNamespace=true
    - ServerSideApply=true
    - ClientSideApplyMigration=false
    ignoreDifferences:
    # pxcentral-ui-configmap: FRONTEND_ENABLED_MODULES is set by the Portworx
    # Backup post-install hook at runtime, so Argo CD must not revert it.
    - kind: ConfigMap
    name: pxcentral-ui-configmap
    namespace: <target-namespace> # must match the Destination namespace you set in step 3
    jsonPointers:
    - /data/FRONTEND_ENABLED_MODULES
    # CustomResourceDefinitions: the Portworx/Stork operator and apiserver
    # update these annotations, labels, and the CRD spec at runtime.
    # Ignoring them prevents Argo CD from flagging vendor-reconciled changes.
    - group: apiextensions.k8s.io
    kind: CustomResourceDefinition
    jsonPointers:
    - /metadata/annotations
    - /metadata/labels
    - /spec
    # StatefulSet volumeClaimTemplates are immutable after creation and are
    # managed by the chart; ignoring them avoids permanent OutOfSync diffs.
    - group: apps
    kind: StatefulSet
    jsonPointers:
    - /spec/volumeClaimTemplates

    Replace <target-namespace> with the same namespace you entered in the Destination Configuration > Namespace field in step 3.

  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.

To upgrade Portworx Backup using Argo CD, see Upgrade Portworx Backup using Argo CD.

What to do next​

Enable the following ports on the Backup cluster:

PortPurpose
10001Portworx Backup
10002Portworx Backup
10005Portworx Central API Server
10006Portworx Central API Server

Then perform the post-installation configuration tasks to get Portworx Backup ready for operations — retrieve the admin credentials and sign in to the web console, integrate authentication providers, set up role-based access control, prepare your application clusters, apply a license, and configure observability. For more information, see Configure Portworx Backup for Operations.

In this topic: