v1

latestSwagger 2.02026-08-04232286653.5 KB

Kubernetes Clusters

Returns details for a single Kubernetes cluster in the project.

get/projects/{project_id}/kubernetes/clusters/{cluster_id}

Path parameters

project_idstring required

ID of the project that owns the cluster.

cluster_idstring required

ID of the cluster.

Response

add_onsstring[] required

Add-ons associated with the cluster.

apiserver_extra_argsobject

Extra arguments passed to the kube-apiserver control plane component.

cluster_cidrstring

Range of IP addresses allocated to pods scheduled on worker nodes, in CIDR notation.

configuration'ha' required

Configuration setting of the Kubernetes cluster.

controller_manager_extra_argsobject

Extra arguments passed to the kube-controller-manager control plane component.

created_atstring required

Creation timestamp of the cluster, in RFC3339 format.

dns_namestring required

DNS name of the cluster.

idstring required

ID of the Kubernetes cluster.

kubelogin_argsobject required

Arguments for the kubectl oidc-login plugin.

locationstring required

Location of the Kubernetes cluster.

namestring required

Name of the Kubernetes cluster.

node_cidr_mask_sizeinteger

Mask size for the cluster CIDR.

node_poolsstring[] required

IDs of the node pools within the Kubernetes cluster.

privateboolean

Whether the cluster is private (without a public IP).

project_idstring required

ID of the project that owns the Kubernetes cluster.

scheduler_extra_argsobject

Extra arguments passed to the kube-scheduler control plane component.

service_cluster_ip_rangestring

Range of IP addresses allocated to Kubernetes services, in CIDR notation.

statestring required

Current state of the cluster.

subnet_idstring required

ID of the subnet the Kubernetes cluster belongs to.

updated_atstring required

Last update timestamp of the cluster, in RFC3339 format.

versionstring required

Version of the Crusoe Kubernetes image the cluster runs.

Example response

{
  "add_ons": [
    "crusoe_csi"
  ],
  "apiserver_extra_args": {
    "audit-log-maxage": "30"
  },
  "auth_config": {
    "oidc": {
      "client_id": "kubernetes",
      "groups_claim": "groups",
      "issuer_url": "https://oauth2.example.com",
      "username_claim": "email",
      "username_prefix": "oidc:"
    }
  },
  "cluster_cidr": "10.233.0.0/18",
  "configuration": "ha",
  "controller_manager_extra_args": {
    "bind-address": "0.0.0.0"
  },
  "created_at": "2021-12-03T19:58:34Z",
  "dns_name": "my-kubernetes-cluster.crusoecloudcompute.com",
  "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  "kubelogin_args": {
    "force-refresh": "",
    "oidc-extra-scope": "email groups"
  },
  "location": "us-northcentral1-a",
  "name": "my-kubernetes-cluster",
  "node_cidr_mask_size": 24,
  "node_pools": [
    "1d2b3a4c-5e6f-7b9d-8c9a-0e1f2d3b4c5d"
  ],
  "private": true,
  "project_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
  "scheduler_extra_args": {
    "bind-address": "0.0.0.0"
  },
  "service_cluster_ip_range": "10.233.0.0/18",
  "state": "STATE_RUNNING",
  "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  "updated_at": "2021-12-03T19:58:34Z",
  "version": "1.29.5-crusoe.0"
}