cloudera.cloud.de_virtual_cluster_info module – Gather information about CDP DE virtual clusters

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

Synopsis

  • Gather information about CDP DE virtual clusters

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"

cluster_name

aliases: env

string

The ID of the service in which to find and describe the DE virtual clusters.

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

name

aliases: name

string

If a name is provided, that DE virtual cluster will be described (if it exists)

Note that there should be only 1 or 0 (non-deleted) virtual clusters with a given CDE service

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 CDE virtual clusters within a CDE service
- cloudera.cloud.de_virtual_cluster_info:
    cluster_name: example-cluster-name
    environment: example-environment

# Gather detailed information about a specific CDE virtual cluster
- cloudera.cloud.de_info:
    cluster_name: example-cluster-name
    environment: example-environment
    name: example-virtual-cluster-name

Return Values

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

Key

Description

virtual_cluster

complex

DE virtual cluste

Returned: always

accessControl

dictionary

Access control object for the Virtual Cluster

Returned: always

users

list / elements=string

Workload usernames of CDP users granted access to the Virtual Cluster.

Returned: always

chartValueOverrides

list / elements=complex

Chart overrides for the CDE virtual cluster.

Returned: always

ChartValueOverridesResponse

list / elements=string

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

clusterId

string

Cluster ID of the CDE service that contains the Virtual Cluster

Returned: always

creationTime

string

Time of creation of the virtual Cluster

Returned: always

creatorEmail

string

Email address of the creator of Virtual Cluster

Returned: always

creatorID

string

ID of the creator of Virtual Cluster

Returned: always

creatorName

string

Name of the creator of the Virtual Cluster

Returned: always

historyServerUrl

string

Spark History Server URL for the Virtual Cluster

Returned: always

livyServerUrl

string

Livy Server URL for the Virtual Cluster

Returned: always

resources

complex

Resources details of CDE virtual cluster.

Returned: always

VcResources

complex

Object to store resources for a CDE service.

Returned: always

actualCpuRequests

string

Actual CPU request for the VC. This accounts for other dex apps(eg. livy, airflow), that run in the virtual cluster.

Returned: always

actualMemoryRequests

string

Actual Memory request for the VC. This accounts for other dex apps(eg. livy, airflow), that run in the virtual cluster.

Returned: always

cpuRequests

string

The CPU requests for VC for running spark jobs.

Returned: always

memRequests

string

The Memory requests for VC for running spark jobs.

Returned: always

safariUrl

string

Safari URL for the Virtual Cluster

Returned: always

sparkVersion

string

Spark version for the virtual cluster

Returned: always

status

string

Status of the Virtual Cluster

Returned: always

vcApiUrl

string

Url for the Virtual Cluster APIs

Returned: always

vcId

string

Virtual Cluster ID

Returned: always

vcName

string

Name of the CDE Virtual Cluster

Returned: always

VcUiUrl

string

URL of the CDE Virtual Cluster UI

Returned: always

Authors

  • Curtis Howard (@curtishoward)