describe-vc¶

Description¶

Returns a description for the specified virtual cluster.

Synopsis¶

  describe-vc
--cluster-id <value>
--vc-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

Cluster id of the CDE service where vc was created.

--vc-id (string)

Virtual cluster id.

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

vc -> (object)

CDE virtual cluster summary.

vcId -> (string)

Virtual Cluster ID.

vcName -> (string)

Name of the CDE Virtual Cluster.

clusterId -> (string)

Cluster ID of the CDE service that contains the Virtual Cluster.

status -> (string)

Status of the Virtual Cluster.

resources -> (object)

Object to store resources for a CDE service

cpuRequests -> (string)

The CPU requests for VC for running spark jobs.

memRequests -> (string)

The Memory requests for VC for running spark jobs.

actualCpuRequests -> (string)

Actual CPU request for the VC. This accounts for other dex apps(eg. livy, airflow), that run in the virtual cluster.

actualMemoryRequests -> (string)

Actual Memory request for the VC. This accounts for other dex apps(eg. livy, airflow), that run in the virtual cluster.

gpuRequests -> (string)

GPU requests for autoscaling.

Form Factors: private

guaranteedCpuRequests -> (string)

Guaranteed CPU requests for an Elastic Virtual Cluster.

Form Factors: private

guaranteedMemoryRequests -> (string)

Guaranteed Memory requests for an Elastic Virtual Cluster - eg. 30Gi.

Form Factors: private

guaranteedGpuRequests -> (string)

Guaranteed GPU requests for an Elastic Virtual Cluster.

Form Factors: private

creatorEmail -> (string)

Email address of the creator of Virtual Cluster.

creatorID -> (string)

ID of the creator of Virtual Cluster.

creatorName -> (string)

Name of the creator of the Virtual Cluster.

vcApiUrl -> (string)

Url for the Virtual Cluster APIs.

VcUiUrl -> (string)

URL of the CDE Virtual Cluster UI.

historyServerUrl -> (string)

Spark History Server URL for the Virtual Cluster.

livyServerUrl -> (string)

Livy Server URL for the Virtual Cluster.

safariUrl -> (string)

Safari URL for the Virtual Cluster.

creationTime -> (string)

Time of creation of the virtual Cluster.

sparkVersion -> (string)

Spark version for the virtual cluster.

chartValueOverrides -> (array)

Chart overrides for the Virtual Cluster.

item -> (object)

Response object containing chart value overrides.

chartName -> (string)

Name of the chart that has to be overridden, for eg- “dex-app”, “dex-base”.

overrides -> (string)

Space separated key value-pairs for overriding chart values. The key and the value must be separated using a colon(:) For eg- “airflow.enabled:true safari.enabled:true”.

accessControl -> (object)

Response object containing access control information for a Virtual Cluster.

users -> (array)

Workload usernames of CDP users granted access to the Virtual Cluster.

item -> (string)

fullAccessUsers -> (array)

Users with full access.

item -> (string)

fullAccessGroups -> (array)

Groups with full access.

item -> (string)

viewOnlyUsers -> (array)

Users with view only access.

item -> (string)

viewOnlyGroups -> (array)

Groups with view only access.

item -> (string)

smtpConfig -> (object)

SMTP config response object

email -> (string)

Sender’s email address.

host -> (string)

SMTP host.

username -> (string)

SMTP username.

port -> (integer)

SMTP port.

startTls -> (boolean)

Use SMTP STARTTLS command to encrypt the mail.

ssl -> (boolean)

Use SSL to secure the connection to the email server.

vcTier -> (string)

Tier of the Virtual Cluster.

sessionTimeout -> (string)

Default timeout for Sessions.

sparkConfigs -> (map)

Spark configs that will be applied to all the spark jobs inside a virtual cluster.

key -> (string)

value -> (string)

Spark configs that will be applied to all the spark jobs inside a virtual cluster.

Form Factors¶

public, private