Update an SKS cluster

PUT /sks-cluster/{id}

Path parameters

id string(uuid) Required

application/json

Body Required

description string | null

Cluster description

Maximum length is 255.
labels object
Hide labels attribute Show labels attribute object
- * string Additional properties
auto-upgrade boolean

Enable auto upgrade of the control plane to the latest patch version available
oidc object

SKS Cluster OpenID config map
Hide oidc attributes Show oidc attributes object
- client-id string Required
  
  OpenID client ID
  
  Minimum length is 1, maximum length is 255.
- issuer-url string Required
  
  OpenID provider URL
  
  Minimum length is 1, maximum length is 255.
- username-claim string
  
  JWT claim to use as the user name
  
  Minimum length is 1, maximum length is 255.
- username-prefix string
  
  Prefix prepended to username claims
  
  Minimum length is 1, maximum length is 255.
- groups-claim string
  
  JWT claim to use as the user's group
  
  Minimum length is 1, maximum length is 255.
- groups-prefix string
  
  Prefix prepended to group claims
  
  Minimum length is 1, maximum length is 255.
- required-claim object
  
  A key value map that describes a required claim in the ID Token
  Hide required-claim attribute Show required-claim attribute object
  
  * string Additional properties
name string

Cluster name

Minimum length is 1, maximum length is 255.
enable-operators-ca boolean

Add or remove the operators certificate authority (CA) from the list of trusted CAs of the api server. The default value is true
feature-gates array[string] | null

A list of Kubernetes-only Alpha features to enable for API server component
addons array[string]

Cluster addons

Values are exoscale-cloud-controller, exoscale-container-storage-interface, or metrics-server.
audit object

Kubernetes Audit parameters
Hide audit attributes Show audit attributes object
- endpoint string
  
  Minimum length is 1, maximum length is 2000.
- bearer-token string
  
  Minimum length is 1, maximum length is 2000.
- initial-backoff string
  
  Minimum length is 1, maximum length is 10.
- enabled boolean
  
  Enable or Disable Kubernetes Audit

Responses

200 application/json

200
Hide response attributes Show response attributes object
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

PUT /sks-cluster/{id}

curl \
 --request PUT 'https://api-ch-gva-2.exoscale.com/v2/sks-cluster/{id}' \
 --header "Content-Type: application/json" \
 --data '{"description":"string","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"auto-upgrade":true,"oidc":{"client-id":"string","issuer-url":"string","username-claim":"string","username-prefix":"string","groups-claim":"string","groups-prefix":"string","required-claim":{"additionalProperty1":"string","additionalProperty2":"string"}},"name":"string","enable-operators-ca":true,"feature-gates":["string"],"addons":["exoscale-cloud-controller"],"audit":{"endpoint":"string","bearer-token":"string","initial-backoff":"string","enabled":true}}'

Request examples

{
  "description": "string",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "auto-upgrade": true,
  "oidc": {
    "client-id": "string",
    "issuer-url": "string",
    "username-claim": "string",
    "username-prefix": "string",
    "groups-claim": "string",
    "groups-prefix": "string",
    "required-claim": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "name": "string",
  "enable-operators-ca": true,
  "feature-gates": [
    "string"
  ],
  "addons": [
    "exoscale-cloud-controller"
  ],
  "audit": {
    "endpoint": "string",
    "bearer-token": "string",
    "initial-backoff": "string",
    "enabled": true
  }
}

Response examples (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}