cloudera.services.ml_runtime_addon module – Manage the status of Cloudera Machine Learning (CML) runtime addons

Note

This module is part of the cloudera.services collection (version 1.0.0).

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 git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.ml_runtime_addon.

New in cloudera.services 1.0.0

Synopsis

  • Set the status of one or more Cloudera Machine Learning (CML) runtime addons.

  • Loading custom runtime addons (tarball upload) is not supported by this module.

  • The module supports check_mode.

Parameters

Parameter

Comments

api_key

aliases: token

string / required

The CML API key (bearer token) used to authenticate to the Workspace API.

If not set, the value of the CML_API_KEY environment variable is used.

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

identifiers

list / elements=string

The string identifiers of the runtime addons to target.

Mutually exclusive with ids.

ids

list / elements=integer

The numeric identifiers of the runtime addons to target.

Mutually exclusive with identifiers.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

status

string / required

The status to set on the target runtime addons.

Choices:

  • "AVAILABLE"

  • "DISABLED"

  • "DEPRECATED"

  • "DELETED"

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

url

aliases: endpoint, endpoint_url, workspace_url

string / required

The base URL of the CML Workspace API endpoint, including the port if necessary.

If not set, the value of the CML_ENDPOINT environment variable is used.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Examples

- name: Disable a runtime addon by identifier
  cloudera.services.ml_runtime_addon:
    url: "https://ml-workspace.example.com"
    api_key: "{{ cml_api_key }}"
    identifiers:
      - hadoop-cli-7.2.18
    status: DISABLED

- name: Enable runtime addons by id
  cloudera.services.ml_runtime_addon:
    ids:
      - 1
      - 2
    status: AVAILABLE

Return Values

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

Key

Description

runtime_addon

dictionary

The result of the status change.

Returned: always

rows_affected

integer

The number of runtime addons whose status changed.

Returned: always

status

string

The status applied to the target runtime addons.

Returned: always

sdk_out

string

Returns the captured REST API log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured REST API log.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)