cloudera.cluster.assemble_cluster_template module – Merge Cloudera Manager cluster template fragments
Note
This module is part of the cloudera.cluster collection (version 4.4.0).
To install it, use: ansible-galaxy collection install cloudera.cluster
.
To use it in a playbook, specify: cloudera.cluster.assemble_cluster_template
.
New in cloudera.cluster 4.2.0
Synopsis
Merge multiple Cloudera Manager cluster template files into a single cluster template file.
Often a cluster template file is composed of several services, host templates, and other parameters from multiple sources and/or configurations. cloudera.cluster.assemble_cluster_template will take a directory of cluster template configuration files that can be local or have already been transferred to the system and merge them together to produce a single, composite cluster template configuration file.
Files are merged in string sorting order.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
The attributes the resulting filesystem object should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr. The |
|
Create a backup file if The backup file name includes a timestamp. Choices:
|
|
This option controls the autodecryption of source files using vault. Choices:
|
|
A file created from the merger of the cluster template files. |
|
Name of the group that should own the filesystem object, as would be fed to chown. When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership. |
|
Flag whether to include files that begin with a ‘.’. Choices:
|
|
The permissions the resulting filesystem object should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, If If Specifying |
|
Name of the user that should own the filesystem object, as would be fed to chown. When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership. Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion. |
|
Merge files only if the given regular expression matches the filename. If not set, all files within Every |
|
Flag for the location of the cluster template fragment files. If If Choices:
|
|
The level part of the SELinux filesystem object context. This is the MLS/MCS attribute, sometimes known as the When set to |
|
The role part of the SELinux filesystem object context. When set to |
|
The type part of the SELinux filesystem object context. When set to |
|
The user part of the SELinux filesystem object context. By default it uses the When set to |
|
A directory of cluster template files, i.e. fragments. Each file must be a valid JSON file. |
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn’t force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller |
|
Support: none |
Supports being used with the |
|
Support: none |
Forces a ‘global’ task that does not execute per host, this bypasses per host templating and serial, throttle and other loop considerations Conditionals will work as if This action will not work normally outside of lockstep strategies |
|
Support: none |
Can run in check_mode and return changed status prediction without modifying target |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platform: posix |
Target OS/families that can be operated against |
|
Support: full |
Uses Ansible’s strict file operation functions to ensure proper permissions and avoid data corruption |
|
Support: full |
Can automatically decrypt Ansible vaulted files |
See Also
See also
- ansible.builtin.assemble
The official documentation on the ansible.builtin.assemble module.
- ansible.builtin.copy
The official documentation on the ansible.builtin.copy module.
- ansible.builtin.template
The official documentation on the ansible.builtin.template module.
- ansible.windows.win_copy
The official documentation on the ansible.windows.win_copy module.
Examples
---
- name: Assemble a cluster template from files (on the controller)
cloudera.cluster.assemble_cluster_template:
src: examples
dest: /opt/cloudera/cluster-template.json
- name: Assemble a cluster template from selected files (on the controller)
cloudera.cluster.assemble_cluster_template:
src: examples
dest: /opt/cloudera/cluster-template.json
regexp: "base|nifi"
- name: Assemble a cluster template from files on the target host
cloudera.cluster.assemble_cluster_template:
src: /tmp/examples
dest: /opt/cloudera/cluster-template.json
remote_src: yes
Authors
Webster Mudge (@wmudge)
Ronald Suplina (@rsuplina)
Jim Enright (@jenright)
Andre Araujo (@asdaraujo)
Collection links