update-cluster¶

Description¶

Updates compute cluster.

Synopsis¶

  update-cluster
--cluster-crn <value>
--spec <value>
--cluster-state-version <value>
[--metadata <value>]
[--skip-validation | --no-skip-validation]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-crn (string)

Compute Cluster CRN.

--spec (object)

Compute cluster update spec.

deployments -> (object)

Update cluster deployments structure.

autoscaler -> (object)

Autoscaler request structure.

scaleDownDelayAfterAdd -> (string)

How long after scale up that scale down evaluation resumes. (Azure/AWS Support).

scaleDownDelayAfterDelete -> (string)

How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support).

scaleDownDelayAfterFailure -> (string)

How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support).

scaleDownEnabled -> (boolean)

Scale down flag. (AWS Support).

scaleDownNonEmptyCandidatesCount -> (integer)

Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support).

scaleDownUnneededTime -> (string)

How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support).

scaleDownUtilizationThreshold -> (double)

Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support).

scanInterval -> (string)

Scan interval. (Azure/AWS Support).

skipNodesWithLocalStorage -> (boolean)

Skip nodes with local storage flag. (AWS Support).

skipNodesWithSystemPods -> (boolean)

Skip nodes with system pods. (AWS Support).

maxGracefulTerminationSec -> (integer)

Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support).

scaleDownUnreadyTime -> (string)

How long an unready node should be unneeded before it is eligible for scale down. (Azure Support).

helm -> (object)

Helm structure.

version -> (string)

Helm version to be upgraded to.

security -> (object)

Security request structure.

apiServer -> (object)

API server request structure.

authorizedIpRanges -> (array)

An array of IPv4 CIDR blocks.

item -> (string)

enabled -> (boolean)

Flag to enable whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server.

secretEncryption -> (object)

Secret encryption request structure.

customerKmsKeyArn -> (string)

AWS KMS key ARN.

azure -> (object)

Azure Secret Encryption request structure.

encryptionKeyUrl -> (string)

Encryption key URI.

userManagedIdentity -> (string)

Resource ID of the user managed identity.

volumeEncryption -> (object)

Volume encryption request structure.

customerKmsKeyArn -> (string)

The KMS key ARN used.

azure -> (object)

Azure Volume Encryption request structure.

diskEncryptionSetId -> (string)

Disk encryption set ID.

private -> (boolean)

Flag set to true for a private cluster with API Server having internal IP addressees.

storage -> (object)

Storage spec request structure.

csiEnabled -> (boolean)

Flag to enable Container Storage Interface (CSI). It further sets specific inline cloud formation policies required for CSI.

imageCatalog -> (object)

Image catalog request structure.

crn -> (string)

The catalog CRN (either CRN or name is required).

name -> (string)

The catalog name (either CRN or name is required).

refreshInstanceGroups -> (boolean)

Whether to refresh nodes of instance groups belonging to the compute cluster.

JSON Syntax:

{
  "deployments": {
    "autoscaler": {
      "scaleDownDelayAfterAdd": "string",
      "scaleDownDelayAfterDelete": "string",
      "scaleDownDelayAfterFailure": "string",
      "scaleDownEnabled": true|false,
      "scaleDownNonEmptyCandidatesCount": integer,
      "scaleDownUnneededTime": "string",
      "scaleDownUtilizationThreshold": double,
      "scanInterval": "string",
      "skipNodesWithLocalStorage": true|false,
      "skipNodesWithSystemPods": true|false,
      "maxGracefulTerminationSec": integer,
      "scaleDownUnreadyTime": "string"
    }
  },
  "helm": {
    "version": "string"
  },
  "security": {
    "apiServer": {
      "authorizedIpRanges": ["string", ...],
      "enabled": true|false
    },
    "secretEncryption": {
      "customerKmsKeyArn": "string",
      "azure": {
        "encryptionKeyUrl": "string",
        "userManagedIdentity": "string"
      }
    },
    "volumeEncryption": {
      "customerKmsKeyArn": "string",
      "azure": {
        "diskEncryptionSetId": "string"
      }
    },
    "private": true|false
  },
  "storage": {
    "csiEnabled": true|false
  },
  "imageCatalog": {
    "crn": "string",
    "name": "string"
  },
  "refreshInstanceGroups": true|false
}

--cluster-state-version (integer)

Current cluster state version of the compute cluster being updated.

--metadata (object)

Update cluster metadata structure.

description -> (string)

Description of compute cluster update.

Shorthand Syntax:

description=string

JSON Syntax:

{
  "description": "string"
}

--skip-validation | --no-skip-validation (boolean)

Whether to skip validation.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

clusterCrn -> (string)

Compute cluster CRN.

clusterStatus -> (object)

Cluster status structure.

message -> (string)

Message.

status -> (string)

Status.

uri -> (string)

Uniform resource identifier of the compute cluster.

validationResponse -> (object)

Pre-flight validation check response structure.

Form Factors: public

result -> (string)

Validation result.

summary -> (object)

Validation summary structure.

Form Factors: public

passed -> (integer)

Total number of passed validations.

warning -> (integer)

Total number of validations that passed but have warnings associated with them.

failed -> (integer)

Total number of failed validations.

skipped -> (integer)

Total number of skipped validations.

total -> (integer)

Total number of validations.

message -> (string)

A message describing end result of the validations.

validations -> (array)

The list of detailed validation result.

item -> (object)

Validation result structure.

Form Factors: public

name -> (string)

Name.

description -> (string)

Description.

category -> (string)

Validation check categories such as COMMON, ENTITLEMENTS, CONTROL_PLANE, NETWORK, or DEPLOYMENT. New values may be added in the future.

status -> (string)

Validation check status such as PASSED, FAILED, or SKIPPED. New values may be added in the future.

message -> (string)

A short, human-readable message that describes the end result of the validation.

detailedMessage -> (string)

A supporting message which contains additional details, such as subnet names, instance types, etc.

duration -> (string)

Time taken to get the end result of the validation in a human-readable time format.

Form Factors¶

public