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

Note

This module is part of the cloudera.cluster collection (version 4.4.0).

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

Synopsis

  • Manage a service in a cluster.

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.

debug

aliases: debug_endpoints

boolean

Capture the HTTP interaction logs with the CM API endpoint.

Choices:

  • false ← (default)

  • true

display_name

string

The Cloudera Manager UI display name for the service.

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 service should be in maintenance mode.

Choices:

  • false

  • true

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 service tags should append or overwrite any existing tags.

To clear all tags, set tags={}, i.e. an empty dictionary, and purge=True.

Choices:

  • false ← (default)

  • true

service

aliases: service_name, name

string / required

The service.

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

state

string

The state of the service.

Choices:

  • "present" ← (default)

  • "absent"

  • "restarted"

  • "started"

  • "stopped"

tags

dictionary

A set of tags applied to the service.

To unset a tag, use None as its value.

type

aliases: service_type

string

The service type.

Required if state creates a new service.

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

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

Examples

- name: Establish a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    type: ECS
    display_name: Example ECS


- name: Stop a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    state: stopped

- name: Force a restart of a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    state: restarted

- name: Set a cluster service into maintenance mode
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    maintenance: yes

- name: Update (append) several tags on a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    tags:
      tag_one: valueOne
      tag_two: valueTwo

- name: Update (purge) the tags on a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    tags:
      tag_three: value_three
    purge: yes

- name: Remove all the tags on a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    tags: {}
    purge: yes

- name: Remove a cluster service
  cloudera.cluster.service:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example_cluster
    service: example_ecs
    state: absent

Return Values

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

Key

Description

service

dictionary

Details about the service.

Returned: success

client_config_staleness_status

string

Status of the client configuration for the service.

Returned: always

Sample: "['FRESH', 'STALE_REFRESHABLE', 'STALE']"

cluster_name

string

The name of the cluster, which uniquely identifies it in a Cloudera Manager installation.

Returned: always

config_staleness_status

string

Status of configuration staleness for the service.

Returned: always

Sample: "['FRESH', 'STALE_REFRESHABLE', 'STALE']"

display_name

string

The display name for the service that is shown in the Cloudera Manager UI.

Returned: when supported

health_checks

list / elements=dictionary

Lists all available health checks for Cloudera Manager Service.

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 service’s overall health.

Returned: when supported

health_summary

string

The high-level health status of the service.

Returned: always

Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"

maintenance_mode

boolean

Whether the service 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 name.

Returned: always

service_state

string

State of the service.

Returned: always

Sample: "['HISTORY_NOT_AVAILABLE', 'UNKNOWN', 'STARTING', 'STARTED', 'STOPPING', 'STOPPED', 'NA']"

service_version

string

Version of the service.

Returned: when supported

tags

dictionary

The dictionary of tags for the service.

Returned: when supported

type

string

The cluster service type.

Returned: always

Sample: "['HDFS', 'HBASE', 'ECS']"

Authors

  • Webster Mudge (@wmudge)

Collection links