create-cluster-definition¶
- subtitle
Creates a cluster definition. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.
- version
0.9.125
Description¶
Creates a cluster definition. A cluster definition is a reusable template in JSON format that can be used for creating multiple Data Hub clusters with identical cloud provider settings.
Synopsis¶
create-cluster-definition
--cluster-definition-name <value>
--workload-template <value>
[--description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--cluster-definition-name
(string)
The name of the cluster definition. This name must be unique, must have between 5 and 100 characters, and must contain only lowercase letters, numbers and hyphens. Names are case-sensitive.
--workload-template
(string)
The cluster creation JSON. This must contain the name of a running environment.
--description
(string)
The description of the cluster definition. The description can have a maximum of 1000 characters.
--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¶
clusterDefinition -> (object)
Information about a cluster definition.
clusterDefinitionName -> (string)
The name of the cluster definition.
crn -> (string)
The CRN of the cluster definition.
type -> (string)
The type of cluster definition.
workloadTemplate -> (string)
The workload template.
cloudPlatform -> (string)
The cloud platform.
environmentCrn -> (string)
The CRN of the environment.
description -> (string)
The description of the cluster definition.
Form Factors¶
public