# GKE

{% hint style="info" %}
For an overview of the available Kubernetes features and supported platforms, please see our [Kubernetes guide](https://docs.strongdm.com/admin/resources/clusters).
{% endhint %}

## Overview

This guide describes how to manage access to an Google Kubernetes Engine (GKE) cluster. Adding a GKE cluster takes place in the StrongDM Admin UI, Google Cloud Console, and Google Developers Console.

{% hint style="info" %}
If you would like to learn more about how to enable automatic resource discovery within your Kubernetes cluster, or use privilege levels to allow users to request various levels of access to the Kubernetes cluster, please read the [Kubernetes Discovery and Privilege Levels](https://docs.strongdm.com/admin/resources/clusters/kubernetes-management) section to learn more about those features prior to following this configuration guide.
{% endhint %}

## Prerequisites

Before you begin, ensure that the GKE endpoint you are connecting is accessible from one of your StrongDM gateways or relays. See our guide on [nodes](https://docs.strongdm.com/admin/networking/gateways-and-relays) for more information.

{% hint style="info" %}
If you are using kubectl 1.30 or higher, it will default to using websockets, which the StrongDM client did not support prior to version 45.35.0. This can be remedied by taking one of the following actions:

* Update your client to version 45.35.0 or greater.
* Set the environment variable `KUBECTL_REMOTE_COMMAND_WEBSOCKETS=false` to restore the previous behavior in your kubectl.
  {% endhint %}

## Resource Configuration in StrongDM

This section provides instructions for adding the resource in either the StrongDM Admin UI, CLI, Terraform provider, or SDKs.

{% tabs %}
{% tab title="Admin UI" %}
**Set up and Manage With the Admin UI**

If using the Admin UI to add the resource to StrongDM, use the following steps.

1. Log in to the Admin UI and go to **Infrastructure > Clusters**.
2. Click the **Add Resource** button.
3. Select **Google Kubernetes Engine** as the **Resource Type** and set other [resource properties](#resource-properties) to configure how the StrongDM relay connects.

   ![](https://4180056444-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF7eka9SH5TT8nJm2ZfWj%2Fuploads%2Fgit-blob-fba03eb820c3cba4c3045c2096f827079ba48894%2Fadd-resource-gke.png?alt=media)
4. Click **Create** to save the resource.

The Admin UI updates and shows your new cluster in a green or yellow state. Green indicates a successful connection. If it is yellow, click the **pencil** icon to the right of the server to reopen the **Connection Details** screen. Then click **Diagnostics** to determine where the connection is failing.
{% endtab %}

{% tab title="CLI" %}
**Set up and Manage With the CLI**

This section provides general steps on how to configure and manage the resource using the StrongDM CLI. For more information and examples, please see the [CLI Reference](https://docs.strongdm.com/references/cli) documentation.

1. In your terminal or Command Prompt, log in to StrongDM:

   ```sh
   sdm login
   ```
2. Run `sdm admin clusters add gke --help` to view the help text for the command, which shows you how to use the command and what options (properties) are available. Note which [properties](#resource-properties) are required and collect the values for them.

   ```sh
   NAME:
      sdm admin clusters add gke - create Google Kubernetes Engine cluster

   USAGE:
      sdm admin clusters add gke [command options] <name>

   OPTIONS:
      --allow-resource-role-bypass                 (For legacy orgs) allows users to fallback to the existing authentication mode (Leased Credential or Identity Set) when a resource role is not provided.
      --bind-interface value                       IP address on which to listen for connections to this resource on clients. Specify "default", "loopback", or "vnm" to automatically allocate an available address from the corresponding IP range configured in the organization. (default: "default")
      --certificate-authority value                (secret)
      --discovery-enabled                          Enable discovery for the cluster.
      --discovery-username value                   The user to impersonate in the cluster when running discovery. Required if the cluster is configured for identity aliases. (conditional)
      --egress-filter value                        apply filter to select egress nodes e.g. 'field:name tag:key=value ...'
      --endpoint value                             (required)
      --healthcheck-namespace default              This path will be used to check the health of your connection.  Defaults to default.
      --identity-alias-healthcheck-username value  (conditional)
      --identity-set-id value                      
      --identity-set-name value                    set the identity set by name
      --port-override value                        Port on which to listen for connections to this resource on clients. Specify "-1" to automatically allocate an available port. (default: -1)
      --proxy-cluster-id value                     proxy cluster id
      --secret-store-id value                      secret store id
      --service-account-key value                  (required, secret)
      --subdomain value, --bind-subdomain value    DNS subdomain through which this resource may be accessed on clients (e.g. "app-prod" allows the resource to be accessed as "app-prod.<your-org-name>.<sdm-proxy-domain>"). Only applicable to HTTP-based resources or resources using virtual networking mode.
      --tags value                                 tags e.g. 'key=value,...'
      --template, -t                               display a JSON template
      --timeout value                              set time limit for command
   ```
3. Then run `sdm admin clusters add gke <RESOURCE_NAME>` and set all required properties with their values. For example:

   ```sh
   sdm admin clusters add gke "gke-cluster-prod"
     --endpoint "https://35.225.123.45"
     --service-account-key "/etc/strongdm/keys/gcp-service-account.json"
     --certificate-authority "/etc/strongdm/certs/gke-ca.crt"
     --identity-set-name "GKE Cluster Admins"
     --identity-alias-healthcheck-username "svc_gke_health"
     --discovery-enabled
     --discovery-username "sdm-discovery"
     --healthcheck-namespace "default"
     --bind-interface "default"
     --port-override -1
     --egress-filter 'field:name tag:env=prod tag:region=us-central1'
     --proxy-cluster-id "plc_0123456789abcdef"
     --secret-store-id "ss_abcdef0123456789"
     --subdomain "gke-prod01"
     --tags "env=prod,cloud=gcp,platform=kubernetes,team=platform"
     --timeout 30
   ```
4. Check that the resource has been added. The output of the following command should show the resource's name:

   ```sh
   sdm admin clusters list
   ```

{% endtab %}

{% tab title="Terraform" %}
**Set up and Manage With Terraform**

This section provides an example of how to configure and manage the resource using the Terraform provider. For more information and examples, please see the [Terraform provider](https://github.com/strongdm/terraform-provider-sdm) documentation.

```hcl
# Install StrongDM provider
terraform {
  required_providers {
    sdm = {
      source  = "strongdm/sdm"
      version = "16.5.0"
    }
  }
}

# Configure StrongDM provider
provider "sdm" {
  # Add API access key and secret key from the Admin UI
  api_access_key = "njjSn...5hM"
  api_secret_key = "ziG...="
}

# ----------------------------
# Create Google Kubernetes Engine (GKE) cluster
# ----------------------------
resource "sdm_resource" "gke_cluster_prod" {
  gke {
    # Required
    name                  = "gke-cluster-prod"                      # <name>
    endpoint              = "https://35.225.123.45"                 # --endpoint
    service_account_key   = file("/etc/strongdm/keys/gcp-service-account.json")  # --service-account-key (use secret store for production)

    # TLS / CA
    certificate_authority = file("/etc/strongdm/certs/gke-ca.crt")  # --certificate-authority

    # Identity & discovery
    identity_set_name                   = "GKE Cluster Admins"      # --identity-set-name
    identity_alias_healthcheck_username = "svc_gke_health"          # --identity-alias-healthcheck-username (conditional)
    discovery_enabled                   = true                      # --discovery-enabled
    discovery_username                  = "sdm-discovery"           # --discovery-username
    healthcheck_namespace               = "default"                 # --healthcheck-namespace

    # Common networking options
    bind_interface = "default"                                      # --bind-interface ("default" | "loopback" | "vnm")
    port_override  = -1                                             # --port-override (-1 = auto-allocate)
    egress_filter  = "field:name tag:env=prod tag:region=us-central1" # --egress-filter
    subdomain      = "gke-prod01"                                   # --subdomain / --bind-subdomain (for VN access)

    # Optional integrations
    proxy_cluster_id = "plc_0123456789abcdef"                       # --proxy-cluster-id
    secret_store_id  = "ss_abcdef0123456789"                        # --secret-store-id (recommended for key and cert storage)

    # (Legacy orgs) allow fallback auth when no resource role is provided
    allow_resource_role_bypass = false                              # --allow-resource-role-bypass

    # Tags
    tags = {                                                        # --tags
      env      = "prod"
      cloud    = "gcp"
      platform = "kuberne
```

{% endtab %}

{% tab title="SDKs" %}
**Set up and Manage With SDKs**

In addition to the Admin UI, CLI, and Terraform, you may configure and manage your resource with any of the following SDK options: Go, Java, Python, and Ruby. Please see the following references for more information and examples.

| Go            | ​[pkg.go.dev](https://pkg.go.dev/github.com/strongdm/strongdm-sdk-go/v16)​ | ​[strongdm-sdk-go](https://github.com/strongdm/strongdm-sdk-go)​         | ​[Go SDK Examples](https://github.com/strongdm/strongdm-sdk-go-examples)​         |
| ------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
| Java          | ​[javadoc](https://strongdm.github.io/strongdm-sdk-java-docs/)​            | ​[strongdm-sdk-java](https://github.com/strongdm/strongdm-sdk-java)​     | ​[Java SDK Examples](https://github.com/strongdm/strongdm-sdk-java-examples)​     |
| Python        | ​[pdocs](https://strongdm.github.io/strongdm-sdk-python-docs/)​            | ​[strongdm-sdk-python](https://github.com/strongdm/strongdm-sdk-python)​ | ​[Python SDK Examples](https://github.com/strongdm/strongdm-sdk-python-examples)​ |
| Ruby          | ​[RubyDoc](https://www.rubydoc.info/gems/strongdm)​                        | ​[strongdm-sdk-ruby](https://github.com/strongdm/strongdm-sdk-ruby)​     | ​[Ruby SDK Examples](https://github.com/strongdm/strongdm-sdk-ruby-examples)​     |
| {% endtab %}  |                                                                            |                                                                          |                                                                                   |
| {% endtabs %} |                                                                            |                                                                          |                                                                                   |

## Resource properties

The **GKE** cluster type has the following properties.

<table><thead><tr><th width="200.1505126953125">Property</th><th width="130.0845947265625">Requirement</th><th>Description</th></tr></thead><tbody><tr><td><strong>Display Name</strong></td><td>Required</td><td>Meaningful name to display the resource throughout StrongDM; exclude special characters like quotes (") or angle brackets (&#x3C; or >)</td></tr><tr><td><strong>Cluster Type</strong></td><td>Required</td><td><strong>Google Kubernetes Engine</strong></td></tr><tr><td><strong>Proxy Cluster</strong></td><td>Required</td><td>Defaults to "None (use gateways)"; if using <a href="../../networking/proxy-clusters">proxy clusters</a>, select the appropriate cluster to proxy traffic to this resource</td></tr><tr><td><strong>Endpoint</strong></td><td>Required</td><td>Endpoint of the GKE cluster, such as <code>35.232.191.126</code>; relay server should be able to <a href="#prerequisites">connect to your GKE endpoint</a></td></tr><tr><td><strong>Connectivity Mode</strong></td><td>Required</td><td>Select either <strong>Virtual Networking Mode</strong>, which lets users connect to the resource with a software-defined, IP-based network; or <strong>Loopback Mode</strong>, which allows users to connect to the resource using the local loopback adapter in their operating system; this field is shown if <a href="../../clients/client-networking/virtual-networking-mode">Virtual Networking Mode</a> enabled for your organization</td></tr><tr><td><strong>IP Address</strong></td><td>Optional</td><td>If <strong>Virtual Networking Mode</strong> is the selected connectivity mode, an IP address value in the configured Virtual Networking Mode subnet in the organization network settings; if <strong>Loopback Mode</strong> is the selected connectivity mode, an IP address value in the configured Loopback IP range in the organization network settings (by default, <code>127.0.0.1</code>); if not specified, an available IP address in the configured IP address space for the selected connectivity mode will be automatically assigned; this field is shown if <a href="../../clients/client-networking/virtual-networking-mode">Virtual Networking Mode</a> and/or <a href="../../clients/client-networking/loopback-ip-ranges">multi-loopback mode</a> is enabled for your organization</td></tr><tr><td><strong>Port Override</strong></td><td>Optional</td><td>If <strong>Virtual Networking Mode</strong> is the selected connectivity mode, a port value between 1 and 65535 that is not already in use by another resource with the same IP address; if <strong>Loopback Mode</strong> is the selected connectivity mode, a port value between 1024 to 64999 that is not already in use by another resource with the same IP address; when left empty with Virtual Networking Mode, the system assigns the default port to this resource; when left empty for Loopback Mode, an available port that is not already in use by another resource is assigned; preferred port also can be modified later from the <a href="../port-overrides">Port Overrides settings</a></td></tr><tr><td><strong>DNS</strong></td><td>Optional</td><td>If Virtual Networking Mode is the selected connectivity mode, a unique hostname alias for this resource; when set, causes the desktop app to display this resource's human-readable DNS name (for example, <code>k8s.my-organization-name</code>) instead of the bind address that includes IP address and port (for example, <code>100.64.100.100:5432</code>)</td></tr><tr><td><strong>Secret Store</strong></td><td>Optional</td><td>Credential store location; defaults to none (credentials are stored in StrongDM resource configuration); to learn more, see <a href="#secret-store-options">Secret Store options</a></td></tr><tr><td><strong>Server CA</strong></td><td>Optional</td><td>Server CA, which is available under the <strong>Show Credentials</strong> link just to the right of the endpoint in the <a href="https://console.cloud.google.com/kubernetes">Google Cloud Platform console</a></td></tr><tr><td><strong>Service Account Key</strong></td><td>Required</td><td>Service account key in JSON format; you can generate this key in the <a href="https://console.developers.google.com/apis/credentials">Google Developers Console</a>; ensure it is associated with a user having the appropriate level of access to the cluster for your use case; once generated, upload the key using the button below the <strong>Service Account Key</strong> box</td></tr><tr><td><strong>Healthcheck Namespace</strong></td><td>Optional</td><td>If enabled for your organization, the namespace used for the resource healthcheck; defaults to <code>default</code> if empty; supplied credentials must have the rights to perform one of the following kubectl commands in the specified namespace: <code>get pods</code>, <code>get deployments</code>, or <code>describe namespace</code></td></tr><tr><td><strong>Enable Resource Discovery</strong></td><td>Optional</td><td>Enables <a href="../kubernetes-management#resource-discovery">automatic discovery</a> within this cluster</td></tr><tr><td><strong>Authentication</strong></td><td>Required</td><td>Authentication method to access the cluster; select either <strong>Leased Credential</strong> (default) or <strong>Identity Aliases</strong> (to use the Identity Aliases of StrongDM users to access the cluster)</td></tr><tr><td><strong>Identity Set</strong></td><td>Required</td><td>Displays if <strong>Authentication</strong> is set to <strong>Identity Aliases</strong>; select an Identity Set name from the list</td></tr><tr><td><strong>Healthcheck Username</strong></td><td>Required</td><td>If <strong>Authentication</strong> is set to <strong>Identity Aliases</strong>, the username that should be used to verify StrongDM's connection to it; username must already exist on the target cluster</td></tr><tr><td><strong>Resource Tags</strong></td><td>Optional</td><td>Resource <a data-mention href="https://app.gitbook.com/s/4XOJmXFslCMVCzIG2rKp/cli/tags">Tags</a> consisting of key-value pairs <code>&#x3C;KEY>=&#x3C;VALUE></code> (for example, <code>env=dev</code>)</td></tr></tbody></table>

### **Display name**

Some Kubernetes management interfaces, such as Visual Studio Code, do not function properly with cluster names containing spaces. If you run into problems, please choose a **Display Name** without spaces.

### **Google credentials**

When your users connect to this cluster, they have exactly the rights permitted by this Google Service Account key. See [this Google document](https://cloud.google.com/kubernetes-engine/docs/tutorials/authenticating-to-cloud-platform) for more information.

### **Secret Store options**

By default, server credentials are stored in StrongDM. However, these credentials can also be saved in a secrets management tool.

Non-StrongDM options appear in the **Secret Store** dropdown menu if they are created under **Settings** > **Secrets Management**. When you select another Secret Store type, its unique properties display. For more details, see [Configure Secret Store Integrations](https://docs.strongdm.com/admin/access/secret-stores).

## Test the Connection

1. After creating the GKE cluster resource in the Admin UI, navigate to **Infrastructure > Clusters** and locate your newly added cluster. The health indicator should turn green once connectivity and credentials are validated.
2. On a test client using the StrongDM desktop app or CLI, connect to the cluster and run a basic command such as `kubectl get nodes`. Confirm the output returns your nodes and the connection is routed via StrongDM.
3. If discovery is enabled, in the Admin UI verify that namespaces, roles, and service accounts appear under the cluster’s **Discovery** tab. This confirms StrongDM successfully queried the Kubernetes API and retrieved metadata from your GKE cluster.
4. If the health status remains red or yellow:
   * Verify the cluster’s endpoint, region, and service account permissions are correct and reachable from your relay or gateway.
   * Check the certificate authority file and ensure the GKE control plane endpoint uses valid TLS configuration.
   * Confirm the `healthcheck_namespace` exists and that the identity alias healthcheck user (if specified) has appropriate access.
   * Review the **Diagnostics** tab in the Admin UI for authentication or network-related errors.

Once connectivity is verified and Kubernetes operations succeed, the GKE cluster resource is ready. You can assign roles, apply access policies, and monitor all cluster activity through StrongDM.

## Help

If you encounter issues, please consult the [StrongDM Help Center](https://help.strongdm.com/hc/en-us).

Be prepared to provide the following information to StrongDM Support, so that they can inspect logs and confirm node and resource health:

* Resource name or ID
* CLI error output or logs
* Node name and region
* Timestamps of failed attempts