mmorev / mmorev.hashicorp / 0.1.5 / module / consul_template Parses Go templates using consul-template and values from HashiCorp Vault and Consul | "added in version" 2.10 of mmorev.hashicorp" Authors: Mikhail Morev (@mmorev) preview | supported by community This plugin has a corresponding action plugin.mmorev.hashicorp.consul_template (0.1.5) — module
Install with ansible-galaxy collection install mmorev.hashicorp:==0.1.5
collections: - name: mmorev.hashicorp version: 0.1.5
Templates are processed by the L(consul-template,https://github.com/hashicorp/consul-template).
Documentation on the template formatting can be found on consul-template GitHub page.
Additional arguments listed below can be used in playbooks.
C(src) is a path to source Go-syntax template on Ansible controller
C(dest) is destination file path on destination machine
C(content) can contain inline template
C(consul_addr) specifies Consul server address
C(consul_token) specifies Consul authorization token
C(vault_addr) specifies Vault server address
C(vault_token) specifies Vault authorization token
src: description: - Path of a Go-formatted template file on the Ansible controller. - This can be a relative or an absolute path. - This can be remote path if C(remote_src) is set to C(yes) required: true type: path dest: description: - Location to place rendered template on the remote machine. required: true type: path mode: description: - The permissions the resulting filesystem object should have. - For those used to I(/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, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(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, V(u+rwx) or V(u=rw,g=r,o=r)). - If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object. - If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used. - Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details. type: raw group: description: - Name of the group that should own the filesystem object, as would be fed to I(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. type: str owner: description: - Name of the user that should own the filesystem object, as would be fed to I(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. type: str backup: default: false description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool serole: description: - The role part of the SELinux filesystem object context. - When set to V(_default), it will use the C(role) portion of the policy if available. type: str setype: description: - The type part of the SELinux filesystem object context. - When set to V(_default), it will use the C(type) portion of the policy if available. type: str seuser: description: - The user part of the SELinux filesystem object context. - By default it uses the V(system) policy, where applicable. - When set to V(_default), it will use the C(user) portion of the policy if available. type: str content: description: - When used instead of C(src), sets the contents of a source template to the specified text. - To avoid conflicts with Jinja2 template engine using ``!unsafe`` prefix is required! type: str selevel: description: - The level part of the SELinux filesystem object context. - This is the MLS/MCS attribute, sometimes known as the C(range). - When set to V(_default), it will use the C(level) portion of the policy if available. type: str validate: description: - The validation command to run before copying the updated file into the final destination. - A temporary file path is used to validate, passed in through '%s' which must be present as in the examples below. - Also, the command is passed securely so shell features such as expansion and pipes will not work. - For an example on how to handle more complex validation than what this option provides, see R(handling complex validation,complex_configuration_validation). type: str attributes: aliases: - attr description: - The attributes the resulting filesystem object should have. - To get supported flags look at the man page for I(chattr) on the target system. - This string should contain the attributes in the same order as the one displayed by I(lsattr). - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. type: str version_added: '2.3' version_added_collection: ansible.builtin remote_src: default: false description: - Set to C(yes) to indicate the template file is on the remote system and not local to the Ansible controller. - This option is mutually exclusive with C(content). type: bool vault_addr: description: - Vault server URL env: - name: VAULT_ADDR type: str consul_addr: description: - Consul server URL type: str vault_token: description: - Vault authorization token env: - name: VAULT_TOKEN type: str consul_token: description: - Consul authorization token env: - name: CONSUL_TOKEN type: str unsafe_writes: default: false description: - 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. type: bool version_added: '2.2' version_added_collection: ansible.builtin