create-workspace¶

Description¶

Provision a Kubernetes cluster and install the Cloudera AI application in it.

Synopsis¶

  create-workspace
--environment-name <value>
--workspace-name <value>
[--provision-k8s-request <value>]
[--use-public-load-balancer | --no-use-public-load-balancer]
[--disable-tls | --no-disable-tls]
[--enable-monitoring | --no-enable-monitoring]
[--enable-governance | --no-enable-governance]
[--existing-nfs <value>]
[--load-balancer-ip-whitelists <value>]
[--nfs-version <value>]
[--ml-version <value>]
[--enable-model-metrics | --no-enable-model-metrics]
[--existing-database-config <value>]
[--whitelist-authorized-ip-ranges | --no-whitelist-authorized-ip-ranges]
[--authorized-ip-ranges <value>]
[--skip-validation | --no-skip-validation]
[--private-cluster | --no-private-cluster]
[--subnets-for-load-balancers <value>]
[--static-subdomain <value>]
[--cdsw-migration-mode <value>]
[--outbound-types <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The environment for the workbench to create.

--workspace-name (string)

The name of the workbench to create.

--provision-k8s-request (object)

Request object for workbench provision. Required in public cloud.

instanceGroups -> (array)

The instance groups.

item -> (object)

Contains the necessary info for an instance group.

instanceType -> (string)

The cloud provider instance type for the node instance.

instanceTier -> (string)

The tier of the instance i.e. on-demand/spot.

instanceCount -> (integer)

The initial number of instance node.

name -> (string)

The unique name of the instance group.

ingressRules -> (array)

The networking rules for the ingress.

item -> (string)

rootVolume -> (object)

Configuration for instance root device volume.

size -> (integer)

The volume size in GB.

autoscaling -> (object)

Configuration for instance auto scaling.

minInstances -> (integer)

The minimum number of instance for auto scaling.

maxInstances -> (integer)

The maximum number of instance for auto scaling.

enabled -> (boolean)

The boolean flag to enable the auto scaling.

environmentName -> (string)

The name of the environment for the workbench to create.

tags -> (array)

Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera.

item -> (object)

Contains a single tag entry that will be configured on cloud resources associated with a workbench.

key -> (string)

The name for the tag.

value -> (string)

The value for the tag.

network -> (object)

Contains the information about overlay network.

plugin -> (string)

The plugin specifies specific cni vendor, ex: calico, weave etc.

topology -> (object)

Contains the information about topology.

subnets -> (array)

The options for subnets.

item -> (string)

JSON Syntax:

{
  "instanceGroups": [
    {
      "instanceType": "string",
      "instanceTier": "string",
      "instanceCount": integer,
      "name": "string",
      "ingressRules": ["string", ...],
      "rootVolume": {
        "size": integer
      },
      "autoscaling": {
        "minInstances": integer,
        "maxInstances": integer,
        "enabled": true|false
      }
    }
    ...
  ],
  "environmentName": "string",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "network": {
    "plugin": "string",
    "topology": {
      "subnets": ["string", ...]
    }
  }
}

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

The boolean flag to request public load balancer. By default, private load balancer is used.

--disable-tls | --no-disable-tls (boolean)

The boolean flag to disable TLS setup for workbench. By default, the TLS is enabled.

--enable-monitoring | --no-enable-monitoring (boolean)

The boolean flag is used to enable monitoring. By default, monitoring is disabled.

--enable-governance | --no-enable-governance (boolean)

Enables Cloudera AI governance by integrating with Cloudera Atlas. By default, this flag is disabled.

--existing-nfs (string)

Optionally use an existing NFS by providing the hostname and desired path (Azure and Private Cloud only).

--load-balancer-ip-whitelists (array)

The whitelist of IPs for load balancer.

Syntax:

"string" "string" ...

--nfs-version (string)

The NFS Protocol version of the NFS server we are using for Azure and Private Cloud.

--ml-version (string)

The version of ML workload app to install.

--enable-model-metrics | --no-enable-model-metrics (boolean)

Enables the model metrics service for exporting metrics for models to a metrics store.

--existing-database-config (object)

Configurations for bringing an existing database for model metrics

existingDatabaseHost -> (string)

Optionally provide a Postgresql database host to export model metrics to.

existingDatabasePort -> (string)

Optionally provide a Postgresql database port to export model metrics to.

existingDatabaseName -> (string)

Optionally provide a Postgresql database name to export model metrics to.

existingDatabaseUser -> (string)

Optionally provide a Postgresql database user to use when exporting model metrics.

existingDatabasePassword -> (string)

Optionally provide a Postgresql database password to use when exporting model metrics.

Shorthand Syntax:

existingDatabaseHost=string,existingDatabasePort=string,existingDatabaseName=string,existingDatabaseUser=string,existingDatabasePassword=string

JSON Syntax:

{
  "existingDatabaseHost": "string",
  "existingDatabasePort": "string",
  "existingDatabaseName": "string",
  "existingDatabaseUser": "string",
  "existingDatabasePassword": "string"
}

--whitelist-authorized-ip-ranges | --no-whitelist-authorized-ip-ranges (boolean)

Whether to whitelist only ‘authorizedIPRanges’ given or all public IPs.

--authorized-ip-ranges (array)

The whitelist of CIDR blocks which can access the API server.

Syntax:

"string" "string" ...

--skip-validation | --no-skip-validation (boolean)

Skip pre-flight validations if requested.

--private-cluster | --no-private-cluster (boolean)

Whether to create a private cluster.

--subnets-for-load-balancers (array)

The list of subnets used for the load balancer that Cloudera AI creates.

Syntax:

"string" "string" ...

--static-subdomain (string)

The static subdomain to be used for the workbench.

--cdsw-migration-mode (string)

Toggle for cdsw migration preflight validation

--outbound-types (array)

Outbound Types provided for the workbench.

Syntax:

"string" "string" ...

Possible values:


*   ``UNKNOWN``


*   ``OUTBOUND_TYPE_UDR``

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

Form Factors¶

public, private