cloudera.cloud.df_service_info module – Gather information about CDP DataFlow Services

Note

This module is part of the cloudera.cloud collection (version 3.1.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.df_service_info.

New in cloudera.cloud 1.2.0

Synopsis

  • Gather information about CDP DataFlow 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.

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

df_crn

string

If a df_crn is provided, that DataFlow Service will be described

Mutually exclusive with name and env_crn

endpoint

aliases: endpoint_url, url

string

The Cloudera on cloud API endpoint to use.

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_crn

string

If an env_crn is provided, the DataFlow Service for that Environment will be described

Mutually exclusive with name and df_crn

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 DataFlow Service will be described

Must be the string name of the CDP Environment

Mutually exclusive with df_crn and env_crn

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 DataFlow Services
- cloudera.cloud.df_service_info:

# Gather detailed information about a named DataFlow Service using a name
- cloudera.cloud.df_service_info:
    name: example-service

# Gather detailed information about a named DataFlow Service using a Dataflow CRN
- cloudera.cloud.df_service_info:
    df_crn: crn:cdp:df:region:tenant-uuid4:service:service-uuid4

# Gather detailed information about a named DataFlow Service using an Environment CRN
- cloudera.cloud.df_service_info:
    env_crn: crn:cdp:environments:region:tenant-uuid4:environment:environment-uuid4

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 DataFlow Service or DataFlow Services

Returned: always

activeErrorAlertCount

integer

Current count of active alerts classified as an error.

Returned: always

activeWarningAlertCount

integer

Current count of active alerts classified as a warning.

Returned: always

authorizedIpRanges

list / elements=string

The authorized IP Ranges.

Returned: always

cloudPlatform

string

The cloud platform of the environment.

Returned: always

clusterId

string

Cluster id of the environment.

Returned: if enabled

crn

string

The DataFlow Service’s CRN.

Returned: always

deploymentCount

string

The deployment count.

Returned: always

dfLocalUrl

string

The URL of the environment local DataFlow application.

Returned: always

environmentCrn

string

The DataFlow Service’s Parent Environment CRN.

Returned: always

instanceType

string

The instance type of the kubernetes nodes currently in use by DataFlow for this environment.

Returned: always

k8sNodeCount

integer

The number of kubernetes nodes currently in use by DataFlow for this environment.

Returned: always

maxK8sNodeCount

string

The maximum number of kubernetes nodes that environment may scale up under high-demand situations.

Returned: always

minK8sNodeCount

integer

The minimum number of Kubernetes nodes that need to be provisioned in the environment.

Returned: always

name

string

The DataFlow Service’s parent environment name.

Returned: always

region

string

The region of the environment.

Returned: always

status

dictionary

The status of a DataFlow enabled environment.

Returned: always

message

string

A status message for the environment.

Returned: always

state

string

The state of the environment.

Returned: always

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)

  • Ronald Suplina (@rsuplina)