validate-cluster¶

Description¶

Validates compute cluster.

Synopsis¶

  validate-cluster
--environment <value>
--name <value>
[--description <value>]
[--tags <value>]
[--network <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment (string)

Environment CRN. Required.

--name (string)

Cluster name. Required.

--description (string)

Cluster description.

--tags (map)

Cluster level tags.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--network (object)

Network structure.

subnets -> (array)

Subnets.

item -> (string)

podCidr -> (string)

The pod CIDR to use if the backend provider supports setting this.

serviceCidr -> (string)

The CIDR for services declared inside of Kubernetes if the backend provider supports setting this.

outboundType -> (string)

Cluster outbound type. Currently supported is udr.

Shorthand Syntax:

subnets=string,string,podCidr=string,serviceCidr=string,outboundType=string

JSON Syntax:

{
  "subnets": ["string", ...],
  "podCidr": "string",
  "serviceCidr": "string",
  "outboundType": "string"
}

Form Factors: public

--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¶

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 the end result of the validations.

validations -> (array)

The list of detailed validation results.

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