describe-service¶
- subtitle
Describe Cloudera Data Engineering(CDE) Service
- version
0.9.126
Description¶
Returns details of CDE service.
Synopsis¶
describe-service
--cluster-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--cluster-id
(string)
Cluster id of the service to be described.
--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¶
service -> (object)
Detailed description of a CDE service.
name -> (string)
Name of the CDE Service.
clusterId -> (string)
Cluster Id of the CDE Service.
environmentName -> (string)
CDP Environment Name.
environmentCrn -> (string)
CRN of the environment.
tenantId -> (string)
CDP tenant ID.
resources -> (object)
Object to store resources for a CDE service.
instance_type -> (string)
Instance type of the CDE service.
min_instances -> (string)
Minimum Instances for the CDE service.
max_instances -> (string)
Maximum instances for the CDE service.
initial_instances -> (string)
Initial instances for the CDE service.
min_spot_instances -> (string)
Minimum number of spot instances for the CDE service.
max_spot_instances -> (string)
Maximum Number of Spot instances.
initial_spot_instances -> (string)
Initial Spot Instances for the CDE Service.
root_vol_size -> (string)
Root Volume Size.
cpuRequests -> (string)
CPU Requests for the entire CDE service quota.
Form Factors: private
memoryRequests -> (string)
Memory requests for the entire CDE service quota, eg. 100Gi.
Form Factors: private
gpuRequests -> (string)
GPU requests for the entire CDE service quota.
Form Factors: private
resourcePool -> (string)
Resource Pool for the CDE service.
Form Factors: private
allPurposeInstanceGroupDetails -> (object)
Instance group details for the All purpose Tier.
instance_type -> (string)
Instance type of the cluster for CDE Service.
min_instances -> (string)
Minimum number of Instances for the CDE Service.
max_instances -> (string)
Maximum number of Instances for the CDE Service.
min_spot_instances -> (string)
Minimum number of Spot instances for the CDE Service.
max_spot_instances -> (string)
Maximum number of Spot Instances for the CDE Service.
initial_instances -> (string)
Initial number of Instances when the service is enabled.
initial_spot_instances -> (string)
Initial number of spot Instances when the service is enabled.
root_vol_size -> (string)
EBS volume size in GB.
status -> (string)
Status of the CDE service.
creatorEmail -> (string)
Email address of the creator of the CDE service.
creatorCrn -> (string)
CRN of the creator.
enablingTime -> (string)
Timestamp of service enabling.
clusterFqdn -> (string)
FQDN of the CDE service.
cloudPlatform -> (string)
The cloud platform where the CDE service is enabled.
dataLakeFileSystems -> (string)
The Data lake file system.
logLocation -> (string)
Location for the log files of jobs.
backupLocation -> (string)
Base location for the service backup archives.
dataLakeAtlasUIEndpoint -> (string)
Endpoint of Data Lake Atlas.
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”.
whitelistIps -> (string)
List of CIDRs that would be allowed to access kubernetes master API server.
loadbalancerAllowlist -> (string)
Comma-separated CIDRs that would be allowed to access the load balancer.
subnets -> (string)
List of Subnet IDs of the CDP subnets used by the kubernetes worker node.
privateClusterEnabled -> (boolean)
If true, the CDE service was created with fully private Azure services (AKS, MySQL, etc.).
publicEndpointEnabled -> (boolean)
If true, the CDE endpoint was created in a publicly accessible subnet.
networkOutboundType -> (string)
Network outbound type. Currently ‘udr’ is the only supported.
previousVersionDeployed -> (boolean)
The “true” value indicates that the previous version of the CDE service was requested to be deployed.
workloadAnalyticsEnabled -> (boolean)
If true, diagnostic information about job and query execution is sent to Cloudera Workload Manager.
ssdUsed -> (boolean)
If true, SSD would have been be used for workload filesystem.
Form Factors¶
public, private