cloudera.cloud.ml_info module – Gather information about CDP ML Workspaces

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

Synopsis

  • Gather information about CDP ML Workspaces

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"

crn

aliases: workspace_crn

string

The CRN of the Workspace to describe.

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 ML Workspaces.

Required with name to retrieve a Workspace

name

aliases: workspace

string

If a name is provided, that ML Workspace will be described.

environment must be provided if using name to retrieve a Workspace

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 ML Workspaces
- cloudera.cloud.ml_info:

# Gather detailed information about a named Workspace
- cloudera.cloud.ml_info:
    name: example-workspace
    env: example-environment

# Gather detailed information about a named Workspace using a CRN
- cloudera.cloud.ml_info:
    crn: example-workspace-crn

Return Values

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

Key

Description

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

workspaces

list / elements=complex

The information about the named Workspace or Workspaces

Returned: always

cloudPlatform

string

The cloud platform of the environment that was used to create this workspace.

Returned: always

clusterBaseDomain

string

The basedomain of the cluster.

Returned: when supported

creationDate

string

Creation date of workspace (date-time).

Returned: always

Sample: "2021-05-19T15:35:17.997000+00:00"

creatorCrn

string

The CRN of the creator of the workspace.

Returned: always

crn

string

The CRN of the workspace.

Returned: always

endpointPublicAccess

boolean

Flag indicating if the cluster is publicly accessible.

Returned: always

environmentCrn

string

CRN of the environment.

Returned: always

environmentName

string

The name of the workspace’s environment.

Returned: always

failureMessage

string

Failure message from the most recent failure that has occurred during workspace provisioning.

Returned: during failure

filesystemID

string

A filesystem ID referencing the filesystem that was created on the cloud provider environment that this workspace uses.

Returned: always

governanceEnabled

boolean

Flag indicating if Cloudera Atlas governance is enabled for the cluster.

Returned: when supported

healthInfoLists

list / elements=dictionary

The health info information of the workspace.

Returned: success

HealthInfo

list / elements=string

Healthinfo object contains the health information of a resource.

Returned: always

details

list / elements=string

The detail of the health info.

Returned: always

isHealthy

boolean

The boolean that indicates the health status.

Returned: always

message

string

The message to show for the health info.

Returned: always

resourceName

string

The resource name being checked.

Returned: always

updatedAt

string

The unix timestamp for the heartbeat.

Returned: always

httpsEnabled

boolean

Indicates if HTTPS communication was enabled on this workspace when provisioned.

Returned: always

instanceGroups

list / elements=dictionary

The instance groups details for the cluster.

Returned: always

instanceCount

integer

The initial number of instance nodes.

Returned: always

instanceGroupName

string

The unique name of the instance group.

Returned: always

instances

list / elements=dictionary

Instances in the instance group.

Returned: always

availabilityZone

string

Availability zone of the instance.

Returned: always

instanceId

string

Unique instance Id generated by the cloud provider.

Returned: always

instanceType

string

The cloud provider instance type for the node instances.

Returned: always

maxInstances

integer

The maximum number of instances that can be deployed to this instance group.

Returned: always

minInstances

integer

The minimum number of instances that can be deployed to this instance group. If the value is 0, the group might be empty.

Returned: always

tags

list / elements=dictionary

Key/value pairs applied to all applicable resources deployed in cloud provider.

Returned: always

key

string

Tag name

Returned: always

value

string

Tag value

Returned: always

instanceName

string

The name of the workspace.

Returned: always

instanceStatus

string

The workspace’s current status.

Returned: always

instanceUrl

string

URL of the workspace’s user interface.

Returned: always

k8sClusterName

string

The Kubernetes cluster name.

Returned: always

loadBalancerIPWhitelists

list / elements=string

The whitelist of ips for loadBalancer.

Returned: always

modelMetricsEnabled

boolean

Flag indicating if model metrics export is enabled for the cluster.

Returned: when supported

monitoringEnabled

boolean

If usage monitoring is enabled or not on this workspace.

Returned: always

tags

list / elements=dictionary

Tags provided by the user at the time of workspace creation.

Returned: always

key

string

Tag name

Returned: always

value

string

Tag value

Returned: always

version

string

The version of Cloudera Machine Learning that was installed on the workspace.

Returned: always

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)