Skip to main content
Version: 2.7

Install from GCP Marketplace

This topic provides instructions for installing Portworx Backup on GKE with billing through the GCP Marketplace.


Before installing Portworx Backup, make sure that the following requirements are met:

Resource requirements


  • Access for Portworx Backup to communicate with the Google Cloud APIs/permissions pointed in GCP GKE section.

You can deploy Portworx Backup on your GKE cluster in two ways, either with GUI or CLI.

Install Portworx Backup through GUI

To install Portworx Backup through GUI in few clicks:

  1. Navigate to the GCP Marketplace console.

  2. In the Search Marketplace search bar at the top, search for portworx backup. Select Portworx Backup offering.

  3. In the Portworx Backup product details page, click CONFIGURE.

  4. Select CLICK TO DEPLOY ON GKE tab to deploy Portworx Backup through GUI.

  5. Click Create New Cluster if you wish to create a new GKE cluster. The default option is to create a new cluster. Refer GCP documentation for more information on creating a new cluster.

  6. If you already have a GKE cluster, skip step 5 and click OR SELECT AN EXISTING CLUSTER.

    • Enter the required values for Namespace, App instance name, PX Backup service account, Storage Class Name, and Reporting service account fields.

    • Click DEPLOY.

Install Portworx Backup through CLI

To install Portworx Backup using CLI option, you should:

  1. Generate and apply a license key from the GCP portal.

  2. Generate a spec in Portworx Central that can be used to report billing information to the GCP marketplace.

  3. Apply and tweak the deployment spec.


    Portworx by PureStorage recommends CLI deployment option if you are deploying Portworx Backup on Anthos bare metal or non-GKE setup.

Generate a license key

To generate a license key:

  1. Follow step 1 to step 3 in Install Portworx Backup through GUI.


  3. Choose a valid and active reporting service account from the Reporting service account dropdown list.

  4. Click DOWNLOAD LICENSE KEY to download your license key file. Your license key file will be of the following format:

    apiVersion: v1
    consumer-id: <consumer-id>
    entitlement-id: <entitlement-id>
    reporting-key: <reporting-key>
    kind: Secret
    name: <license-reporting-secret>
  5. Apply the GCP Marketplace license key to your GKE cluster and specify the appropriate namespace where Portworx Backup is going to run:

    kubectl apply -f license.yaml -n <namespace>

Once you have created and applied the GCP Marketplace license key to your GKE cluster, you are ready to deploy Portworx Backup.

Generate the spec

To generate Kubeconfig details to deploy in your cluster:

  1. Navigate to Portworx Central to generate the spec and login with appropriate credentials.

  2. From the Product Catalog, select Portworx Backup > On-premises from the product catalog.

  1. In the Spec Details tab of Portworx Backup page, provide the required values and click Next.
  1. Read and click Agree to the Portworx Backup license agreement.

  2. Execute the commands in Step 1 and Step 2 of the Finish tab and click Finish.

Edit and apply the deployment spec

Perform the steps below to apply the deployment spec:

  1. Apply the following spec on your cluster:

    apiVersion: v1
    kind: PersistentVolumeClaim
    name: pxcentral-reporting-log-dir
    namespace: <namespace>
    labels: pxcentral-reporting-log-dir
    - ReadWriteOnce
    storage: "1Gi"
    storageClassName: <storageclass-name>
  2. Edit volume and volume mounts on px-backup depoloyment:

    - name: reporting-log-dir
    claimName: pxcentral-reporting-log-dir
    - name: reporting-log-dir
    mountPath: "/tmp/reports"
  3. Add environment variables to the same deployment:

    - name: "REPORTING_LOG_DIR"
    value: "/tmp/reports"
    value: <reporting-secret-name>

    This completes Portworx Backup deployment on your GKE cluster from GCP marketplace.

Post-install validation

You can verify successful installation of Portworx Backup on your cluster with the below commands:

  1. Verify the app:

    kubectl -n <namespace> get app

    Sample output:

    NAME        TYPE              VERSION   OWNER   READY   AGE
    pxcentral Portworx Backup 2.7.1 8m39s
  2. Ensure that all the pods related to Portworx Backup are in Running status:

    kubectl -n <namespace> get pods

    Sample output:

    NAME                                       READY   STATUS      RESTARTS   AGE
    px-backup-5dc9666fb5-cbdjq 1/1 Running 0 45m
    pxc-backup-mongodb-0 1/1 Running 0 3h17m
    pxc-backup-mongodb-1 1/1 Running 0 3h17m
    pxc-backup-mongodb-2 1/1 Running 0 3h17m
    pxcentral-apiserver-74b8747844-f9nqc 1/1 Running 0 3h17m
    pxcentral-backend-85dbc7d599-hgm99 1/1 Running 0 3h14m
    pxcentral-frontend-659bc6f58f-7vh4b 1/1 Running 0 3h14m
    pxcentral-keycloak-0 1/1 Running 0 3h17m
    pxcentral-keycloak-postgresql-0 1/1 Running 0 3h17m
    pxcentral-lh-middleware-6b848df59f-sb2sg 1/1 Running 0 3h14m
    pxcentral-mysql-0 1/1 Running 0 3h17m
    pxcentral-post-install-hook-b5pbx 0/1 Completed 0 3h17m

    Post validation, refer Portworx Backup UI for configuring access to Portworx Backup web console.

    Refer the topics in the below section to start using Portworx Backup:

Was this page helpful?