cloudera.cluster.service module – Manage a service 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.service
.
New in cloudera.cluster 4.4.0
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 |
---|---|
Set the HTTP user agent header when interacting with the CM API endpoint. Default: |
|
The associated cluster of the service. |
|
A set of service-wide configurations for the service. To unset a configuration, use If |
|
Capture the HTTP interaction logs with the CM API endpoint. Choices:
|
|
The Cloudera Manager UI display name for the service. |
|
Flag to force TLS during CM API endpoint discovery. If Choices:
|
|
Hostname of the CM API endpoint. If set, the Mutually exclusive with url. |
|
Flag indicating if the service should be in maintenance mode. Choices:
|
|
The service to manage. This is a unique identifier within the cluster. |
|
Password for access to the CM API endpoint. This parameter is set to |
|
Port of the CM API endpoint. If set, CM API endpoint discovery will connect to the designated port first and will follow redirects. Default: |
|
Set the HTTP/S proxy server when interacting with the CM API endpoint. |
|
Flag indicating if the declared service-wide configurations, tags, role config groups, and role assignments and configurations should be append-only or fully reconciled. If set, the module will actively remove undeclared entries, e.g. remove roles. To clear all service-wide configurations and tags, set Choices:
|
|
List of base and named (custom) role config groups to declare and configure for the service. If |
|
A set of role config group configurations. To unset a configuration, use If |
|
The Cloudera Manager UI display name for the role config group. |
|
The name of a custom role config group. |
|
The role type of the base or named (custom) role config group. |
|
List of service roles to provision directly to cluster hosts. If |
|
A set of role override configurations for the role instance on the cluster hosts. To unset a configuration, use If |
|
List of hostnames of the cluster hosts receiving the role type instance. |
|
A named (custom) role config group to assign to the role instance on the cluster hosts. To unset the assignment, use |
|
A set of tags applied to the role type instance on the cluster hosts. To unset a tag, use If |
|
The role instance type to provision on the designated cluster hosts. |
|
Flag indicating if the declared service-wide configurations, tags, role config groups, and role assignments and configurations 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:
|
|
Path to SSL CA certificate to use for validation. |
|
The state of the service. Setting Choices:
|
|
A set of tags applied to the service. To unset a tag, use If |
|
The service type. Required if |
|
The CM API endpoint URL and should include scheme, host, port, and API root path. Mutually exclusive with host. |
|
Username for access to the CM API endpoint. |
|
Verify the TLS certificates for the CM API endpoint. Choices:
|
|
API version of the CM API endpoint. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platforms: all |
Target OS/families that can be operated against |
See Also
See also
- cloudera.cluster.service_info
Retrieve information about the services of cluster.
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: true
- 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: true
- 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: true
- name: Update (append) several service-wide configurations on a cluster service
cloudera.cluster.service:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
cluster: example_cluster
service: example_ecs
config:
param_one: 1
param_two: Two
- name: Update (purge) the service-wide configurations on a cluster service
cloudera.cluster.service:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
cluster: example_cluster
service: example_ecs
config:
param_one: 1
param_three: three
purge: true
- name: Remove all the service-wide configurations on a cluster service
cloudera.cluster.service:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
cluster: example_cluster
service: example_ecs
config: {}
purge: true
- name: Provision role instances on cluster hosts for a cluster service
cloudera.cluster.service:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
cluster: example_cluster
service: example_ecs
roles:
- type: SERVER
hostnames:
- host1.example
- host2.example
config:
param_one: 1
- name: Provision role config groups (base and named) for a cluster service
cloudera.cluster.service:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
cluster: example_cluster
service: example_ecs
role_config_group:
- name: custom_server_1
display_name: Custom Server (1)
role_type: SERVER
config:
param_two: Two
- role_type: SERVER # This is the base role config group for SERVER
config:
param_three: three
- name: Provision a cluster service with hosts, role config groups, and role assignments
cloudera.cluster.service:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
cluster: example_cluster
service: example_ecs
roles:
- type: SERVER
hostnames:
- host1.example
config:
param_two: Twelve
role_config_group: custom_server_1
- type: SERVER # Will use the base role config group for SERVER
hostnames:
- host2.example
role_config_group:
- name: custom_server_1
display_name: Custom Server (1)
role_type: SERVER
config:
param_two: Two
- role_type: SERVER # This is the base role config group for SERVER
config:
param_three: three
- 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 |
---|---|
Details about the service. Returned: success |
|
Status of the client configuration for the service. Returned: always Sample: |
|
The name of the cluster, which uniquely identifies it in a Cloudera Manager installation. Returned: always |
|
Service-wide configuration details about a cluster service. Returned: when supported |
|
Status of configuration staleness for the service. Returned: always Sample: |
|
The display name for the service that is shown in the Cloudera Manager UI. Returned: when supported |
|
Lists all available health checks for Cloudera Manager Service. Returned: when supported |
|
The explanation of this health check. Returned: when supported |
|
Unique name of this health check. Returned: always |
|
The high-level health status of the health check. Returned: always Sample: |
|
Whether this health check is suppressed. A suppressed health check is not considered when computing the service’s overall health. Returned: when supported |
|
The high-level health status of the service. Returned: always Sample: |
|
Whether the service is in maintenance mode. Returned: when supported |
|
The list of objects that trigger this service to be in maintenance mode. Returned: when supported Sample: |
|
The cluster service name. Returned: always |
|
List of base and custom role config groups for the cluster service. Returned: when supported |
|
Flag indicating whether this is a base group. Returned: always |
|
Set of configurations for the role config group. Returned: when supported |
|
A user-friendly name of the role config group, as would have been shown in the web UI. Returned: when supported |
|
The unique name of this role config group. Returned: always |
|
The type of the roles in this group. Returned: always |
|
List of provisioned role instances on cluster hosts for the cluster service. Returned: when supported |
|
Commission state of the cluster service role. Returned: always |
|
Set of role configurations for the cluster service role. Returned: when supported |
|
Status of configuration staleness for the cluster service role. Returned: always Sample: |
|
Lists all available health checks for cluster service role. Returned: when supported |
|
The explanation of this health check. Returned: when supported |
|
Unique name of this health check. Returned: always |
|
The high-level health status of the health check. Returned: always Sample: |
|
Whether this health check is suppressed. A suppressed health check is not considered when computing the role’s overall health. Returned: when supported |
|
The high-level health status of the cluster service role. Returned: always Sample: |
|
The unique ID of the cluster host. Returned: always |
|
The hostname of the cluster host. Returned: always |
|
Whether the cluster service role is in maintenance mode. Returned: when supported |
|
The list of objects that trigger this service to be in maintenance mode. Returned: when supported Sample: |
|
The cluster service role name. Returned: always |
|
The name of the cluster service role config group, which uniquely identifies it in a Cloudera Manager installation. Returned: when supported |
|
State of the cluster service role. Returned: always Sample: |
|
The dictionary of tags for the cluster service role. Returned: when supported |
|
The cluster service role type. Returned: always Sample: |
|
The Zookeeper server mode for this cluster service role. Note that for non-Zookeeper Server roles, this will be Returned: when supported |
|
State of the service. Returned: always Sample: |
|
Version of the service. Returned: when supported |
|
The dictionary of tags for the service. Returned: when supported |
|
The cluster service type. Returned: always Sample: |