Skip to main content
Version: 3.4

Installation from Google Cloud Marketplace

This topic provides instructions for installing Portworx on Google Kubernetes Engine (GKE) cluster via the Google Cloud Marketplace.

The following collection of tasks describe how to install Portworx from Google Cloud Marketplace on a GKE cluster:

Complete all the tasks to install Portworx from Google Cloud Marketplace.

Install Portworx from Google Cloud Marketplace​

  1. Navigate to the GCP Marketplace.
  2. Use the search bar at the top of the Marketplace console to search for Portworx. A list of all Portworx offerings will appear. Select your desired offering.
  3. From the selected offering catalog, select Configure.
    The configuration page appears, where you can either deploy Portworx directly on your GKE cluster from the Google Cloud console or use the command line to deploy using the generated specification.
  4. On the configuration page, choose one of the following options:

    1. To deploy directly from the Google Cloud console, select Click to Deploy on GKE.

      1. On the Deploy Portworx Enterprise page provide below details
        1. In Namespace field, select portworx from the dropdown menu. you have portworx created in your environment. Do not use the default namespace, as it may cause failures.
        2. Specify your cluster details
      2. Click DEPLOY to install Portworx, and wait for the deployment to complete.
      3. Once the deployment is complete, proceed to Verify Portworx Pod Status to verify the status of Portworx pods.

    2. To deploy using the command line select option Deploy via command line

      See more about deploying via command line
      1. Choose a service account you want to associate with the billing and select Download License Key to download your license key file.
      2. Apply the GCP Marketplace license key to your GKE cluster and specify the appropriate namespace where Portworx will run:
      kubectl apply -f license.yaml -n

      Once you've created and applied the GCP Marketplace license key to your GKE cluster, you're ready to deploy Portworx.

      Generate Portworx Specification​

      1. Sign in to the Portworx Central console.
        The system displays the Welcome to Portworx Central! page.

      2. In the Portworx Enterprise section, select Generate Cluster Spec.
        The system displays the Generate Spec page.

      3. From the Portworx Version dropdown menu, select the Portworx version to install.

      4. For Platform, select your K8s Google Cloud as your cloud environment.

      5. For Distribution Name, select Google Kubernetes Engine (GKE).

      6. In Namespace field enter portworx (or the namespace where you will deploy Portworx).

      7. (Optional) To customize the configuration options and generate a custom specification, click Customize and perform the following steps:

        note

        To continue without customizing the default configuration or generating a custom specification, proceed to Step 8.

      • Basic tab:
        1. To use an existing etcd cluster, do the following:
          1. Select the Your etcd details option.
          2. In the field provided, enter the host name or IP and port number.
            For example, http://test.com.net:1234.
          3. Select one of the following authentication methods:
          • Disable HTTPS – To use HTTP for etcd communication.
          • Certificate Auth – To use HTTPS with an SSL certificate.
            For more information, see Secure your etcd communication.
          • Password Auth – To use HTTPS with username and password authentication.
        2. To use an internal Portworx-managed key-value store (kvdb), do the following:
          1. Select the Built-in option.
            note

            To restrict Portworx to run internal KVDB only on specific nodes, label those nodes with:

            kubectl label nodes node1 node2 node3 px/metadata-node=true
          2. To enable TLS encrypted communication among KVDB nodes and between Portworx nodes and the KVDB cluster, select the Enable TLS for internal kvdb checkbox.
          3. If your cluster does not already have a cert-manager, select the Deploy Cert-Manager for TLS certificates checkbox.
        3. Select Next.
      • Storage tab:
        1. Select one of the following:
          1. Create Using a Spec – Select this option to create a spec that Portworx will use to create GCP disks.
            • Select PX-Store Version – Enter the PX-Store version to be used for creating disks. Portworx recommends using the latest PX-Store version i.e PX-StoreV2
              • PX-StoreV2
              • PX-StoreV1
            • Add the following details for spec block:
              • Select Volume Type – Select the type of disk to be created from the dropdown menu.
              • Size (GB) – Enter the size of the disk to be created.
              • Encyption – Select one of the following encryption options from the dropdown menu:
                • None – Do not encrypt the disks.
                • BYOK Encryption – Use your own encryption key to encrypt the disks.
                  • If you select this option, enter the Encryption Key in the respective field, which will be used for BYOK encryption.
                  • If you select Separate KMS Account checkbox, you must provide a name KMS Account field.
              • Drive Tags – Enter multiple tags as key-value pairs to be applied to the disks created by Portworx.
            • Add/Delete spec entered using the Delete icon and + icon respectively, at the end of the spec line.
            • [Optional] Enter the Max storage nodes per availability zone.
            • Under Default IO Profile, select one of the following:
              • Auto – Automatically select the IO profile based on the underlying storage media.
              • None
            • Under Journal Device, select one of the following:
              • None – Use the default journaling setting.
              • Auto – Dynamically allocates journal device.
              • Custom – Manually specify a journal device.
                • Select Volume Type – Select the type of disk to be created from the dropdown menu.
                • Encyption – Select one of the following encryption options from the dropdown menu:
                  • None – Do not encrypt the disks.
                  • BYOK Encryption – Use your own encryption key to encrypt the disks.
                    • If you select this option, enter the Encryption Key in the respective field, which will be used for BYOK encryption.
                    • If you select Separate KMS Account checkbox, you must provide a name KMS Account field.
                • Drive Tags – Enter multiple tags as key-value pairs to be applied to the disks created by Portworx.
          2. Consume Unused – To enable Portworx to use all available, unused, and unmounted drives on the node
            • Select the PX-StoreV2 checkbox to enable the PX-StoreV2 datastore.
              • If you choose not to select this checkbox, Portworx will use PX-StoreV1 datastore as default.
              • Metdata Path: Pre-provisioned metadata path should be greater than or equal to 64Gb.
            • Under Journal Device, select one of the following:
              • None – Use the default journaling setting.
              • Auto – Automatically allocate journal devices.
              • Custom – Manually enter a journal device path.
                Enter the path of the journal device in the Journal Device Path field.
            • Select the Use unmounted disks even if they have a partition or filesystem on it. Portworx will never use a drive or partition that is mounted checkbox to use unmounted disks, even if they contain a partition or filesystem.
              Portworx will not use any mounted drive or partition.
          3. Use Existing Disks - Select this option to provide a list of existing drives on the node for Portworx to use. To manually specify the drives on the node for Portworx to use, and in the Drive/Device field, enter the path of the block drive.
            • Use Pool Label field given in each Drive/Device row to control the placement of volumes. For more information refer to How to assign custom labels to device pools. Pool label must follow key:value format. Keys and values must not be empty, contain colons (:) or whitespace. Reserved keys "medium" and "iopriority" are not allowed. Only one label per device is supported during installation.
            • Select the PX-StoreV2 checkbox to enable the PX-StoreV2 datastore.
              • If you choose not to select this checkbox, Portworx will use PX-StoreV1 datastore as default.
              • Metdata Path: Pre-provisioned metadata path should be greater than or equal to 64Gb.
            • From the Journal Device dropdown menu, select one of the following:
              • None – To use the default journaling setting.
              • Auto – To automatically allocate journal devices.
              • Custom – To manually enter a journal device path.
                Enter the path of the journal device in the Journal Device Path field.
        2. Select Next.
      • Network tab:
        1. Enter the Data Network Interface to be used for data traffic, or leave the default value of auto.
        2. Enter the Management Network Interface to be used for management traffic, or leave the default value of auto.
        3. Enter the Starting port for Portworx services, or leave the default value of 17001.
        4. Select Next.
      • Customize tab:

        1. Choose the Are you running on either of these? in the Customize section.

        2. In Environment Variables, enter name-value pairs in the respective fields.

          1. REPORTING_SECRET - <reporting-secret-name>
          2. REPORTING_SECRET_NAMESPACE - <portworx-namespace>
          3. PRODUCT_PLAN_ID - <offering-type> Choose one of the following options for PRODUCT_PLAN_ID:
            • PX-ENTERPRISE: Portworx Enterprise License for VM only nodes
            • PX-ENTERPRISE-DR: Portworx Enterprise license with Disaster Recovery feature for VM only nodes
            • PX-ENTERPRISE-BAREMETAL: Portworx Enterprise license for both VM and Bare metal hosts
            • PX-ENTERPRISE-DR-BAREMETAL: Portworx Enterprise license with Disaster Recovery feature for both VM and bare metal hosts
          4. For Disaggregated installation you need to set node labels and ENABLE_ASG_STORAGE_PARTITIONING environment variable to true. For more information, see Deployment planning.

        3. In Registry and Image Settings:

          • Enter the Custom Container Registry Location to download the Docker images.
          • Enter the Kubernetes Docker Registry Secret that serves as the authentication to access the custom container registry.
          • From the Image Pull Policy dropdown menu, select Default, Always, IfNotPresent, or Never.
            This policy influences how images are managed on the node and when updates are applied.

        4. In Security Settings, select the Enable Authorization checkbox to enable Role-Based Access Control (RBAC) and secure access to storage resources in your cluster.

        5. In Advanced Settings:

          • Select the Enable Stork checkbox to enable Stork.
          • Select the Enable CSI checkbox to enable CSI.
          • Select the Enable Monitoring checkbox to enable monitoring for user-defined projects before installing Portworx Operator.
          • Select the Enable Telemetry checkbox to enable telemetry in the StorageCluster spec.
            For more information, see Enable Pure1 integration for upgrades on GKE cluster.
          • Enter the prefix for the Portworx cluster name in the Cluster Name Prefix field.
          • Select the Secrets Store Type from the dropdown menu to store and manage secure information for features such as CloudSnaps and Encryption.

        6. Click Finish.

        7. In the summary page, enter a name for the specficiation in the Spec Name field, and tags in the Spec Tags field.

        8. Click Download .yaml to download the yaml file with the customized specification or Save Spec to save the specification.

      1. Click Save & Download to generate the specification.

      Deploy Portworx Operator​

      Use the Operator specifications you generated in the Generate Portworx Specification section, and deploy Portworx Operator by running the following command.

      kubectl apply -f 'https://install.portworx.com/<version-number>?comp=pxoperator'
      serviceaccount/portworx-operator created
      podsecuritypolicy.policy/px-operator created
      clusterrole.rbac.authorization.k8s.io/portworx-operator created
      clusterrolebinding.rbac.authorization.k8s.io/portworx-operator created
      deployment.apps/portworx-operator created

      Deploy StorageCluster​

      Use the StorageCluster specifications you generated in the Generate Portworx Specification section, and deploy StorageCluster by running the following command.

      kubectl apply -f 'https://install.portworx.com/<version-number>?operator=true&mc=false&kbver=&b=true&c=px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-8dfd338e915b&stork=true&csi=true&mon=true&tel=false&st=k8s&promop=true'
      storagecluster.core.libopenstorage.org/px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-8dfd338e915b created

Verify Portworx Pod Status​

Run the following command to list and filter the results for Portworx pods and specify the namespace where you have deployed Portworx:

kubectl get pods -n <px-namespace> -o wide | grep -e portworx -e px
portworx-api-774c2                                      1/1     Running   0                2m55s   192.168.121.196   username-k8s1-node0    <none>           <none>
portworx-api-t4lf9                                      1/1     Running   0                2m55s   192.168.121.99    username-k8s1-node1    <none>           <none>
portworx-api-dvw64                                      1/1     Running   0                2m55s   192.168.121.99    username-k8s1-node2    <none>           <none>
portworx-kvdb-94bpk                                     1/1     Running   0                4s      192.168.121.196   username-k8s1-node0    <none>           <none>
portworx-kvdb-8b67l                                     1/1     Running   0                10s     192.168.121.196   username-k8s1-node1    <none>           <none>
portworx-kvdb-fj72p                                     1/1     Running   0                30s     192.168.121.196   username-k8s1-node2    <none>           <none>
portworx-operator-58967ddd6d-kmz6c                      1/1     Running   0                4m1s    10.244.1.99       username-k8s1-node0    <none>           <none>
prometheus-px-prometheus-0                              2/2     Running   0                2m41s   10.244.1.105      username-k8s1-node0    <none>           <none>
px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-3e9bf3cd834d-9gs79   2/2     Running   0                2m55s   192.168.121.196   username-k8s1-node0    <none>           <none>
px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-3e9bf3cd834d-vpptx   2/2     Running   0                2m55s   192.168.121.99    username-k8s1-node1    <none>           <none>
px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-3e9bf3cd834d-bxmpn   2/2     Running   0                2m55s   192.168.121.191   username-k8s1-node2    <none>           <none>
px-csi-ext-868fcb9fc6-54bmc                             4/4     Running   0                3m5s    10.244.1.103      username-k8s1-node0    <none>           <none>
px-csi-ext-868fcb9fc6-8tk79                             4/4     Running   0                3m5s    10.244.1.102      username-k8s1-node2    <none>           <none>
px-csi-ext-868fcb9fc6-vbqzk                             4/4     Running   0                3m5s    10.244.3.107      username-k8s1-node1    <none>           <none>
px-prometheus-operator-59b98b5897-9nwfv                 1/1     Running   0                3m3s    10.244.1.104      username-k8s1-node0    <none>           <none>

Note the name of a px-cluster pod. You will run pxctl commands from these pods in Verify Portworx Cluster Status.

Verify Portworx Cluster Status​

You can find the status of the Portworx cluster by running pxctl status commands from a pod.
Enter the following kubectl exec command, specifying the pod name you retrieved in Verify Portworx Pod Status:

kubectl exec <pod-name> -n <px-namespace> -- /opt/pwx/bin/pxctl status
Defaulted container "portworx" out of: portworx, csi-node-driver-registrar
Status: PX is operational
Telemetry: Disabled or Unhealthy
Metering: Disabled or Unhealthy
License: Trial (expires in 31 days)
Node ID: xxxxxxxx-xxxx-xxxx-xxxx-70c31d0f478e
        IP: 192.168.121.99 
        Local Storage Pool: 1 pool
        POOL    IO_PRIORITY     RAID_LEVEL      USABLE  USED    STATUS  ZONE    REGION
        0       HIGH            raid0           3.0 TiB 10 GiB  Online  default default
        Local Storage Devices: 3 devices
        Device  Path            Media Type              Size            Last-Scan
        0:1     /dev/vdb        STORAGE_MEDIUM_MAGNETIC 1.0 TiB         14 Jul 22 22:03 UTC
        0:2     /dev/vdc        STORAGE_MEDIUM_MAGNETIC 1.0 TiB         14 Jul 22 22:03 UTC
        0:3     /dev/vdd        STORAGE_MEDIUM_MAGNETIC 1.0 TiB         14 Jul 22 22:03 UTC
        * Internal kvdb on this node is sharing this storage device /dev/vdc  to store its data.
        total           -       3.0 TiB
        Cache Devices:
         * No cache devices
Cluster Summary
        Cluster ID: px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-3e9bf3cd834d
        Cluster UUID: xxxxxxxx-xxxx-xxxx-xxxx-6f3fd5522eae
        Scheduler: kubernetes
        Nodes: 3 node(s) with storage (3 online)
        IP              ID                                      SchedulerNodeName       Auth            StorageNode     Used    Capacity        Status  StorageStatus       Version         Kernel                  OS
        192.168.121.196 xxxxxxxx-xxxx-xxxx-xxxx-fad8c65b8edc    username-k8s1-node0      Disabled        Yes             10 GiB  3.0 TiB         Online  Up 2.11.0-81faacc   3.10.0-1127.el7.x86_64  CentOS Linux 7 (Core)
        192.168.121.99  xxxxxxxx-xxxx-xxxx-xxxx-70c31d0f478e    username-k8s1-node1      Disabled        Yes             10 GiB  3.0 TiB         Online  Up (This node)      2.11.0-81faacc  3.10.0-1127.el7.x86_64  CentOS Linux 7 (Core)
        192.168.121.191 xxxxxxxx-xxxx-xxxx-xxxx-19d45b4c541a    username-k8s1-node2      Disabled        Yes             10 GiB  3.0 TiB         Online  Up  2.11.0-81faacc  3.10.0-1127.el7.x86_64  CentOS Linux 7 (Core)
Global Storage Pool        
        Total Used      :  30 GiB
        Total Capacity  :  9.0 TiB

Status displays PX is operational when the cluster is running as expected.

Verify pxctl Cluster Provision Status​

  1. Access the Portworx CLI.

  2. Run the following command to find the storage cluster:

    kubectl -n <px-namespace> get storagecluster
    NAME                                              CLUSTER UUID                           STATUS   VERSION   AGE
    px-cluster-xxxxxxxx-xxxx-xxxx-xxxx-3e9bf3cd834d   xxxxxxxx-xxxx-xxxx-xxxx-6f3fd5522eae   Online   2.11.0    10m

    The status must display the cluster is Online.

  3. Run the following command to find the storage nodes:

    kubectl -n <px-namespace> get storagenodes
    NAME                  ID                                     STATUS   VERSION          AGE
    username-k8s1-node0   xxxxxxxx-xxxx-xxxx-xxxx-fad8c65b8edc   Online   2.11.0-81faacc   11m
    username-k8s1-node1   xxxxxxxx-xxxx-xxxx-xxxx-70c31d0f478e   Online   2.11.0-81faacc   11m
    username-k8s1-node2   xxxxxxxx-xxxx-xxxx-xxxx-19d45b4c541a   Online   2.11.0-81faacc   11m

    The status must display the nodes are Online.

  4. Verify the Portworx cluster provision status by running the following command.
    Specify the pod name you retrieved in Verify Portworx Pod Status.

    kubectl exec <pod-name> -n <px-namespace> -- /opt/pwx/bin/pxctl cluster provision-status
    Defaulted container "portworx" out of: portworx, csi-node-driver-registrar
    NODE                                    NODE STATUS     POOL                                            POOL STATUS     IO_PRIORITY     SIZE    AVAILABLE  USED     PROVISIONED     ZONE    REGION  RACK
    xxxxxxxx-xxxx-xxxx-xxxx-70c31d0f478e    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-4d74ecc7e159 )      Online          HIGH            3.0 TiB 3.0 TiB    10 GiB   0 B             default default default
    xxxxxxxx-xxxx-xxxx-xxxx-fad8c65b8edc    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-97e4359e57c0 )      Online          HIGH            3.0 TiB 3.0 TiB    10 GiB   0 B             default default default
    xxxxxxxx-xxxx-xxxx-xxxx-19d45b4c541a    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-8904cab0e019 )      Online          HIGH            3.0 TiB 3.0 TiB    10 GiB   0 B             default default default

What to do next​

Create a PVC. For more information, see Create your first PVC.