describe-workspace¶

Description¶

Describes a Cloudera AI workbench.

Synopsis¶

  describe-workspace
[--environment-name <value>]
[--workspace-name <value>]
[--workspace-crn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The environment for the workbench to describe.

--workspace-name (string)

The name of the workbench to describe.

--workspace-crn (string)

The CRN of the workbench to describe. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored.

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

workspace -> (object)

A ML workbench, which includes the cluster and storage.

instanceName -> (string)

The name of the workbench.

environmentName -> (string)

The name of the workbench’s environment.

instanceStatus -> (string)

The workbench’s current status.

instanceUrl -> (string)

URL of the workbench’s user interface.

environmentCrn -> (string)

CRN of the environment.

crn -> (string)

The CRN of the workbench.

k8sClusterName -> (string)

The Kubernetes cluster name.

creatorCrn -> (string)

The CRN of the creator of the workbench.

version -> (string)

The version of Cloudera AI that was installed on the workbench.

httpsEnabled -> (boolean)

To Display if Https is enabled or not.

endpointPublicAccess -> (boolean)

To check if the cluster is publicly accessible or not.

filesystemID -> (string)

filesystemID used by the workbench

tags -> (array)

Tags provided by the user at the time of workbench creation.

item -> (object)

Contains a single tag entry associated with a workbench.

key -> (string)

The name for the tag.

value -> (string)

The value for the tag.

instanceGroups -> (array)

The instance groups.

item -> (object)

Instance group information to show in workbench details.

instanceType -> (string)

The cloud provider instance type for the node instance.

instanceCount -> (integer)

The initial number of instance node.

instanceGroupName -> (string)

The unique name of the instance group.

minInstances -> (integer)

The minimum number of instances that can be deployed to this instance group. If the value is 0, the group might be empty.

maxInstances -> (integer)

The maximum number of instances that can be deployed to this instance group.

instances -> (array)

Instances in the instance group.

item -> (object)

Represents each instance in an instance group.

instanceId -> (string)

Unique instance Id generated by the cloud provider.

availabilityZone -> (string)

Availability zone the instance belongs to.

tags -> (array)

Tags are key/value pairs that are applied to all tag-able resources deployed in the workbench’s cloud environment.

item -> (object)

Contains a single tag entry associated with a workbench.

key -> (string)

The name for the tag.

value -> (string)

The value for the tag.

cpu -> (string)

Number of CPUs attached to this instance type.

gpu -> (string)

Number of GPUs attached to this instance type.

memory -> (string)

Memory in GiB attached to this instance type.

cloudPlatform -> (string)

The cloud platform of the environment that was used to create this workbench.

monitoringEnabled -> (boolean)

If usage monitoring is enabled or not on this workbench.

loadBalancerIPWhitelists -> (array)

IP whitelist for loadBalancer.

item -> (string)

creationDate -> (datetime)

Creation date of workbench.

healthInfoLists -> (array)

The health info information of the workbench.

item -> (object)

Healthinfo object contains the health information of a resource.

resourceName -> (string)

The resource name being checked.

isHealthy -> (boolean)

The boolean that indicates the health status.

updatedAt -> (datetime)

The timestamp for the heartbeat.

message -> (string)

The message to show for the health info.

details -> (array)

The detail of the health info.

item -> (string)

failureMessage -> (string)

Failure message from the most recent failure that has occurred during workbench provisioning.

clusterBaseDomain -> (string)

The basedomain of the cluster.

modelMetricsEnabled -> (boolean)

Whether model metrics is enabled.

governanceEnabled -> (boolean)

Whether governance is enabled.

subnets -> (array)

The subnets of the workbench.

item -> (string)

whitelistAuthorizedIPRanges -> (boolean)

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

authorizedIPRanges -> (array)

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

item -> (string)

nfsVersion -> (string)

NFS Version of the filesystem.

subnetsForLoadBalancers -> (array)

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

item -> (string)

upgradeState -> (object)

Response object for the workbench summary.

state -> (string)

The current upgrade state of the workbench.

reason -> (string)

The reason for the current state.

backupMetadata -> (object)

Backup metadata response object for the workbench summary.

backupVaultName -> (string)

The backup vault name.

lastSuccessfulBackupTime -> (datetime)

The time when the last successful backup was taken.

isSuccessfulBackupAvailable -> (boolean)

Whether successful backups are available for the workbench.

lastBackupStatus -> (string)

The status of the last backup initiated.

numberOfAvailableBackups -> (integer)

The number of backups available.

clusterID -> (string)

The Cluster ID for the workbench.

isPrivate -> (boolean)

The value to indicate if the cluster is private or not.

isRestored -> (boolean)

The value to indicate if the workbench is restored one or not

Form Factors¶

public, private