Skip to main content

Add GKE clusters

Prerequisites

  • You have added your GCP cloud account to Portworx Backup.

  • Your cluster must be running Stork 23.7.2 or higher. To install Stork on your Kubernetes cluster, copy and paste the command displayed below the Cloud Account radio group.

  • In GCP, create a GCP role with the following permissions:

    • container.*.get

    • container.*.list

    • compute.snapshots.*

    • compute.disks.*

    • storage.*

    • container.secrets.*

    • container.thirdPartyObjects.*

    • container.thirdPartyResources.*

      Associate this new GCP role to a service account used on the cluster where you want to install Portworx Backup. Save the JSON key for this service account for future reference. Also, select this service account in the node security settings while deploying the cluster where you want to install Portworx Backup.

  • Generate Kubeconfig.

Generate Kubeconfig for GKE clusters

To add a GKE cluster in Portworx Backup, you need kubeconfig details. You can fetch kubeconfig details either through Cloud Shell or gcloud CLI.

Kubeconfig with Cloud Shell

Run the below commands in Cloud Shell to get kubeconfig data:

  1. Disable the new binary plugin for authentication:

    export USE_GKE_GCLOUD_AUTH_PLUGIN=False

    For more information, refer kubectl authentication in GKE.

  2. Connect to your GKE cluster:

    gcloud container clusters get-credentials <gke-clustername> --zone <zone-name> --project <project-name>
  3. Get the kubeconfig for your GKE cluster:

    kubectl config view –-flatten –-minnify

    Above steps fetch the required kubeconfig information. In the kubeconfig details, please make sure the user section holds data related to auth-provider and not that of exec.

    A sample output (fragment from kubeconfig details) from users section with auth-provider related data:

    users:
    - name: <GKE-cluster-name>
    user:
    auth-provider:
    config:
    access-token: <access-token>
    cmd-args: config config-helper --format=json
    cmd-path: /root/gcloud/google-cloud-sdk/bin/gcloud
    expiry: "2023-03-28T13:05:32Z"
    expiry-key: '{.credential.token_expiry}'
    token-key: '{.credential.access_token}'
    name: gcp

Kubeconfig with gcloud CLI

  1. Install the gcloud CLI, refer installation instructions for more details.

  2. Initialize gcloud CLI:

    gcloud init
  3. Run the commands listed in step 1, 2, and 3 in Kubeconfig with Cloud Shell topic on your gcloud CLI to obtain kubeconfig details.

Add the cluster to Portworx Backup

  1. From the home page, select Add Cluster:

    Add cluster

  2. In the Add Cluster page, under Select Kubernetes Platform, select GKE and then enter the cluster details:

    • The name of the cluster
    • Retrieve the Kubeconfig from your cluster and paste it in the Kubeconfig text frame or click Browse to upload it from a file.
    • From the Cloud Account dropdown, select your GCP cloud account.

    Enter the cluster details

  3. Click Add Cluster.

Was this page helpful?