cloudera.cloud.df_deployment module – Enable or Disable CDP DataFlow Deployments

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Enable or Disable CDP DataFlow Deployments

Requirements

The below requirements are needed on the host that executes this module.

  • cdpy

Parameters

Parameter

Comments

autoscale

boolean

Whether to use autoscaling of pods for this Deployment

Choices:

  • false ← (default)

  • true

autoscale_nodes_max

integer

The maximum number of nodes to use when Autoscaling

Default: 3

autoscale_nodes_min

integer

The minimum number of nodes to use when Autoscaling

Default: 1

autostart_flow

boolean

Whether to automatically start the Flow once Deployment is complete

Choices:

  • false

  • true ← (default)

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

delay

aliases: polling_delay

integer

The internal polling interval (in seconds) while the module waits for the Dataflow Service to achieve the declared state.

Default: 15

dep_crn

string

The CRN of the Deployed Flow to be terminated

Required if name is not supplied for termination

df_crn

string

The CRN of the Dataflow Service

Required if the df_name is not supplied

df_name

string

The Name of the Dataflow Service

Required if df_crn is not supplied

flow_name

string

The Name of the Flow to be Deployed

Required for creating a Deployment if flow_ver_crn is not supplied

flow_ver

integer

The Version number of the Flow to be Deployed

If not supplied, the latest version available will be Deployed

flow_ver_crn

string

The CRN of the specific Version of the Flow to be Deployed

Required for creating a Deployment if flow_name is not supplied

kpis

list / elements=string

Definitions of KPIs to apply to the Deployed Flow

name

string

The name of the Deployed Flow, or Flow to be Deployed

nifi_ver

string

The specific version of NiFi to use in the Deployment

Default: "latest"

parameter_groups

list / elements=string

Definitions of Parameters to apply to the Deployed Flow

profile

string

If provided, the CDP SDK will use this value as its profile.

size

aliases: size_name

string

The Size of the Pod for the Flow to be Deployed into

Choices:

  • "EXTRA_SMALL"

  • "SMALL" ← (default)

  • "MEDIUM"

  • "LARGE"

static_node_count

integer

The number of nodes to build the Pod on if not using Autoscaling

Default: 1

timeout

aliases: polling_timeout

integer

The internal polling timeout (in seconds) while the module waits for the Dataflow Service to achieve the declared state.

Default: 3600

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

wait

boolean

Flag to enable internal polling to wait for the Dataflow Service to achieve the declared state.

If set to FALSE, the module will return immediately.

Choices:

  • false

  • true ← (default)

Notes

Note

  • This feature this module is for is in Technical Preview

Examples

# Note: These examples do not set authentication details.

# Deploy a Dataflow with defaults
- cloudera.cloud.df_deployment:
    name: my-flow

# Remove a Dataflow Service with Async wait
- cloudera.cloud.df_deployment:
    name: my-flow-name
    df_name: my-env-name
    state: absent
    wait: yes
  async: 3600
  poll: 0
  register: __my_teardown_request

Return Values

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

Key

Description

deployment

dictionary

The information about the named DataFlow Deployment

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

integer

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 deployment 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

string

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

integer

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 deployment name.

Returned: always

nifiUrl

string

The url to open the deployed flow in NiFi.

Returned: always

service

dictionary

Metadata about the DataFlow service.

Returned: always

cloudProvider

string

The cloud provider

Returned: always

crn

string

The crn of the DataFlow service.

Returned: always

environmentCrn

string

The CDP Environment CRN

Returned: always

name

string

The name of the CDP Environment.

Returned: always

region

string

The region within the 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 enabled environment.

Returned: always

detailedState

string

The detailed state that the deployment is currently in.

Returned: always

message

string

A status message for the environment.

Returned: always

state

string

The state that the deployment is currently in

Returned: always

updated

integer

Timestamp of the last time the deployment was modified.

Returned: always

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

Authors

  • Dan Chaffelson (@chaffelson)