create-gcp-datalake¶

Description¶

Creates an GCP Data Lake.

Synopsis¶

  create-gcp-datalake
--datalake-name <value>
--environment-name <value>
--cloud-provider-configuration <value>
[--tags <value>]
[--scale <value>]
[--runtime <value>]
[--image <value>]
[--enable-ranger-raz | --no-enable-ranger-raz]
[--recipes <value>]
[--custom-instance-groups <value>]
[--java-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datalake-name (string)

The datalake name. This name must be unique, must have between 5 and 40 characters, and must contain only lowercase letters, numbers and hyphens. Names are case-sensitive.

--environment-name (string)

The environment name or CRN.

--cloud-provider-configuration (object)

Request object for GCP configuration.

serviceAccountEmail -> (string)

Email id of the service account to be associated with the datalake IdBroker instance. This service account should have “token.creator” role for one or more storage accounts that has access to storage.

storageLocation -> (string)

The location of the GCS bucket to be used as storage. The location has to start with gs:// followed by the bucket name.

Shorthand Syntax:

serviceAccountEmail=string,storageLocation=string

JSON Syntax:

{
  "serviceAccountEmail": "string",
  "storageLocation": "string"
}

--tags (array)

Tags that can be attached to GCP Data Lake resources. Please refer to Google documentation for the rules https://cloud.google.com/compute/docs/labeling-resources#label_format.

Shorthand Syntax:

key=string,value=string ... (separate items with spaces)

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--scale (string)

Represents the available datalake scales. Defaults to LIGHT_DUTY if not set.

Possible values:

• LIGHT_DUTY

• MEDIUM_DUTY_HA

• ENTERPRISE

--runtime (string)

Cloudera Runtime version.

--image (object)

The image request for the datalake. When the ‘runtime’ parameter is set, only the ‘os’ parameter can be provided. Otherwise, you can use ‘catalog name’ and/or ‘id’ for selecting an image.

id -> (string)

The image ID from the catalog. The corresponding image will be used for the created cluster machines.

catalogName -> (string)

The name of the custom image catalog to use, defaulting to ‘cdp-default’ if not present.

os -> (string)

The OS of the image used for cluster instances.

Shorthand Syntax:

id=string,catalogName=string,os=string

JSON Syntax:

{
  "id": "string",
  "catalogName": "string",
  "os": "string"
}

--enable-ranger-raz | --no-enable-ranger-raz (boolean)

Whether to enable Ranger RAZ for the datalake. Defaults to not being enabled.

--recipes (array)

Additional recipes that will be attached on the datalake instances (by instance groups, most common ones are like ‘master’ or ‘idbroker’).

Shorthand Syntax:

instanceGroupName=string,recipeNames=string,string ... (separate items with spaces)

JSON Syntax:

[
  {
    "instanceGroupName": "string",
    "recipeNames": ["string", ...]
  }
  ...
]

--custom-instance-groups (array)

Configure custom properties on an instance group level.

Shorthand Syntax:

name=string,instanceType=string ... (separate items with spaces)

JSON Syntax:

[
  {
    "name": "string",
    "instanceType": "string"
  }
  ...
]

--java-version (integer)

Configure the major version of Java on the cluster.

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

datalake -> (object)

Information about a datalake.

datalakeName -> (string)

The name of the datalake.

crn -> (string)

The CRN of the datalake.

status -> (string)

The status of the datalake.

environmentCrn -> (string)

The CRN of the environment.

creationDate -> (datetime)

The date when the datalake was created.

statusReason -> (string)

The reason for the status of the datalake.

enableRangerRaz -> (boolean)

Whether Ranger RAZ is enabled for the datalake.

certificateExpirationState -> (string)

Indicates the certificate status on the cluster.

multiAz -> (boolean)

Flag which marks that the datalake is deployed in a multi-availability zone way or not.

tags -> (array)

Datalake tags object containing the tag values defined for the datalake.

item -> (object)

Tag for a datalake resource.

key -> (string)

The key of tag.

value -> (string)

The value of the tag.

Form Factors¶

public