cloudera.services.ml_runtime module – Register or set the status of a Cloudera Machine Learning (CML) runtime

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.

New in cloudera.services 1.0.0

Synopsis

  • Register a custom Cloudera Machine Learning (CML) runtime from a container image, or set the status of existing runtimes.

  • There is no hard delete for runtimes; set status=DISABLED to retire a runtime.

  • 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

docker_credential_id

string

The identifier of the Docker credential to use when registering the image.

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"

image_identifier

string

The image identifier of an existing runtime to target for a status change.

Used with status.

image_url

aliases: registry_url

string

The container registry URL of the custom runtime image to register.

Mutually exclusive with status.

page_size

aliases: default_page_size

integer

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

Default: 100

runtime_id

integer

The numeric identifier of an existing runtime to target for a status change.

Used with status.

status

string

The status to set on the target runtime(s).

Requires image_identifier or runtime_id.

Mutually exclusive with image_url.

Choices:

  • "ENABLED"

  • "DISABLED"

  • "DEPRECATED"

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

boolean

Whether to validate the runtime image before registering it.

Choices:

  • false ← (default)

  • true

validate_certs

boolean

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

Choices:

  • false

  • true ← (default)

Examples

- name: Register a custom runtime
  cloudera.services.ml_runtime:
    url: "https://ml-workspace.example.com"
    api_key: "{{ cml_api_key }}"
    image_url: registry.example.com/custom-runtime:1.0
    validate: true

- name: Disable a runtime by image identifier
  cloudera.services.ml_runtime:
    image_identifier: registry.example.com/custom-runtime:1.0
    status: DISABLED

Return Values

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

Key

Description

runtime

dictionary

The result of the operation.

For a registration, the validation/insert result and image details.

For a status change, the number of rows affected and the applied status.

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)