Cloudera Compute Service

acceleratorManufacturers
optional

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

< string > array

acceleratorTypes
optional

Accelerator Types. For eg. gpu, inference.

< string > array

clusterCrn
required

Compute cluster CRN.

string

groups
optional

K8s RBAC cluster role bindings.

< string > array

id
required

User ID. Specify user or role ARN.

string

isAdmin
optional

True if added user is an admin.

boolean

isRole
optional

True if user ID is a role.

boolean

username
optional

Username.

string

id
optional

User ID.

string

status
optional

User Status.

string

availabilityZones
optional

Availability zones.

< integer (int32) > array

enableAutoScaling
optional

Enable auto scaling.

boolean

instanceCount
optional

Instance count.

integer (int64)

instanceGroupId
optional

Instance group ID.

string

instanceGroupName
optional

Instance group name.

string

instanceStates
optional

Instance states

CommonInstanceStateCounts

instanceTier
optional

Instance tier.

string

instanceType
optional

Instance type.

string

instances
optional

AKS pool instance.

< AksPoolInstance > array

isSystem
optional

True for a system node.

boolean

kubeReservedCpu
optional

Kube reserved CPU.

integer (int64)

kubeReservedMemory
optional

Kube reserved memory.

integer (int64)

kubeReservedStorage
optional

Kube reserved storage.

integer (int64)

labels
optional

Labels.

< string, string > map

maxInstance
optional

Max instances.

integer (int64)

minInstance
optional

Min instances.

integer (int64)

nodePool
optional

AKS node pool.

AksNodePool

nodeVolumeSize
optional

Node volume size.

integer (int64)

singleZone
optional

Single zone.

boolean

systemReservedCpu
optional

System reserved CPU.

integer (int64)

systemReservedMemory
optional

System reserved memory.

integer (int64)

systemReservedStorage
optional

System reserved storage.

integer (int64)

tags
optional

Tags.

< string, string > map

taints
optional

Taints.

< string, string > map

availabilityZones
optional

Availability zones.

< string > array

instances
optional

AKS pool instance.

< AksPoolInstance > array

name
optional

Name.

string

provisioningState
optional

Provisioning state.

string

type
optional

Type.

string

availabilityZone
optional

Availability zone.

string

instanceId
optional

Instance ID.

string

name
optional

Name.

string

subnetId
optional

Subnet ID.

string

adminUsername
optional

The username to use for Linux VMs.

string

clusterDisplayName
optional

Cluster display name.

string

clusterResourceGroup
optional

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

string

clusterResourceGroupCreated
optional

Specifies whether ClusterResourceGroup was created or not.

boolean

deployments
optional

Deployments.

CommonDeploymentsResp

dnsServiceIp
optional

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

string

dockerBridgeCidr
optional

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.

string

enableHttpApplicationRouting
optional

Specifies whether httpApplicationRouting addon is enabled or not.

boolean

enableMonitoring
optional

Specifies whether monitoring addon is enabled or not.

boolean

instanceGroups
optional

Instance groups.

< string, AksInstanceGroup > map

logAnalyticsWorkspace
optional

An existing Azure Log Analytics Workspace for monitoring addon.

string

logAnalyticsWorkspaceResourceGroup
optional

The resource group for the Azure Log Analytics Workspace.

string

masterDnsPrefix
optional

DNS prefix used for hostnames in the cluster.

string

networkCidrs
optional

The actual CIDR ranges of the virtual network.

< string > array

networkPlugin
optional

The plugin used for kubernetes network.

string

networkPolicy
optional

The policy used for kubernetes network.

string

parentResourceGroup
optional

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

string

podCidr
optional

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

string

provider
optional

Cloud provider.

string

security
optional

Security.

CommonSecurityResp

selectedSubnet
optional

Selected Subnet from the list that is provided

string

serviceCidr
optional

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

string

sshPublicKey
optional

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

string

sshPublicKeyContents
optional

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

string

subnets
optional

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

< string > array

tags
optional

Tags.

< string, string > map

userData
optional

User data.

string

virtualNetwork
optional

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

string

virtualNetworkResourceGroup
optional

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

string

workerEgressRules
optional

Egress rules for worker nodes.

< string > array

workerIngressRules
optional

Ingress rules for worker nodes.

< string > array

applicationVersion
optional

The version of the components which would be installed from this deployment.

string

deploymentVersion
optional

The version of the deployment that is available to upgrade to.

string

encryptionKeyUrl
optional

Encryption key URI.

string

userManagedIdentity
optional

Resource ID of the user managed identity.

string

encryptionKeyUrl
optional

Encryption key URI.

string

userManagedIdentity
optional

Resource ID of the user managed identity.

string

diskEncryptionSetId
optional

Disk encryption set ID.

string

diskEncryptionSetId
optional

Disk encryption set ID.

string

applicationVersion
optional

The version (usually of the images) of the components being deployed.

string

deploymentVersion
optional

The version of this chart (which is not the version of the components being deployed).

string

description
optional

The chart description.

string

name
optional

The chart name.

string

values
optional

Escaped JSON for values.yaml of that chart.

string

enabled
optional

Flag to indicate if Alertmanager is enabled.

boolean

authorizedIpRanges
optional

An array of IPv4 CIDR blocks.

< string > array

enabled
optional

Flag to enable whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server.

boolean

authorizedIpRanges
optional

An array of IPv4 CIDR blocks.

< string > array

enabled
optional

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

boolean

maxGracefulTerminationSec
optional

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

integer (int64)

scaleDownDelayAfterAdd
optional

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

string

scaleDownDelayAfterDelete
optional

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

string

scaleDownDelayAfterFailure
optional

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

string

scaleDownEnabled
optional

Scale down flag. (AWS Support).

boolean

scaleDownNonEmptyCandidatesCount
optional

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).

integer (int32)

scaleDownUnneededTime
optional

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

string

scaleDownUnreadyTime
optional

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

string

scaleDownUtilizationThreshold
optional

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).

number (double)

scanInterval
optional

Scan interval. (Azure/AWS Support).

string

skipNodesWithLocalStorage
optional

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

boolean

skipNodesWithSystemPods
optional

Skip nodes with system pods. (AWS Support).

boolean

maxGracefulTerminationSec
optional

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

integer (int64)

scaleDownDelayAfterAdd
optional

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

string

scaleDownDelayAfterDelete
optional

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

string

scaleDownDelayAfterFailure
optional

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

string

scaleDownEnabled
optional

Scale down flag. (AWS Support).

boolean

scaleDownNonEmptyCandidatesCount
optional

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).

integer (int32)

scaleDownUnneededTime
optional

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

string

scaleDownUnreadyTime
optional

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

string

scaleDownUtilizationThreshold
optional

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).

number (double)

scanInterval
optional

Scan interval. (Azure/AWS Support).

string

skipNodesWithLocalStorage
optional

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

boolean

skipNodesWithSystemPods
optional

Skip nodes with system pods. (AWS Support).

boolean

deploymentProfile
optional

Deployment profile used. Currently supported is common.

string

enabled
optional

Deployment enable flag.

boolean

autoscaler
optional

Autoscaler specs.

CommonAutoscalerResp

horizontalPodAutoscaler
optional

Horizontal pod autoscaler specs.

CommonHorizontalPodAutoScalerResp

istio
optional

Istio specs.

CommonDeploymentProfileDetailsResp

knox
optional

Knox specs.

CommonDeploymentProfileDetailsResp

logging
optional

Logging specs.

CommonLoggingResp

metering
optional

Metering specs.

CommonMeteringResp

monitoring
optional

Monitoring specs.

CommonMonitoringResp

nvidia
optional

Nvidia specs.

CommonNvidiaResp

repository
optional

Repository for images.

string

telemetryKmsKeyArn
optional

Telemetry KMS key ARN.

string

yunikorn
optional

Yunikorn specs.

CommonYuniKornResp

details
optional

Details.

string

name
optional

Event name.

string

progress
optional

Progress.

string

resourceType
optional

Resource type.

string

status
optional

Status.

string

statusReason
optional

Status reason.

string

timestamp
optional

Timestamp.

string

version
optional

Helm version to be upgraded to.

string

enabled
optional

Enable flag.

boolean

crn
optional

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

string

name
optional

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

string

crn
optional

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

string

name
optional

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

string

acceleratorConfig
optional

Accelerator Config for AWS.

AcceleratorConfigResp

allowedInstanceTypes
optional

Instance types to include.

< string > array

cpuTypes
optional

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

< string > array

excludedInstanceTypes
optional

Instance types to exclude, ignored if AllowedInstanceTypes is set.

< string > array

maxCpu
optional

Maximum vCpu count.

integer (int64)

maxMemory
optional

Maximum memory requirement in MiB.

integer (int64)

minCpu
optional

Minimum vCpu count.

integer (int64)

minMemory
optional

Minimum memory requirement in MiB.

integer (int64)

architectureTypes
optional

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

< string > array

instanceRequirements
optional

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

CommonInstanceRequirementsResp

virtualizationTypes
optional

The virtualization types. For eg. hvm, paravirtual.

< string > array

creating
optional

Number of instances in creating state.

integer (int64)

running
optional

Number of instances in running state.

integer (int64)

terminating
optional

Number of instances in terminating state.

integer (int64)

total
optional

Total number of instances.

integer (int64)

enabled
optional

True to enable logging installation (default false).

boolean

enabled
optional

Flag to indicate if Monitoring is enabled.

boolean

services
optional

Array of services.

< CommonMeteringServiceResp > array

clusterCrn
optional

Cluster CRN.

string

serviceConfiguration
optional

Service configuration.

string

serviceType
optional

Service type.

string

serviceVersion
optional

Service version.

string

workloadCrn
optional

Workload CRN.

string

alertmanager
optional

Alertmanager.

CommonAlertmanagerResp

enabled
optional

Flag to indicate if Monitoring is enabled.

boolean

serverResourceLimits
optional

Server resource limits.

CommonResourceLimitsResp

outboundType
optional

Cluster outbound type. Currently supported is udr.

string

podCidr
optional

The pod CIDR to use if the backend provider supports setting this.

string

serviceCidr
optional

The CIDR for services declared inside of Kubernetes if the backend provider supports setting this.

string

subnets
optional

Subnets.

< string > array

current
optional

Currently used node image version.

string

instanceGroup
optional

Instance group name.

string

upgrades
optional

Available node image upgrade versions.

< string > array

gpuLabelKey
optional

GPU label key.

string

gpuLabelValue
optional

GPU label value.

string

cpu
optional

Prometheus server CPU limit (default 1000m).

string

memory
optional

Prometheus server memory limit (default 2048M).

string

azure
optional

Azure secret encryption details.

AzureSecretEncryption

customerKmsKeyArn
optional

AWS KMS key ARN.

string

azure
optional

Azure secret encryption details.

AzureSecretEncryptionResp

customerKmsKeyArn
optional

AWS KMS key ARN.

string

apiServer
optional

API server.

CommonApiServer

private
optional

Flag set to true for a private cluster with API Server having internal IP addressees.

boolean

secretEncryption
optional

Secret encryption.

CommonSecretEncryption

volumeEncryption
optional

Volume encryption.

CommonVolumeEncryption

apiServer
optional

API server.

CommonApiServerResp

private
optional

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

boolean

secretEncryption
optional

Secret encryption.

CommonSecretEncryptionResp

volumeEncryption
optional

Volume encryption.

CommonVolumeEncryptionResp

message
optional

Message.

string

status
optional

Status.

string

csiEnabled
optional

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

boolean

csiEnabled
optional

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

boolean

autoscaler
optional

Autoscaler.

CommonAutoscaler

description
optional

Description of compute cluster update.

string

deployments
optional

Update deployments on the compute cluster.

CommonUpdateClusterDeployments

helm
optional

Update Helm on compute the compute cluster.

CommonHelm

imageCatalog
optional

Update image catalog for the compute cluster.

CommonImageCatalog

refreshInstanceGroups
optional

Whether to refresh nodes of instance groups belonging to the compute cluster.

boolean

security
optional

Update security settings for the compute cluster.

CommonSecurity

storage
optional

Update storage settings for the compute cluster.

CommonStorageSpec

azure
optional

Azure volume encryption details.

AzureVolumeEncryption

customerKmsKeyArn
optional

The KMS key ARN used.

string

azure
optional

Azure volume encryption details.

AzureVolumeEncryptionResp

customerKmsKeyArn
optional

AWS KMS key ARN.

string

appSortingPolicy
optional

The app sorting policy. Deprecated.

string

enabled
optional

Flag to indicate if yunikorn is enabled.

boolean

nodeSortingPolicy
optional

The node sorting policy. Deprecated.

string

version
optional

Version. Deprecated.

string

accountId
optional

Owner’s account ID.

string

crn
optional

Owner’s actor CRN.

string

email
optional

Owner’s email.

string

firstName
optional

Owner’s firstname.

string

lastName
optional

Owner’s lastname.

string

userId
optional

Owner’s user ID.

string

description
optional

Cluster description.

string

environment
required

Environment CRN. Required.

string

name
required

Cluster name. Required.

string

network
optional

Network.

CommonNetwork

skipValidation
optional

Skip validation.

boolean

tags
optional

Cluster level tags.

< string, string > map

clusterCrn
optional

Compute cluster CRN.

string

clusterId
optional

Compute cluster ID.

string

clusterStatus
optional

Cluster status.

CommonStatusMessage

uri
optional

Uniform Resource Identifier of cluster.

string

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure.

ValidationResponse

clusterCrn
required

Compute cluster CRN.

string

force
optional

Forces the cluster into the DELETED state without cleaning up resources; only valid if cluster is in DELETE_FAILED state.

boolean

skipValidation
optional

Whether to skip validation.

boolean

skipWorkloadsValidation
optional

Whether to skip the running workloads validation for externalized clusters

boolean

clusterStatus
optional

Cluster Status.

CommonStatusMessage

validationResponse
optional

Pre-flight validation check response. Only given on a validation failure.

ValidationResponse

clusterCrn
required

Compute cluster CRN.

string

name
required

The name of the deployment.

string

namespace
required

The namespace of the deployment.

string

message
optional

A message returned about the status of the delete operation.

string

clusterCrn
required

Compute cluster CRN.

string

id
required

ID of user to be deleted.

string

id
optional

User ID.

string

status
optional

User Status.

string

chart
optional

Chart that the deployment was created from.

Chart

liftieManaged
optional

True if Liftie is managing this deployment.

boolean

name
optional

The name of the deployment.

string

namespace
optional

The namespace of the deployment.

string

overrides
optional

Escaped JSON overrides for the deployment’s properties.

string

revision
optional

Helm revision.

integer (int32)

status
optional

Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future.

string

upgrades
optional

Any upgrades available for this deployment.

< AvailableDeploymentUpgrade > array

clusterCrn
required

Compute cluster CRN.

string

account
optional

CDP account ID.

string

aks
optional

AKS state.

AksState

apiEndPoint
optional

API endpoint.

string

availableUpgrades
optional

List of available kubernetes upgrades.

< string > array

bootstrapScript
optional

Bootstrap script used to setup this cluster.

string

clusterCrn
optional

Compute cluster CRN.

string

clusterId
optional

Compute cluster ID.

string

clusterName
optional

Compute cluster name.

string

clusterOwner
optional

Cluster owner.

ComputeClusterOwner

clusterShape
optional

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

string

clusterSize
optional

Number of nodes in the cluster.

integer (int32)

clusterStateVersion
optional

Cluster state version.

integer (int32)

clusterType
optional

Compute cluster type.

ComputeClusterType

computePlatform
optional

Compute cluster platform provider.

ComputePlatform

computePlatformVersion
optional

Compute cluster platform version.

string

creationTime
optional

Compute cluster creation time in ISO format.

string

dashboardUrl
optional

Compute cluster platform dashboard url.

string

deletionTime
optional

Compute cluster deletion time in ISO format.

string

description
optional

Description about the cluster.

string

eks
optional

EKS state.

EksState

envCloudProvider
optional

CDP environment cloud provider.

EnvCloudProvider

envCrn
optional

CDP environment CRN.

string

envName
optional

CDP environment name.

string

imageCatalog
optional

The image catalog details.

CommonImageCatalogResp

isClouderaManaged
optional

Is compute cluster cloudera managed or not.

boolean

isDefault
optional

The cluster which is automatically created for every containerized environment.

boolean

kubernetesVersion
optional

Kubernetes version.

string

labels
optional

Map of labels associated with this cluster.

< string, string > map

message
optional

Message with additional details about the cluster status.

string

nodeImageUpgradeAvailable
optional

Is a node image upgrade available.

boolean

nodeImageUpgrades
optional

Lists the currently used images and the new upgrades available.

< CommonNodeImageAvailableUpgrade > array

region
optional

Region.

string

status
optional

Compute cluster status.

string

storage
optional

The storage specifications.

CommonStorageSpecResp

updateTime
optional

Compute cluster update time in ISO format.

string

workloads
optional

Workloads.

< string > array

clusterCrn
required

Compute cluster CRN.

string

name
required

The name of the deployment.

string

namespace
required

The namespace of the deployment.

string

deployment
optional

Deployment details.

Deployment

history
optional

History of the deployment.

< History > array

overrides
optional

Escaped JSON overrides for the deployment’s properties. Deprecated.

string

clusterCrn
required

Compute cluster CRN.

string

id
required

User ID.

string

user
optional

User details.

User

availabilityZone
optional

Availability zone.

string

instanceId
optional

Instance ID.

string

subnetId
optional

Subnet ID.

string

ami
optional

AMI.

string

autoscalingEnabled
optional

Autoscaling enabled.

boolean

enableCfsQuota
optional

Enable cfs quota.

boolean

events
optional

Events.

< CommonEvent > array

imageParam
optional

Image param.

string

imdsVersions
optional

IMDS versions.

< string > array

instanceCount
optional

Instance count.

integer (int64)