cloudera.cloud.datalake_info module – Gather information about CDP Datalakes

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

Synopsis

  • Gather information about CDP Datalakes

Requirements

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

  • cdpy

Parameters

Parameter

Comments

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

environment

aliases: env

string

The name of the Environment in which to find and describe the Datalake.

name

aliases: datalake

string

If a name is given, that Datalake will be described.

If no name is given, all Datalakes will be listed and (optionally) constrained by the environment parameter.

profile

string

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

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Examples

# Note: These examples do not set authentication details.

# List basic information about all Datalakes
- cloudera.cloud.datalake_info:

# Gather detailed information about a named Datalake
- cloudera.cloud.datalake_info:
    name: example-datalake

# Gather detailed information about the Datalake in an Environment
- cloudera.cloud.datalake_info:
    environment: example-env

Return Values

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

Key

Description

datalakes

list / elements=complex

The information about the named Datalake or Datalakes

Returned: on success

awsConfiguration

dictionary

AWS-specific configuration details.

Returned: when supported

instanceProfile

string

The instance profile used for the ID Broker instance.

Returned: always

azureConfiguration

dictionary

Azure-specific environment configuration information.

Returned: when supported

managedIdentity

string

The managed identity used for the ID Broker instance.

Returned: always

clouderaManager

dictionary

The Cloudera Manager details.

Returned: when supported

clouderaManagerRepositoryURL

string

Cloudera Manager repository URL.

Returned: always

clouderaManagerServerURL

string

Cloudera Manager server URL.

Returned: when supported

version

string

Cloudera Manager version.

Returned: always

Sample: "7.2.1"

cloudPlatform

string

Cloud provider of the Datalake.

Returned: when supported

Sample: "['AWS', 'AZURE']"

creationDate

string

The timestamp when the Datalake was created.

Returned: when supported

Sample: "2020-09-23T11:33:50.847000+00:00"

credentialCrn

string

CRN of the CDP Credential.

Returned: when supported

crn

string

CRN value for the Datalake.

Returned: always

datalakeName

string

Name of the Datalake.

Returned: always

endpoints

dictionary

Details for the exposed service API endpoints of the Datalake.

Returned: when supported

endpoints

list / elements=dictionary

The exposed API endpoints.

Returned: always

displayName

string

User-friendly name of the exposed service.

Returned: always

Sample: "Atlas"

knoxService

string

The related Knox entry for the service.

Returned: always

Sample: "ATLAS_API"

mode

string

The Single Sign-On (SSO) mode for the service.

Returned: always

Sample: "PAM"

open

boolean

Flag for the access status of the service.

Returned: always

serviceName

string

The name of the exposed service.

Returned: always

Sample: "ATLAS_SERVER"

serviceUrl

string

The server URL for the exposed service’s API.

Returned: always

Sample: "https://some.domain/a-datalake/endpoint"

environmentCrn

string

CRN of the associated Environment.

Returned: when supported

instanceGroups

list / elements=complex

The instance details of the Datalake.

Returned: when supported

instances

list / elements=dictionary

Details about the instances.

Returned: always

id

string

The identifier of the instance.

Returned: always

Sample: "i-00b58f27be4e7ab9f"

state

string

The state of the instance.

Returned: always

Sample: "HEALTHY"

name

string

Name of the instance group associated with the instances.

Returned: always

Sample: "idbroker"

productVersions

list / elements=dictionary

The product versions.

Returned: when supported

name

string

The name of the product.

Returned: always

Sample: "FLINK"

version

string

The version of the product.

Returned: always

Sample: "1.10.0-csa1.2.1.0-cdh7.2.1.0-240-4844562"

region

string

The region of the Datalake.

Returned: when supported

status

string

The status of the Datalake.

Returned: when supported

Sample: "['EXTERNAL_DATABASE_START_IN_PROGRESS', 'START_IN_PROGRESS', 'RUNNING', 'EXTERNAL_DATABASE_START_IN_PROGRESS', 'START_IN_PROGRESS', 'EXTERNAL_DATABASE_STOP_IN_PROGRESS', 'STOP_IN_PROGRESS', 'STOPPED', 'REQUESTED', 'EXTERNAL_DATABASE_CREATION_IN_PROGRESS', 'STACK_CREATION_IN_PROGRESS', 'EXTERNAL_DATABASE_DELETION_IN_PROGRESS', 'STACK_DELETION_IN_PROGRESS', 'PROVISIONING_FAILED']"

statusReason

string

An explanation of the status.

Returned: when supported

Sample: "Datalake is running"

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

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)