create-azure-cluster¶

Description¶

Create an Azure cluster in the Cloudera Data Warehouse environment with the provided settings.

Synopsis¶

  create-azure-cluster
--environment-crn <value>
--user-assigned-managed-identity <value>
--subnet-name <value>
[--use-overlay-networking | --no-use-overlay-networking]
[--database-backup-retention-period <value>]
[--whitelist-k8s-cluster-access-ip-cidrs <value>]
[--whitelist-workload-access-ip-cidrs <value>]
[--use-internal-load-balancer | --no-use-internal-load-balancer]
[--reserved-compute-nodes <value>]
[--reserved-shared-services-nodes <value>]
[--custom-registry-options <value>]
[--custom-subdomain <value>]
[--enable-az | --no-enable-az]
[--enable-spot-instances | --no-enable-spot-instances]
[--compute-instance-types <value>]
[--log-analytics-workspace-id <value>]
[--outbound-type <value>]
[--enable-private-sql | --no-enable-private-sql]
[--private-dns-zone-aks <value>]
[--enable-private-aks | --no-enable-private-aks]
[--aks-vnet-integration-subnet-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of the environment for the cluster to create.

--user-assigned-managed-identity (string)

Resource ID of the managed identity used by AKS. It is a mandatory parameter for Azure cluster creation.

--subnet-name (string)

Name of Azure subnet where the cluster should be deployed. It is a mandatory parameter for Azure cluster creation.

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

With overlay network nodes get an IP address from the Azure virtual network subnet. Pods receive an IP address from a logically different address space to the Azure virtual network subnet of the nodes.

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

PostgreSQL server backup retention days.

--whitelist-k8s-cluster-access-ip-cidrs (array)

List of IP address CIDRs to whitelist for kubernetes cluster access.

Syntax:

"string" "string" ...

--whitelist-workload-access-ip-cidrs (array)

List of IP address CIDRs to whitelist for workload access.

Syntax:

"string" "string" ...

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

Set up load balancer with private IP address. An internal load balancer gets created. Make sure there is connectivity between your client network and the network VNet where CDW environment is deployed.

--reserved-compute-nodes (integer)

Set additional number of nodes to reserve for executors and coordinators to use during autoscaling. Adding more reserved nodes increases your cloud costs.

--reserved-shared-services-nodes (integer)

Set additional number of nodes to reserve for other services in the cluster. Adding more reserved nodes increases your cloud costs.

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

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

--enable-az | --no-enable-az (boolean)

Enables Azure Availability Zones for the cluster deployment.

--enable-spot-instances | --no-enable-spot-instances (boolean)

Whether to enable spot instances for Virtual warehouses. It cannot be updated later. Defaults to false.

--compute-instance-types (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.

Syntax:

"string" "string" ...

--log-analytics-workspace-id (string)

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

--outbound-type (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

Possible values:

• LoadBalancer

• UserAssignedNATGateway

• UserDefinedRouting

--enable-private-sql | --no-enable-private-sql (boolean)

Enables private SQL for the cluster deployment.

--private-dns-zone-aks (string)

Private DNS zone AKS resource ID.

--enable-private-aks | --no-enable-private-aks (boolean)

Enable Azure Private AKS mode.

--aks-vnet-integration-subnet-name (string)

Enable AKS VNet Azure Virtual Network (VNet) integration by specifying the delegated subnet name. An Azure Kubernetes Service (AKS) cluster configured with API Server VNet Integration projects the API server endpoint directly into a delegated subnet in the VNet where AKS is deployed. API Server VNet Integration enables network communication between the API server and the cluster nodes without requiring a private link or tunnel.

--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 Azure cluster.

Form Factors¶

public, private