cloudera.cloud.df_deployment_info module – Gather information about CDP DataFlow Deployments

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

New in cloudera.cloud 1.6.0

Synopsis

  • Gather information about CDP DataFlow Deployments

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"

crn

aliases: dep_crn

string

If a crn is provided, that DataFlow Deployment will be described

Must be the string CRN of the deployment object

Mutually exclusive with the name argument

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.

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)

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, the DataFlow Deployment with this name will be described

Mutually exclusive with the crn argument

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 Deployments
- cloudera.cloud.df_deployment_info:

# Gather detailed information about a named DataFlow Deployment using a crn
- cloudera.cloud.df_deployment_info:
    crn: crn:cdp:df:region:tenant-uuid4:deployment:deployment-uuid4/deployment-uuid4

# Gather detailed information about a named DataFlow Deployment using a name
- cloudera.cloud.df_deployment_info:
    name: test-dataflow-deployment

Return Values

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

Key

Description

deployments

list / elements=dictionary

The information about the named DataFlow Deployment or DataFlow Deployments

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

autoscaleMaxNodes

complex

The maximum number of nodes that the deployment can scale up to, or null if autoscaling is not enabled for this deployment.

Returned: always

autoscaleMinNodes

integer

The minimum number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is true.

Returned: always

autoscalingEnabled

boolean

Whether or not to autoscale the deployment.

Returned: always

clusterSize

string

The initial size of the deployment.

Returned: always

configurationVersion

integer

The version of the configuration for this deployment.

Returned: always

crn

string

The DataFlow Deployment’s CRN.

Returned: always

currentNodeCount

integer

The current node count.

Returned: always

deployedByCrn

string

The actor CRN of the person who deployed the flow.

Returned: always

deployedByName

complex

The name of the person who deployed the flow.

Returned: always

dfxLocalUrl

string

Base URL to the DFX Local instance running this deployment.

Returned: always

flowCrn

string

The deployment’s current flow CRN.

Returned: always

flowName

string

The name of the flow.

Returned: always

flowVersion

integer

The version of the flow.

Returned: always

flowVersionCrn

string

The deployment’s current flow version CRN.

Returned: always

lastUpdatedByName

string

The name of the person who last updated the deployment.

Returned: always

name

string

The DataFlow Deployment’s name.

Returned: always

nifiUrl

string

The url to open the deployed flow in NiFi.

Returned: always

service

dictionary

Metadata about the parent DataFlow service.

Returned: always

cloudProvider

string

The cloud provider for the parent environment.

Returned: always

crn

string

The CRN of the parent service.

Returned: always

environmentCrn

string

The CDP parent Environment CRN.

Returned: always

name

string

The name of the parent environment.

Returned: always

region

string

The region within the parent environment cloud provider.

Returned: always

staticNodeCount

integer

The static number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is false.

Returned: always

status

dictionary

The status of a DataFlow deployment.

Returned: always

detailedState

string

The state of the Deployment.

Returned: always

message

string

A status message for the Deployment.

Returned: always

state

string

The state of the Deployment.

Returned: always

updated

integer

Timestamp of the last time the deployment was modified.

Returned: always

sdk_out

string

Returns the captured API HTTP log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured API HTTP log.

Returned: when supported

Authors

  • Dan Chaffelson (@chaffelson)

  • Ronald Suplina (@rsuplina)