cloudera.cluster.role module – Manage a service role in cluster

Note

This module is part of the cloudera.cluster collection (version 5.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 cloudera.cluster. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cluster.role.

New in cloudera.cluster 4.4.0

Synopsis

• Manage a service role in a cluster.

Aliases: service_role

Requirements

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

• cm-client

Parameters

Parameter	Comments
agent_header aliases: user_agent string	Set the HTTP user agent header when interacting with the CM API endpoint. Default: "ClouderaFoundry"
cluster aliases: cluster_name string / required	The associated cluster.
cluster_host_id string	The host ID of a cluster instance for the role. Mutually exclusive with cluster_hostname. Either cluster_host_id or cluster_hostname must be provided if type is present.
cluster_hostname aliases: cluster_host string	The hostname of a cluster instance for the role. Mutually exclusive with cluster_host_id. Either cluster_host_id or cluster_hostname must be provided if type is present.
config aliases: params, parameters dictionary	The role configuration overrides to set. To unset a parameter, use None as the value.
debug aliases: debug_endpoints boolean	Capture the HTTP interaction logs with the CM API endpoint. Choices: false ← (default) true
force_tls boolean	Flag to force TLS during CM API endpoint discovery. If False, discovery will first try HTTP and follow any redirects. Choices: false ← (default) true
host aliases: hostname string	Hostname of the CM API endpoint. If set, the host parameter will trigger CM API endpoint discovery, which will follow redirects. Mutually exclusive with url.
maintenance aliases: maintenance_mode boolean	Flag for whether the role should be in maintenance mode. Choices: false true
message aliases: msg string	Message to log for any changes to the entity. Default: "Managed by Ansible"
name aliases: role_name, role string	The role name, i.e. the auto-generated identifier. Either name or type must be provided.
password string / required	Password for access to the CM API endpoint. This parameter is set to no_log.
port integer	Port of the CM API endpoint. If set, CM API endpoint discovery will connect to the designated port first and will follow redirects. Default: 7180
proxy_server aliases: proxy, http_proxy string	Set the HTTP/S proxy server when interacting with the CM API endpoint.
purge boolean	Flag for whether the declared role configuration overrides and tags should append or overwrite any existing entries. To clear all configuration overrides or tags, set config={} or tags={}, i.e. an empty dictionary, respectively, and set purge=True. Choices: false ← (default) true
role_config_group string	The role configuration group name to assign to the role. To assign the base role configuration group, i.e. the default, set role_config_group=None.
service aliases: service_name string / required	The associated service.
skip_redacted aliases: redacted boolean	Flag indicating if the declared role configurations overrides and tags should skipped REDACTED parameters during reconciliation. If set, the module will not attempt to update any existing parameter with a REDACTED value. Otherwise, the parameter value will be overridden. Choices: false ← (default) true
ssl_ca_cert aliases: tls_cert, ssl_cert path	Path to SSL CA certificate to use for validation.
state string	The state of the role. Note, if the declared state is invalid for the role type, for example, HDFS GATEWAY, the module will return an error. Choices: "present" ← (default) "absent" "restarted" "started" "stopped"
tags dictionary	A set of tags applied to the role. To unset a tag, use None as its value.
type aliases: role_type string	A role type for the role. Either name or type must be provided. Required to provision a new role.
url aliases: endpoint, cm_endpoint_url string	The CM API endpoint URL and should include scheme, host, port, and API root path. Mutually exclusive with host.
username aliases: user string / required	Username for access to the CM API endpoint.
verify_tls boolean	Verify the TLS certificates for the CM API endpoint. Choices: false true ← (default)
version aliases: api_version string	API version of the CM API endpoint. Default: "True"

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
platform	Platforms: all	Target OS/families that can be operated against

See Also

See also

cloudera.cluster.role_info

Retrieve information about the service roles of cluster.

Examples

- name: Provision a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    cluster_hostname: worker-01.cloudera.internal

- name: Set a service role to maintenance mode (using role name)
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    name: example-GATEWAY
    maintenance: true

- name: Update (append) tags to a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    cluster_hostname: worker-01.cloudera.internal
    tags:
      tag_one: value_one
      tag_two: value_two

- name: Set (purge) tags to a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    cluster_hostname: worker-01.cloudera.internal
    tags:
      tag_three: value_three
    purge: true

- name: Remove all tags on a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    cluster_hostname: worker-01.cloudera.internal
    tags: {}
    purge: true

- name: Start a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    cluster_hostname: worker-01.cloudera.internal
    state: started

- name: Force a restart to a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    cluster_hostname: worker-01.cloudera.internal
    state: restarted

- name: Remove a service role
  cloudera.cluster.role:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-hdfs
    type: GATEWAY
    state: absent

Return Values

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

Key	Description
role dictionary	Details about the service role. Returned: always
commission_state string	Commission state of the cluster service role. Returned: always
config dictionary	Set of role configurations for the cluster service role. Returned: when supported
config_staleness_status string	Status of configuration staleness for the cluster service role. Returned: always Sample: "['FRESH', 'STALE_REFRESHABLE', 'STALE']"
health_checks list / elements=dictionary	Lists all available health checks for cluster service role. Returned: when supported
explanation string	The explanation of this health check. Returned: when supported
name string	Unique name of this health check. Returned: always
summary string	The high-level health status of the health check. Returned: always Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"
suppressed boolean	Whether this health check is suppressed. A suppressed health check is not considered when computing the role’s overall health. Returned: when supported
health_summary string	The high-level health status of the cluster service role. Returned: always Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"
host_id string	The unique ID of the cluster host. Returned: always
maintenance_mode boolean	Whether the cluster service role is in maintenance mode. Returned: when supported
maintenance_owners list / elements=string	The list of objects that trigger this service to be in maintenance mode. Returned: when supported Sample: ["CLUSTER", "SERVICE", "ROLE", "HOST", "CONTROL_PLANE"]
name string	The cluster service role name. Returned: always
role_config_group_name string	The name of the cluster service role config group, which uniquely identifies it in a Cloudera Manager installation. Returned: when supported
role_state string	State of the cluster service role. Returned: always Sample: "['HISTORY_NOT_AVAILABLE', 'UNKNOWN', 'STARTING', 'STARTED', 'STOPPING', 'STOPPED', 'NA']"
service_name string	The name of the cluster service, which uniquely identifies it in a cluster. Returned: always
tags dictionary	The dictionary of tags for the cluster service role. Returned: when supported
type string	The cluster service role type. Returned: always Sample: "['NAMENODE', 'DATANODE', 'TASKTRACKER']"
zoo_keeper_server_mode string	The Zookeeper server mode for this cluster service role. Note that for non-Zookeeper Server roles, this will be null. Returned: when supported

Authors

• Webster Mudge (@wmudge)

Collection Links

• Issue Tracker
• Repository (Sources)
• Submit a Bug Report
• Request a Feature