create-cluster

subtitle

Create a Cloudera Data Warehouse cluster.

version

0.9.79

Description

Create a Cloudera Data Warehouse cluster.

Synopsis

  create-cluster
--environment-crn <value>
[--use-overlay-network | --no-use-overlay-network]
[--database-backup-retention-period <value>]
[--whitelist-ip-cidrs <value>]
[--use-private-load-balancer | --no-use-private-load-balancer]
[--enable-storage-roles | --no-enable-storage-roles]
[--custom-registry-options <value>]
[--aws-options <value>]
[--azure-options <value>]
[--private-cloud-options <value>]
[--custom-id <value>]
[--custom-subdomain <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--environment-crn (string)

The CRN of the environment for the cluster to create.

--use-overlay-network | --no-use-overlay-network (boolean)

Using an overlay network will save IP addresses in the VPC by using a private IP address range for Pods in the cluster.

--database-backup-retention-period (integer)

PostgreSQL server backup retention days.

--whitelist-ip-cidrs (string)

Comma separated list of IP address CIDRs to whitelist.

--use-private-load-balancer | --no-use-private-load-balancer (boolean)

Set up load balancer with private IP address. In AWS it is created in private subnets. In Azure an internal load balancer gets created. Make sure there is connectivity between your client network and the network (VPC/VNet) where CDW environment is deployed.

--enable-storage-roles | --no-enable-storage-roles (boolean)

Enable Storage Roles

Form Factors: public

--custom-registry-options (object)

Options for custom ACR, ECR, or Docker registry.

registryType -> (string)

Custom registry type.

repositoryUrl -> (string)

URL of the custom image repository.

userName -> (string)

Username for custom registry access (required only for Docker type).

password -> (string)

Password for custom registry access (required only for Docker type).

disableImageVerification -> (boolean)

Disable image verification.

Shorthand Syntax:

registryType=string,repositoryUrl=string,userName=string,password=string,disableImageVerification=boolean

JSON Syntax:

{
  "registryType": "ACR"|"ECR"|"Docker",
  "repositoryUrl": "string",
  "userName": "string",
  "password": "string",
  "disableImageVerification": true|false
}

--aws-options (object)

Options for activating an AWS environment.

privateSubnetIds -> (array)

IDs of private AWS subnets where the cluster should be deployed.

item -> (string)

publicSubnetIds -> (array)

IDs of public AWS subnets where the cluster should be deployed.

item -> (string)

customAmiId -> (string)

Custom AMI ID.

nodeRoleCDWManagedPolicyArn -> (string)

Managed Policy Arn to be attached to the Node Instance Role.

enableSpotInstances -> (boolean)

Whether to enable Spot instances for Virtual warehouses. It cannot be updated later. If the aws-options is not provided it defaults to false.

reducedPermissionMode -> (boolean)

Use this option to activate the environment with fewer than half of the standard required IAM permissions on your AWS cross-account IAM role.

computeInstanceTypes -> (array)

AWS compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values.

item -> (string)

additionalInstanceTypes -> (array)

Additional (fallback) instance types listed in their priority order. They will be used instead of the primary compute instance type in case it is unavailable. You cannot include any instance type that was already indicated in computeInstanceTypes. Use describe-allowed-instance-types to see currently supported values and also the default value when nothing is provided for the computeInstanceTypes.

item -> (string)

Shorthand Syntax:

privateSubnetIds=string,string,publicSubnetIds=string,string,customAmiId=string,nodeRoleCDWManagedPolicyArn=string,enableSpotInstances=boolean,reducedPermissionMode=boolean,computeInstanceTypes=string,string,additionalInstanceTypes=string,string

JSON Syntax:

{
  "privateSubnetIds": ["string", ...],
  "publicSubnetIds": ["string", ...],
  "customAmiId": "string",
  "nodeRoleCDWManagedPolicyArn": "string",
  "enableSpotInstances": true|false,
  "reducedPermissionMode": true|false,
  "computeInstanceTypes": ["string", ...],
  "additionalInstanceTypes": ["string", ...]
}

--azure-options (object)

Options for activating an Azure environment.

subnetId -> (string)

ID of Azure subnet where the cluster should be deployed.

enableAZ -> (boolean)

Enables Azure Availability Zones for the cluster deployment.

enableSpotInstances -> (boolean)

Whether to enable spot instances for Virtual warehouses. It cannot be updated later. If the AzureActivationOptions is not provided it defaults to false.

vmGenerationType -> (string)

DEPRECATED in favour of compute-instance-types. The generation type of the virtual machines used to create the environment.

computeInstanceTypes -> (array)

Azure compute instance types that the environment is restricted to use. This affects the creation of virtual warehouses where this restriction will apply. Select an instance type that meets your computing, memory, networking, or storage needs. As of now, only a single instance type can be listed. Use describe-allowed-instance-types to see currently possible values and the default value used for the case it is not provided.

item -> (string)

logAnalyticsWorkspaceId -> (string)

Enable monitoring of Azure Kubernetes Service (AKS) cluster. Workspace ID for Azure log analytics.

dockerBridgeCidr -> (string)

Docker bridge CIDR range for deployment.

outboundType -> (string)

Network outbound type. This setting controls the egress traffic for cluster nodes in Azure Kubernetes Service. Please refer to the following AKS documentation on the Azure portal. https://learn.microsoft.com/en-us/azure/aks/egress-outboundtype, https://learn.microsoft.com/en-us/azure/aks/nat-gateway

enablePrivateSQL -> (boolean)

Enables private SQL for the cluster deployment.

privateDNSZoneAKS -> (string)

Private DNS zone AKS resource ID.

enablePrivateAks -> (boolean)

Enable Azure Private AKS mode.

enableUptimeSLA -> (boolean)

Enable uptime SLA for Kubernetes API server.

Shorthand Syntax:

subnetId=string,enableAZ=boolean,enableSpotInstances=boolean,vmGenerationType=string,computeInstanceTypes=string,string,logAnalyticsWorkspaceId=string,dockerBridgeCidr=string,outboundType=string,enablePrivateSQL=boolean,privateDNSZoneAKS=string,enablePrivateAks=boolean,enableUptimeSLA=boolean

JSON Syntax:

{
  "subnetId": "string",
  "enableAZ": true|false,
  "enableSpotInstances": true|false,
  "vmGenerationType": "Standard_E16_v3"|"Standard_E16ds_v4"|"Standard_E16ads_v5",
  "computeInstanceTypes": ["string", ...],
  "logAnalyticsWorkspaceId": "string",
  "dockerBridgeCidr": "string",
  "outboundType": "LoadBalancer"|"UserAssignedNATGateway"|"UserDefinedRouting",
  "enablePrivateSQL": true|false,
  "privateDNSZoneAKS": "string",
  "enablePrivateAks": true|false,
  "enableUptimeSLA": true|false
}

--private-cloud-options (object)

Options for activating a Private Cloud environment.

delegationUsername -> (string)

Name of delegation user. This user is used between Hue - Impala to create a session, as Hue should not pass the user credentials, instead Hue authenticates with the delegation user, then this user will impersonate the logged in user. This means that the Delegation User and Password should be able to authenticate through LDAP.

delegationPassword -> (string)

Password of delegation user.

securityContextConstraintName -> (string)

The name of the Hive Security Context Constraint.

storageClass -> (string)

The storage class for the Local Storage Operator.

dbDas -> (string)

The name of the DAS database. Not required for embedded databases

dbHue -> (string)

The name of the HUE database. Not required for embedded databases.

Shorthand Syntax:

delegationUsername=string,delegationPassword=string,securityContextConstraintName=string,storageClass=string,dbDas=string,dbHue=string

JSON Syntax:

{
  "delegationUsername": "string",
  "delegationPassword": "string",
  "securityContextConstraintName": "string",
  "storageClass": "string",
  "dbDas": "string",
  "dbHue": "string"
}

--custom-id (string)

Custom environment ID provided to the cluster

--custom-subdomain (string)

Custom environment subdomain. Overrides the environment subdomain using a customized domain either in the old subdomain format like ENV_ID.dw or the new format like dw-ENV_NAME.

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

clusterId -> (string)

ID of new cluster.

Form Factors

public, private