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

attributes

aliases: attr

string

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 = operator is assumed as default, otherwise + or - operators need to be included in the string.

backup

boolean

Create a backup file if true.

The backup file name includes a timestamp.

Choices:

  • false ← (default)

  • true

decrypt

boolean

This option controls the autodecryption of source files using vault.

Choices:

  • false

  • true ← (default)

dest

aliases: cluster_template

path / required

A file created from the merger of the cluster template files.

group

string

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.

ignore_hidden

boolean

Flag whether to include files that begin with a ‘.’.

Choices:

  • false

  • true ← (default)

mode

any

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, '644' or '1777') so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, 0755) works sometimes, but can fail in loops and some other circumstances.

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, u+rwx or u=rw,g=r,o=r).

If mode is not specified and the destination filesystem object does not exist, the default umask on the system will be used when setting the mode for the newly created filesystem object.

If mode is not specified and the destination filesystem object does exist, the mode of the existing filesystem object will be used.

Specifying mode is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details.

owner

string

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.

regexp

aliases: filter, regex

string

Merge files only if the given regular expression matches the filename.

If not set, all files within src are merged.

Every \ (backslash) must be escaped as \\ to conform to YAML syntax.

See Python regular expressions.

remote_src

boolean

Flag for the location of the cluster template fragment files.

If false, search for src on the controller.

If true, search for src on the remote/target.

Choices:

  • false ← (default)

  • true

selevel

string

The level part of the SELinux filesystem object context.

This is the MLS/MCS attribute, sometimes known as the range.

When set to _default, it will use the level portion of the policy if available.

serole

string

The role part of the SELinux filesystem object context.

When set to _default, it will use the role portion of the policy if available.

setype

string

The type part of the SELinux filesystem object context.

When set to _default, it will use the type portion of the policy if available.

seuser

string

The user part of the SELinux filesystem object context.

By default it uses the system policy, where applicable.

When set to _default, it will use the user portion of the policy if available.

src

aliases: cluster_template_src

path / required

A directory of cluster template files, i.e. fragments.

Each file must be a valid JSON file.

unsafe_writes

boolean

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:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

action

Support: full

Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller

async

Support: none

Supports being used with the async keyword

bypass_host_loop

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 run_once is being used, variables used will be from the first available host

This action will not work normally outside of lockstep strategies

check_mode

Support: none

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

Platform: posix

Target OS/families that can be operated against

safe_file_operations

Support: full

Uses Ansible’s strict file operation functions to ensure proper permissions and avoid data corruption

vault

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