cluster_user

Creates, updates, deletes, gets or lists a cluster_user resource.

Overview

Name	cluster_user
Type	Resource
Id	digitalocean.kubernetes.cluster_user

Fields

The following fields are returned by SELECT queries:

kubernetes_get_cluster_user

The response will be a JSON object with a key called kubernetes_cluster_user
containing the username and in-cluster groups that it belongs to.

Name	Datatype	Description
groups	array	A list of in-cluster groups that the user belongs to.
username	string (email)	The username for the cluster admin user. (example: sammy@digitalocean.com)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
kubernetes_get_cluster_user	select	cluster_id		To show information the user associated with a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_id	string (uuid)	A unique ID that can be used to reference a Kubernetes cluster. (example: bd5f5959-5e1e-4205-a714-a914373942af)

SELECT examples

kubernetes_get_cluster_user

To show information the user associated with a Kubernetes cluster, send a GET
request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/user.

SELECT
groups,
username
FROM digitalocean.kubernetes.cluster_user
WHERE cluster_id = '{{ cluster_id }}' -- required;