cloudera.cloud.de_info module – Gather information about CDP Data Engineering Services

Note

This module is part of the cloudera.cloud collection (version 3.3.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cloudera.cloud.

To use it in a playbook, specify: cloudera.cloud.de_info.

New in cloudera.cloud 1.5.0

Synopsis

  • Gather information about CDP Data Engineering Services

Parameters

Parameter

Comments

access_key

string

If provided, the Cloudera on cloud API will use this value as its access key.

If not provided, the API will attempt to use the value from the environment variable CDP_ACCESS_KEY_ID.

Required if private_key is provided.

Mutually exclusive with credentials_path.

cluster_id

aliases: id

string

If a cluster_id is provided, that Data Engineering Service will be described

Mutually exclusive with name and env_name

credentials_path

string

If provided, the Cloudera on cloud API will use this value as its credentials path.

If not provided, the API will attempt to use the value from the environment variable CDP_CREDENTIALS_PATH.

Default: "~/.cdp/credentials"

debug

aliases: debug_endpoints

boolean

If true, the module will capture the Cloudera on cloud HTTP log and return it in the sdk_out and sdk_out_lines fields.

Choices:

  • false ← (default)

  • true

endpoint

aliases: endpoint_url, url

string

The Cloudera on cloud API endpoint to use.

If not provided, the API will attempt to use the value from the environment variable CDP_ENDPOINT_URL.

Mutually exclusive with endpoint_region.

endpoint_region

aliases: cdp_endpoint_region, cdp_region, region

string

Specify the Cloudera on cloud API endpoint region.

See Cloudera Control Plane regions for more information.

If not provided, the API will attempt to use the value from the environment variable CDP_REGION.

default is an alias for the us-west-1 region.

Mutually exclusive with endpoint.

Choices:

  • "default"

  • "us-west-1" ← (default)

  • "eu-1"

  • "ap-1"

endpoint_tls

aliases: verify_endpoint_tls, verify_tls, verify_api_tls

boolean

Verify the TLS certificates for the Cloudera on cloud API endpoint.

Choices:

  • false

  • true ← (default)

env_name

aliases: environment

string

If an env_name is provided, the Data Engineering Service for that Environment will be described

Mutually exclusive with name and cluster_id

http_agent

aliases: agent_header

string

The HTTP user agent to use for Cloudera on cloud API requests.

Default: "cloudera.cloud"

name

string

If a name is provided, that Data Engineering Service will be described

Must be the string name of the CDE service

Mutually exclusive with cluster_id and env_name

private_key

string

If provided, the Cloudera on cloud API will use this value as its private key.

If not provided, the API will attempt to use the value from the environment variable CDP_PRIVATE_KEY.

Required if access_key is provided.

profile

string

If provided, the Cloudera on cloud API will use this value as its profile.

If not provided, the API will attempt to use the value from the environment variable CDP_PROFILE.

Default: "default"

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Examples

# Note: These examples do not set authentication details.

# List basic information about all Data Engineering Services
- cloudera.cloud.de_info:

# Gather detailed information about a named Data Engineering Service
- cloudera.cloud.de_info:
    name: example-de-service

# Gather detailed information about a Data Engineering Service using a cluster ID
- cloudera.cloud.de_info:
    cluster_id: cluster-12345

# Gather detailed information about a Data Engineering Service using an Environment name
- cloudera.cloud.de_info:
    env_name: my-environment

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when supported

services

list / elements=complex

The information about the named Data Engineering Service or Data Engineering Services

Returned: always

backupLocation

string

Base location for the service backup archives

Returned: when available

cloudPlatform

string

The cloud platform where the CDE service is enabled

Returned: when available

clusterFqdn

string

FQDN of the CDE service

Returned: when available

clusterId

string

Cluster Id of the CDE Service

Returned: always

creatorCrn

string

CRN of the creator

Returned: when available

creatorEmail

string

Email address of the creator of the CDE service

Returned: when available

dataLakeAtlasUIEndpoint

string

Endpoint of Data Lake Atlas

Returned: when available

dataLakeFileSystems

string

The Data lake file system

Returned: when available

enablingTime

string

Timestamp of service enabling

Returned: when available

environmentCrn

string

CRN of the environment

Returned: when available

environmentName

string

CDP Environment Name

Returned: always

loadbalancerAllowlist

string

Comma-separated CIDRs that would be allowed to access the load balancer

Returned: when available

logLocation

string

Location for the log files of jobs

Returned: when available

name

string

Name of the CDE Service

Returned: always

networkOutboundType

string

Network outbound type

Returned: when available

previousVersionDeployed

boolean

The “true” value indicates that the previous version of the CDE service was requested to be deployed

Returned: when available

privateClusterEnabled

boolean

If true, the CDE service was created with fully private Azure services

Returned: when available

publicEndpointEnabled

boolean

If true, the CDE endpoint was created in a publicly accessible subnet

Returned: when available

resources

dictionary

Resources details of CDE Service

Returned: when available

allPurposeInstanceGroupDetails

dictionary

Resource details for the nodes used in All Purpose Virtual Clusters

Returned: when available

cpuRequests

string

CPU Requests for the entire CDE service quota

Returned: when available

initial_instances

string

Initial instances for the CDE service

Returned: when available

initial_spot_instances

string

Initial Spot Instances for the CDE Service

Returned: when available

instance_type

string

Instance type of the CDE service

Returned: when available

max_instances

string

Maximum instances for the CDE service

Returned: when available

max_spot_instances

string

Maximum Number of Spot instances

Returned: when available

memoryRequests

string

Memory requests for the entire CDE service quota

Returned: when available

min_instances

string

Minimum Instances for the CDE service

Returned: when available

min_spot_instances

string

Minimum number of spot instances for the CDE service

Returned: when available

resourcePool

string

Resource Pool for the CDE service

Returned: when available

root_vol_size

string

Root Volume Size

Returned: when available

ssdUsed

boolean

If true, SSD would have been be used for workload filesystem

Returned: when available

status

string

Status of the CDE service

Returned: always

subnets

string

List of Subnet IDs of the CDP subnets used by the kubernetes worker node

Returned: when available

tenantId

string

CDP tenant ID

Returned: when available

whitelistIps

string

List of CIDRs that would be allowed to access kubernetes master API server

Returned: when available

workloadAnalyticsEnabled

boolean

If true, diagnostic information about job and query execution is sent to Cloudera Workload Manager

Returned: when available

Authors

  • Ronald Suplina (@rsuplina)

  • Curtis Howard (@curtishoward)

  • Alan Silva (@acsjumpi)