cloudera.cloud.de module – Enable and Disable CDP Data Engineering Services

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

Synopsis

  • Enable or Disable CDP Data Engineering Service

Requirements

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

  • cdpy

Parameters

Parameter

Comments

chart_value_overrides

list / elements=dictionary

Chart overrides for enabling a service

chart_name

string

The key-value pair for the chart_name-override

delay

aliases: polling_delay

integer

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

Default: 60

enable_private_network

boolean

Create a fully private CDE instance

Choices:

  • false

  • true

enable_public_endpoint

boolean

Creates a CDE endpoint (Load Balancer) in a publicly accessible subnet

Choices:

  • false

  • true

enable_workload_analytics

boolean

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

Choices:

  • false

  • true

environment

aliases: env

string / required

CDP environment where CDE service should be enabled

force

aliases: force_delete

boolean

Flag to force delete a service even if errors occur during deletion.

Choices:

  • false ← (default)

  • true

initial_instances

integer

Initial Instances when the service is enabled

initial_spot_instances

integer

Initial spot Instances when the service is enabled

instance_type

string

Instance type of the cluster for CDE Service

For example, (AWS) m5.2xlarge

loadbalancer_ips

list / elements=string

List of CIDRs allowed to access the load balancer.

maximum_instances

integer

Maximum Instances for the CDE Service

maximum_spot_instances

integer

Maximum Spot Instances for the CDE Service

minimum_instances

integer

Minimum Instances for the CDE Service

minimum_spot_instances

integer

Minimum Spot Instances for the CDE Service

name

aliases: name

string / required

The name of the CDE Service

root_volume_size

integer

EBS volume size in GB

skip_validation

boolean

Skip Validation check.

Choices:

  • false

  • true

state

string

The declarative state of the CDE service

Choices:

  • "present" ← (default)

  • "absent"

tags

dictionary

User defined labels that tag all provisioned cloud resources

key

string

The key/value pair for the tag

timeout

aliases: polling_timeout

integer

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

Default: 7200

use_ssd

boolean

Instance local storage (SSD) would be used for the workload filesystem (Example - spark local directory). Currently supported only for aws services

Choices:

  • false

  • true

wait

boolean

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

If set to FALSE, the module will return immediately.

Choices:

  • false

  • true ← (default)

whitelist_ips

list / elements=string

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

Examples

# Create a DE service using defaults for optional parameters and wait for completion
- cloudera.cloud.de:
    name: cde-cloudera-deploy-example
    env: cdp-environment-name
    instance_type: "m5.2xlarge"
    state: present
    wait: yes

# Remove a DE service without waiting
- cloudera.cloud.de:
    name: cde-cloudera-deploy-example+
    env: cdp-environment-name
    state: absent
    wait: no

Return Values

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

Key

Description

service

complex

DE service description

Returned: always

chartValueOverrides

list / elements=complex

Status of the CDE Service.

Returned: always

ChartValueOverridesResponse

list / elements=string

Response object containing chart value overrides.

Returned: always

chartName

string

Name of the chart that has to be overridden.

Returned: always

overrides

string

Space separated key value-pairs for overriding chart values (colon separated)

Returned: always

cloudPlatform

string

The cloud platform where the CDE service is enabled.

Returned: always

clusterFqdn

string

FQDN of the CDE service.

Returned: always

clusterId

string

Cluster Id of the CDE Service.

Returned: always

creatorCrn

string

CRN of the creator.

Returned: always

creatorEmail

string

Email Address of the CDE creator.

Returned: always

dataLakeAtlasUIEndpoint

string

Endpoint of Data Lake Atlas.E

Returned: always

dataLakeFileSystems

string

The Data lake file system.

Returned: always

enablingTime

string

Timestamp of service enabling.

Returned: always

environmentCrn

string

CRN of the environment.

Returned: always

environmentName

string

CDP Environment Name.

Returned: always

logLocation

string

Location for the log files of jobs.

Returned: always

name

string

Name of the CDE Service.

Returned: always

resources

complex

Resources details of CDE Service.

Returned: always

ServiceResources

complex

Object to store resources for a CDE service.

Returned: always

initial_instances

string

Initial instances for the CDE service.

Returned: always

initial_spot_instances

string

Initial Spot Instances for the CDE Service.

Returned: always

instance_type

string

Instance type of the CDE service.

Returned: always

max_instances

string

Maximum instances for the CDE service.

Returned: always

max_spot_instances

string

Maximum Number of Spot instances.

Returned: always

min_instances

string

Minimum Instances for the CDE service.

Returned: always

min_spot_instances

string

Minimum number of spot instances for the CDE service.

Returned: always

root_vol_size

string

Root Volume Size.

Returned: always

status

string

Status of the CDE Service.

Returned: always

tenantId

string

CDP tenant ID.

Returned: always

Authors

  • Curtis Howard (@curtishoward)

  • Alan Silva (@acsjumpi)