describe-cluster¶

Description¶

Describe compute cluster details in a CDP Environment

Synopsis¶

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

Options¶

--cluster-crn (string)

Compute cluster CRN.

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

envName -> (string)

CDP environment name.

envCloudProvider -> (string)

object representing CDP Environment cloud provider type AWS - CDP Environment installed in AWS AZURE - CDP Environment installed in Azure OPENSHIFT - CDP Environment installed as on-premise instalation using CDP DC services in base cluster

clusterName -> (string)

Compute cluster name.

clusterCrn -> (string)

Compute cluster CRN.

description -> (string)

Description about the cluster.

Form Factors: private

status -> (string)

Compute cluster status.

computePlatform -> (string)

object representing CDP Compute Cluster Platform provider OPENSHIFT - OpenShift Container Platform cluster as compute platform (private cloud only). EKS - EKS cluster as compute platform AKS - AKS cluster as compute platform RKE - Rancher RKE as compute platform (private cloud only).

computePlatformVersion -> (string)

Compute cluster platform version.

Form Factors: private

kubernetesVersion -> (string)

Kubernetes version.

clusterSize -> (integer)

Number of nodes in the cluster.

Form Factors: private

dashboardUrl -> (string)

Compute cluster platform dashboard url.

isClouderaManaged -> (boolean)

Is compute cluster cloudera managed or not.

Form Factors: private

clusterType -> (string)

Object representing compute cluster types. DedicatedExternal - Value representing an external dedicated compute cluster. Shared - Value representing a shared compute cluster. Dedicated - Value representing an embedded dedicated compute cluster.

creationTime -> (string)

Compute cluster creation time in ISO format.

clusterId -> (string)

Compute cluster ID.

envCrn -> (string)

CDP environment CRN.

apiEndPoint -> (string)

API endpoint.

Form Factors: public

clusterStateVersion -> (integer)

Cluster state version.

Form Factors: public

deletionTime -> (string)

Compute cluster deletion time in ISO format.

Form Factors: public

updateTime -> (string)

Compute cluster update time in ISO format.

Form Factors: public

workloads -> (array)

Workloads.

Form Factors: public

item -> (string)

clusterOwner -> (object)

Compute cluster owner structure.

Form Factors: public

email -> (string)

Owner’s email.

firstName -> (string)

Owner’s firstname.

lastName -> (string)

Owner’s lastname.

userId -> (string)

Owner’s user ID.

accountId -> (string)

Owner’s account ID.

crn -> (string)

Owner’s actor CRN.

region -> (string)

Region.

Form Factors: public

message -> (string)

Message with additional details about the cluster status.

Form Factors: public

account -> (string)

CDP account ID.

Form Factors: public

availableUpgrades -> (array)

List of available kubernetes upgrades.

Form Factors: public

item -> (string)

imageCatalog -> (object)

Image catalog response structure.

Form Factors: public

crn -> (string)

The catalog CRN (either CRN or name is required).

name -> (string)

The catalog name (either CRN or name is required).

storage -> (object)

Storage spec response structure.

Form Factors: public

csiEnabled -> (boolean)

Flag to enable CSI (Container Storage Interface). It further sets specific inline cloud formation policies required for CSI.

labels -> (map)

Map of labels associated with this cluster.

key -> (string)

value -> (string)

bootstrapScript -> (string)

Bootstrap script used to setup this cluster.

aks -> (object)

AKS state response structure.

Form Factors: public

provider -> (string)

Cloud provider.

clusterDisplayName -> (string)

Cluster display name.

clusterResourceGroup -> (string)

The Cluster ResourceGroup. Filled based on Parent ResourceGroup or ClusterDisplayName.

clusterResourceGroupCreated -> (boolean)

Specifies whether ClusterResourceGroup was created or not.

enableHttpApplicationRouting -> (boolean)

Specifies whether httpApplicationRouting addon is enabled or not.

enableMonitoring -> (boolean)

Specifies whether monitoring addon is enabled or not.

logAnalyticsWorkspaceResourceGroup -> (string)

The resource group for the Azure Log Analytics Workspace.

logAnalyticsWorkspace -> (string)

An existing Azure Log Analytics Workspace for monitoring addon.

virtualNetworkResourceGroup -> (string)

The resource group for the Azure Virtual Network. Composite of agent virtual network subnet ID.

virtualNetwork -> (string)

An existing Azure Virtual Network. Composite of agent virtual network subnet ID.

subnets -> (array)

An array specifying existing Azure Virtual Subnets. Composite of agent virtual network subnet IDs.

item -> (string)

selectedSubnet -> (string)

Selected Subnet from the list that is provided

parentResourceGroup -> (string)

The ResourceGroup which may be used for almost all the Azure resources created (with VirtualNetwork and Node ResourceGroup being exceptions).

adminUsername -> (string)

The username to use for Linux VMs.

sshPublicKeyContents -> (string)

The content of the SSH configuration for Linux VMs, Opposite to sshPublicKey.

sshPublicKey -> (string)

The local path of the SSH configuration for Linux VMs, Opposite to sshPublicKeyContents.

dnsServiceIp -> (string)

An IP address assigned to the kubernetes DNS service, it must be within the kubernetes service address range specified in serviceCidr.

dockerBridgeCidr -> (string)

A CIDR notation IP range assigned to the Docker bridge network, it must not overlap with any Azure Subnet IP ranges or the kubernetes service address range.

networkPlugin -> (string)

The plugin used for kubernetes network.

networkPolicy -> (string)

The policy used for kubernetes network.

podCidr -> (string)

A CIDR notation IP range from which to assign pod IPs when networkPlugin is using kubenet.

serviceCidr -> (string)

A CIDR notation IP range from which to assign service cluster IPs, it must not overlap with any Azure Subnet IP ranges.

networkCidrs -> (array)

The actual CIDR ranges of the virtual network.

item -> (string)

workerIngressRules -> (array)

Ingress rules for worker nodes.

item -> (string)

workerEgressRules -> (array)

Egress rules for worker nodes.

item -> (string)

masterDnsPrefix -> (string)

DNS prefix used for hostnames in the cluster.

tags -> (map)

Tags.

key -> (string)

value -> (string)

instanceGroups -> (map)

Instance groups.

key -> (string)

value -> (object)

AKS instance group response structure.

Form Factors: public

instanceGroupName -> (string)

Instance group name.

instanceGroupId -> (string)

Instance group ID.

instanceType -> (string)

Instance type.

instanceTier -> (string)

Instance tier.

instanceStates -> (object)

Instance state counts response structure.

Form Factors: public

running -> (integer)

Number of instances in running state.

creating -> (integer)

Number of instances in creating state.

terminating -> (integer)

Number of instances in terminating state.

total -> (integer)

Total number of instances.

instanceCount -> (integer)

Instance count.

nodeVolumeSize -> (integer)

Node volume size.

enableAutoScaling -> (boolean)

Enable auto scaling.

minInstance -> (integer)

Min instances.

maxInstance -> (integer)

Max instances.

singleZone -> (boolean)

Single zone.

labels -> (map)

Labels.

key -> (string)

value -> (string)

taints -> (map)

Taints.

key -> (string)

value -> (string)

tags -> (map)

Tags.

key -> (string)

value -> (string)

kubeReservedCpu -> (integer)

Kube reserved CPU.

kubeReservedMemory -> (integer)

Kube reserved memory.

kubeReservedStorage -> (integer)

Kube reserved storage.

systemReservedCpu -> (integer)

System reserved CPU.

systemReservedMemory -> (integer)

System reserved memory.

systemReservedStorage -> (integer)

System reserved storage.

availabilityZones -> (array)

Availability zones.

item -> (integer)

nodePool -> (object)

AKS node pool response structure.

Form Factors: public

name -> (string)

Name.

type -> (string)

Type.

provisioningState -> (string)

Provisioning state.

instances -> (array)

AKS pool instance.

item -> (object)

AKS pool instance response structure.

Form Factors: public

name -> (string)

Name.

instanceId -> (string)

Instance ID.

availabilityZone -> (string)

Availability zone.

availabilityZones -> (array)

Availability zones.

item -> (string)

instances -> (array)

AKS pool instance.

item -> (object)

AKS pool instance response structure.

Form Factors: public

name -> (string)

Name.

instanceId -> (string)

Instance ID.

availabilityZone -> (string)

Availability zone.

isSystem -> (boolean)

True for a system node.

deployments -> (object)

Deployments response structure.

Form Factors: public

autoscaler -> (object)

Autoscaler response structure.

Form Factors: public

scaleDownDelayAfterAdd -> (string)

How long after scale up that scale down evaluation resumes. (Azure/AWS Support).

scaleDownDelayAfterDelete -> (string)

How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support).

scaleDownDelayAfterFailure -> (string)

How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support).

scaleDownEnabled -> (boolean)

Scale down flag. (AWS Support).

scaleDownNonEmptyCandidatesCount -> (integer)

Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support).

scaleDownUnneededTime -> (string)

How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support).

scaleDownUtilizationThreshold -> (double)

Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support).

scanInterval -> (string)

Scan interval. (Azure/AWS Support).

skipNodesWithLocalStorage -> (boolean)

Skip nodes with local storage flag. (AWS Support).

skipNodesWithSystemPods -> (boolean)

Skip nodes with system pods. (AWS Support).

maxGracefulTerminationSec -> (integer)

Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support).

scaleDownUnreadyTime -> (string)

How long an unready node should be unneeded before it is eligible for scale down. (Azure Support).

horizontalPodAutoscaler -> (object)

Horizontal pod autoscaler response structure.

Form Factors: public

enabled -> (boolean)

Enable flag.

istio -> (object)

Deployment Profile details response structure.

Form Factors: public

enabled -> (boolean)

Deployment enable flag.

deploymentProfile -> (string)

Deployment profile used. Currently supported is common.

logging -> (object)

Logging response structure.

Form Factors: public

enabled -> (boolean)

True to enable logging installation (default false).

metering -> (object)

Metering response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if Monitoring is enabled.

services -> (array)

Array of services.

item -> (object)

Metering service response structure.

Form Factors: public

serviceType -> (string)

Service type.

serviceVersion -> (string)

Service version.

workloadCrn -> (string)

Workload CRN.

clusterCrn -> (string)

Cluster CRN.

serviceConfiguration -> (string)

Service configuration.

monitoring -> (object)

Monitoring response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if Monitoring is enabled.

alertmanager -> (object)

Alertmanager response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if Alertmanager is enabled.

serverResourceLimits -> (object)

Resource limits response structure.

Form Factors: public

cpu -> (string)

Prometheus server CPU limit (default 1000m).

memory -> (string)

Prometheus server memory limit (default 2048M).

nvidia -> (object)

Nvidia response structure.

Form Factors: public

gpuLabelKey -> (string)

GPU label key.

gpuLabelValue -> (string)

GPU label value.

repository -> (string)

Repository for images.

yunikorn -> (object)

YuniKorn response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if yunikorn is enabled.

telemetryKmsKeyArn -> (string)

Telemetry KMS key ARN.

knox -> (object)

Deployment Profile details response structure.

Form Factors: public

enabled -> (boolean)

Deployment enable flag.

deploymentProfile -> (string)

Deployment profile used. Currently supported is common.

userData -> (string)

User data.

security -> (object)

Security response structure.

Form Factors: public

apiServer -> (object)

API server response structure.

Form Factors: public

authorizedIpRanges -> (array)

An array of IPv4 CIDR blocks.

item -> (string)

enabled -> (boolean)

Flag to indicate if whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server is enabled.

secretEncryption -> (object)

Secret Encryption response structure.

Form Factors: public

customerKmsKeyArn -> (string)

AWS KMS key ARN.

volumeEncryption -> (object)

Volume encryption response structure.

Form Factors: public

customerKmsKeyArn -> (string)

AWS KMS key ARN.

private -> (boolean)

Flag to indicate if this is a private cluster with API Server having internal IP addressees.

eks -> (object)

EKS state response structure.

Form Factors: public

provider -> (string)

Provider.

clusterDisplayName -> (string)

Cluster display name.

userData -> (string)

User data for this cluster.

virtualNetwork -> (string)

Virtual network details.

existingVirtualNetwork -> (boolean)

Existing virtual network if used.

subnets -> (array)

Subnets.

item -> (string)

workerSubnets -> (array)

Worker subnets.

item -> (string)

securityGroups -> (array)

Security groups.

item -> (string)

serviceRole -> (string)

Service role.

workerInstanceProfile -> (string)

Worker instance profile.

associateWorkerNodePublicIp -> (boolean)

Associate worker node public IP.

vpcCidr -> (string)

VPC CIDR.

workerIngressRules -> (array)

Ingress rules for worker nodes.

item -> (string)

workerEgressRules -> (array)

Egress rules for worker nodes.

item -> (string)

workerSecurityGroup -> (string)

Worker security group.

telemetryEnabled -> (boolean)

Telemetry enabled.

telemetryLoggingEnabled -> (boolean)

Telemetry logging enabled.

telemetryLoggingStorageLocation -> (string)

Telemetry logging storage location.

telemetryLoggingBucket -> (string)

Telemetry logging bucket.

telemetryLoggingRootDir -> (string)

Telemetry logging root dir.

telemetryKmsKeyArn -> (string)

Telemetry logging root dir.

tags -> (map)

Tags.

key -> (string)

value -> (string)

sshKeyPairName -> (string)

SSH key pair name.

kmsKeyArn -> (string)

KMS key ARN.

instanceGroups -> (map)

Instance groups.

key -> (string)

value -> (object)

EKS instance group response structure.

Form Factors: public

ami -> (string)

AMI.

imageParam -> (string)

Image param.

instanceGroupName -> (string)

Instance group name.

instanceGroupId -> (string)

Instance group ID.

instanceTier -> (string)

Instance tier.

instanceTypes -> (array)

Instance types.

item -> (string)

instanceCount -> (integer)

Instance count.

instanceStates -> (object)

Instance state counts response structure.

Form Factors: public

running -> (integer)

Number of instances in running state.

creating -> (integer)

Number of instances in creating state.

terminating -> (integer)

Number of instances in terminating state.

total -> (integer)

Total number of instances.

singleZone -> (boolean)

Single zone.

minInstance -> (integer)

Min instances.

maxInstance -> (integer)

Max instances.

nodeInstanceRole -> (string)

Node instance role.

nodeVolumeSize -> (integer)

Node volume size.

labels -> (map)

Labels.

key -> (string)

value -> (string)

taints -> (map)

Taints.

key -> (string)

value -> (string)

tags -> (map)

Tags.

key -> (string)

value -> (string)

autoscalingEnabled -> (boolean)

Autoscaling enabled.

kubeReservedCpu -> (integer)

Kube reserved CPU.

kubeReservedMemory -> (integer)

Kube reserved memory.

kubeReservedStorage -> (integer)

Kube reserved storage.

systemReservedCpu -> (integer)

System reserved CPU.

systemReservedMemory -> (integer)

System reserved memory.

systemReservedStorage -> (integer)

System reserved storage.

enableCfsQuota -> (boolean)

Enable cfs quota.

instances -> (array)

EKS Instance.

item -> (object)

EKS instance response structure.

Form Factors: public

instanceId -> (string)

Instance ID.

availabilityZone -> (string)

Availability zone.

events -> (array)

Events.

item -> (object)

Event response structure.

Form Factors: public

details -> (string)

Details.

name -> (string)

Event name.

progress -> (string)

Progress.

resourceType -> (string)

Resource type.

status -> (string)

Status.

statusReason -> (string)

Status reason.

timestamp -> (string)

Timestamp.

instanceGroupStatus -> (string)

Instance group status.

lTNameSuffix -> (string)

Launch Template name suffix.

instanceRequirementswithMetadata -> (object)

Instance requirements with metadata response structure.

Form Factors: public

architectureTypes -> (array)

The architecture types. For eg, i386, x86_64, arm64, x86_64_mac, arm64_mac.

item -> (string)

virtualizationTypes -> (array)

The virtualization types. For eg. hvm, paravirtual.

item -> (string)

instanceRequirements -> (object)

Instance requirements structure.

Form Factors: public

allowedInstanceTypes -> (array)

Instance types to include.

item -> (string)

cpuTypes -> (array)

CPU types required. For eg. intel, amd, amazon-web-services etc.

item -> (string)

excludedInstanceTypes -> (array)

Instance types to exclude, ignored if AllowedInstanceTypes is set.

item -> (string)

maxCpu -> (integer)

Maximum vCpu count.

minCpu -> (integer)

Minimum vCpu count.

maxMemory -> (integer)

Maximum memory requirement in MiB.

minMemory -> (integer)

Minimum memory requirement in MiB.

acceleratorConfig -> (object)

Accelerator Configurations structure

Form Factors: public

acceleratorManufacturers -> (array)

Accelerator Manufacturer type. For eg. amazon-web-service, AMD, nvidia.

item -> (string)

acceleratorTypes -> (array)

Accelerator Types. For eg. gpu, inference.

item -> (string)

instanceProfile -> (string)

Instance profile name.

imdsVersions -> (array)

IMDS versions.

item -> (string)

deployments -> (object)

Deployments response structure.

Form Factors: public

autoscaler -> (object)

Autoscaler response structure.

Form Factors: public

scaleDownDelayAfterAdd -> (string)

How long after scale up that scale down evaluation resumes. (Azure/AWS Support).

scaleDownDelayAfterDelete -> (string)

How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support).

scaleDownDelayAfterFailure -> (string)

How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support).

scaleDownEnabled -> (boolean)

Scale down flag. (AWS Support).

scaleDownNonEmptyCandidatesCount -> (integer)

Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support).

scaleDownUnneededTime -> (string)

How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support).

scaleDownUtilizationThreshold -> (double)

Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support).

scanInterval -> (string)

Scan interval. (Azure/AWS Support).

skipNodesWithLocalStorage -> (boolean)

Skip nodes with local storage flag. (AWS Support).

skipNodesWithSystemPods -> (boolean)

Skip nodes with system pods. (AWS Support).

maxGracefulTerminationSec -> (integer)

Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support).

scaleDownUnreadyTime -> (string)

How long an unready node should be unneeded before it is eligible for scale down. (Azure Support).

horizontalPodAutoscaler -> (object)

Horizontal pod autoscaler response structure.

Form Factors: public

enabled -> (boolean)

Enable flag.

istio -> (object)

Deployment Profile details response structure.

Form Factors: public

enabled -> (boolean)

Deployment enable flag.

deploymentProfile -> (string)

Deployment profile used. Currently supported is common.

logging -> (object)

Logging response structure.

Form Factors: public

enabled -> (boolean)

True to enable logging installation (default false).

metering -> (object)

Metering response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if Monitoring is enabled.

services -> (array)

Array of services.

item -> (object)

Metering service response structure.

Form Factors: public

serviceType -> (string)

Service type.

serviceVersion -> (string)

Service version.

workloadCrn -> (string)

Workload CRN.

clusterCrn -> (string)

Cluster CRN.

serviceConfiguration -> (string)

Service configuration.

monitoring -> (object)

Monitoring response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if Monitoring is enabled.

alertmanager -> (object)

Alertmanager response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if Alertmanager is enabled.

serverResourceLimits -> (object)

Resource limits response structure.

Form Factors: public

cpu -> (string)

Prometheus server CPU limit (default 1000m).

memory -> (string)

Prometheus server memory limit (default 2048M).

nvidia -> (object)

Nvidia response structure.

Form Factors: public

gpuLabelKey -> (string)

GPU label key.

gpuLabelValue -> (string)

GPU label value.

repository -> (string)

Repository for images.

yunikorn -> (object)

YuniKorn response structure.

Form Factors: public

enabled -> (boolean)

Flag to indicate if yunikorn is enabled.

telemetryKmsKeyArn -> (string)

Telemetry KMS key ARN.

knox -> (object)

Deployment Profile details response structure.

Form Factors: public

enabled -> (boolean)

Deployment enable flag.

deploymentProfile -> (string)

Deployment profile used. Currently supported is common.

sshPublicKey -> (string)

SSH public key.

networkPlugin -> (string)

Network plugin.

serviceCidr -> (string)

Service CIDR.

inboundProxyCidrs -> (array)

Array of inbound proxy CIDRs.

item -> (string)

security -> (object)

Security response structure.

Form Factors: public

apiServer -> (object)

API server response structure.

Form Factors: public

authorizedIpRanges -> (array)

An array of IPv4 CIDR blocks.

item -> (string)

enabled -> (boolean)

Flag to indicate if whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server is enabled.

secretEncryption -> (object)

Secret Encryption response structure.

Form Factors: public

customerKmsKeyArn -> (string)

AWS KMS key ARN.

volumeEncryption -> (object)

Volume encryption response structure.

Form Factors: public

customerKmsKeyArn -> (string)

AWS KMS key ARN.

private -> (boolean)

Flag to indicate if this is a private cluster with API Server having internal IP addressees.

suspendedProcesses -> (array)

Suspended processes.

item -> (string)

csiEnabled -> (boolean)

Whether CSI is enabled.

nodeImageUpgradeAvailable -> (boolean)

Is a node image upgrade available.

Form Factors: public

nodeImageUpgrades -> (array)

Lists the currently used images and the new upgrades available.

Form Factors: public

item -> (object)

Structure to list the currently used images and the new upgrades available.

Form Factors: public

instanceGroup -> (string)

Instance group name.

current -> (string)

Currently used node image version.

upgrades -> (array)

Available node image upgrade versions.

item -> (string)

isDefault -> (boolean)

The cluster which is automatically created for every containerized environment.

Form Factors: public

clusterShape -> (string)

The clusterShape represents the shape of the cluster, which can be “Embedded” or “Externalized”.

Form Factors: public

Form Factors¶

public, private