Cloudbreak CLI Reference
Also available as:
PDF

cluster generate-template

Generates a provider-specific cluster template in JSON format.

Sub-commands

aws new-network Generates an AWS cluster JSON template with new network

aws existing-network Generates an AWS cluster JSON template with existing network

aws existing-subnet Generates an AWS cluster JSON template with existing network and subnet

azure new-network Generates an Azure cluster JSON template with new network

azure existing-subnet Generates an Azure cluster JSON template with existing network and subnet

gcp new-network Generates an GCP cluster JSON template with new network

gcp existing-network Generates an GCP cluster JSON template with existing network

gcp existing-subnet Generates an GCP cluster JSON template with existing network and subnet

gcp shared-network Generates an GCP cluster JSON template with shared network and subnet

gcp legacy-network Generates an GCP cluster JSON template with legacy network without subnets

openstack new-network Generates an OS cluster JSON template with new network

openstack existing-network Generates an OS cluster JSON template with existing network

openstack existing-subnet Generates an OS cluster JSON template with existing network and subnet

Required options

None

Options

--blueprint-name <value> Name of the blueprint

--blueprint-file <value> Location of the blueprint file

--cloud-storage <value> Type of the cloud storage [wasb/WASB, adls/ADLS, s3/S3, gcs/GCS]

--with-custom-domain Adds custom domain configuration to the template

--with-tags Adds user-defined tags configuration to the template

--with-image Adds image-catalog configuration to the template

--with-kerberos-managed Adds Cloudbreak-managed Kerberos configuration to the template

--with-kerberos-mit Adds existing MIT Kerberos configuration to the template

--with-kerberos-ad Adds existing Active Directory Kerberos configuration to the template

--with-kerberos-custom Adds custom Kerberos configuration to the template

--server [$VALUE] Cloudbreak server address [$CB_SERVER_ADDRESS]

--username [$VALUE] Cloudbreak user name (e-mail address) [$CB_USER_NAME]

--password [$VALUE] Cloudbreak password [$CB_PASSWORD]

--workspace [$VALUE] Name of the workspace holding the resource

--profile [$VALUE] Selects a config profile to use [$CB_PROFILE]

--auth-type [$VALUE] Authentication method to use. Values: oauth2, basic [$CB_AUTH_TYPE]

Options for AWS only:

--with-default-encryption Default encryption for AWS instances which can use a default key

--with-custom-encryption Custom key encryption for AWS instances which can use your custom key

Options for Azure only:

N/A

Options: GCP only:

--with-raw-encryption Custom encryption for GCP instances which can use your raw key

--with-rsa-encryption Custom key encryption for GCP instances which can use your rsa key

--with-kms-encryption Custom key encryption for GCP instances which can use your kms key

Options for OpenStack only:

N/A

Parameters

Template parameters to fill in the generated template:

  • userName: Name of the Ambari user
  • password: Password of the Ambari user
  • name: Name of the cluster
  • region: Region of the cluster
  • availabilityZone: Availability zone of the cluster, on AZURE it is the same as the region
  • blueprintName: Name of the selected blueprint
  • credentialName: Name of the selected credential
  • instanceGroups.group: Name of the instance group
  • instanceGroups.nodeCount: Number of nodes in the group
  • instanceGroups.template.instanceType: Name of the selected template
  • instanceGroups.template.volumeCount: Number of volumes
  • instanceGroups.template.volumeSize: Size of Volumes in GB
  • stackAuthentication.publicKey: Public key

Examples

Generates a cluster template for AWS where a new network is created for the cluster:

cb cluster generate-template aws new-network