mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-16 01:45:25 -07:00
Docs: Clean up of 'template' module docs (#46297)
* Docs: Clean up of 'template' module docs * Changed influenced by review comments
This commit is contained in:
Dag Wieers
Alicia Cozine
parent
ba9348883b
commit
be0dc34b6f
2 changed files with 123 additions and 129 deletions
|
|
@ -1,7 +1,11 @@
|
|||
# this is a virtual module that is entirely implemented server side
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2017, Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# This is a virtual module that is entirely implemented as an action plugin and runs on the controller
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
|
@ -13,156 +17,152 @@ DOCUMENTATION = r'''
|
|||
---
|
||||
module: template
|
||||
version_added: historical
|
||||
short_description: Templates a file out to a remote server
|
||||
short_description: Template a file out to a remote server
|
||||
description:
|
||||
- Templates are processed by the Jinja2 templating language
|
||||
(U(http://jinja.pocoo.org/docs/)) - documentation on the template
|
||||
formatting can be found in the Template Designer Documentation
|
||||
(U(http://jinja.pocoo.org/docs/templates/)).
|
||||
- "Six additional variables can be used in templates:
|
||||
C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to
|
||||
describe the template name, host, modification time of the template file and the owner uid.
|
||||
C(template_host) contains the node name of the template's machine.
|
||||
C(template_uid) is the numeric user id of the owner.
|
||||
C(template_path) is the path of the template.
|
||||
C(template_fullpath) is the absolute path of the template.
|
||||
C(template_run_date) is the date that the template was rendered."
|
||||
- Templates are processed by the L(Jinja2 templating language,http://jinja.pocoo.org/docs/).
|
||||
- Documentation on the template formatting can be found in the
|
||||
L(Template Designer Documentation,http://jinja.pocoo.org/docs/templates/).
|
||||
- The six additional variables, listed below, can be used in template.
|
||||
- C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to
|
||||
describe the template name, host, modification time of the template file and the owner uid.
|
||||
- C(template_host) contains the node name of the template's machine.
|
||||
- C(template_uid) is the numeric user id of the owner.
|
||||
- C(template_path) is the path of the template.
|
||||
- C(template_fullpath) is the absolute path of the template.
|
||||
- C(template_run_date) is the date that the template was rendered.
|
||||
options:
|
||||
src:
|
||||
description:
|
||||
- Path of a Jinja2 formatted template on the Ansible controller. This can be a relative or absolute path.
|
||||
required: true
|
||||
- Path of a Jinja2 formatted template on the Ansible controller.
|
||||
- This can be a relative or an absolute path.
|
||||
required: yes
|
||||
dest:
|
||||
description:
|
||||
- Location to render the template to on the remote machine.
|
||||
required: true
|
||||
- Location to render the template to on the remote machine.
|
||||
required: yes
|
||||
backup:
|
||||
description:
|
||||
- Create a backup file including the timestamp information so you can get
|
||||
the original file back if you somehow clobbered it incorrectly.
|
||||
- Determine whether a backup should be created.
|
||||
- When set to C(yes), create a backup file including the timestamp information
|
||||
so you can get the original file back if you somehow clobbered it incorrectly.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
newline_sequence:
|
||||
description:
|
||||
- Specify the newline sequence to use for templating files.
|
||||
- Specify the newline sequence to use for templating files.
|
||||
choices: [ '\n', '\r', '\r\n' ]
|
||||
default: '\n'
|
||||
version_added: '2.4'
|
||||
block_start_string:
|
||||
description:
|
||||
- The string marking the beginning of a block.
|
||||
- The string marking the beginning of a block.
|
||||
default: '{%'
|
||||
version_added: '2.4'
|
||||
block_end_string:
|
||||
description:
|
||||
- The string marking the end of a block.
|
||||
- The string marking the end of a block.
|
||||
default: '%}'
|
||||
version_added: '2.4'
|
||||
variable_start_string:
|
||||
description:
|
||||
- The string marking the beginning of a print statement.
|
||||
- The string marking the beginning of a print statement.
|
||||
default: '{{'
|
||||
version_added: '2.4'
|
||||
variable_end_string:
|
||||
description:
|
||||
- The string marking the end of a print statement.
|
||||
- The string marking the end of a print statement.
|
||||
default: '}}'
|
||||
version_added: '2.4'
|
||||
trim_blocks:
|
||||
description:
|
||||
- If this is set to True the first newline after a block is removed (block, not variable tag!).
|
||||
- Determine when newlines should be removed from blocks.
|
||||
- When set to C(yes) the first newline after a block is removed (block, not variable tag!).
|
||||
type: bool
|
||||
default: 'yes'
|
||||
default: yes
|
||||
version_added: '2.4'
|
||||
lstrip_blocks:
|
||||
description:
|
||||
- If this is set to True leading spaces and tabs are stripped from the start of a line to a block.
|
||||
Setting this option to True requires Jinja2 version >=2.7.
|
||||
- Determine when leading spaces and tabs should be stripped.
|
||||
- When set to C(yes) leading spaces and tabs are stripped from the start of a line to a block.
|
||||
- This functionality requires Jinja v2.7 or newer.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
version_added: '2.6'
|
||||
force:
|
||||
description:
|
||||
- the default is C(yes), which will replace the remote file when contents
|
||||
are different than the source. If C(no), the file will only be transferred
|
||||
if the destination does not exist.
|
||||
- Determine when the file is being transferred if the destination already exists.
|
||||
- When set to C(yes), replace the remote file when contents are different than the source.
|
||||
- When set to C(no), the file will only be transferred if the destination does not exist.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
default: yes
|
||||
follow:
|
||||
description:
|
||||
- This flag indicates that filesystem links in the destination, if they exist, should be followed.
|
||||
- Previous to Ansible 2.4, this was hardcoded as C(yes).
|
||||
- Determine whether symbolic links should be followed.
|
||||
- When set to C(yes) symbolic links will be followed, if they exist.
|
||||
- When set to C(no) symbolic links will not be followed.
|
||||
- Previous to Ansible 2.4, this was hardcoded as C(yes).
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.4"
|
||||
mode:
|
||||
description:
|
||||
- "Mode the file or directory should be. For those used to I(/usr/bin/chmod) remember that
|
||||
modes are actually octal numbers. You must either add a leading zero so that Ansible's
|
||||
YAML parser knows it is an octal number (like C(0644) or C(01777)) or quote it
|
||||
(like C('644') or C('1777')) so Ansible receives a string and can do its own conversion from
|
||||
string into number. Giving Ansible a number without following one of these rules will end
|
||||
up with a decimal number which will have unexpected results. As of version 1.8, the mode
|
||||
may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)). As of
|
||||
version 2.6, the mode may also be the special string C(preserve). C(preserve) means that
|
||||
the file will be given the same permissions as the source file."
|
||||
default: no
|
||||
version_added: '2.4'
|
||||
output_encoding:
|
||||
description:
|
||||
- Overrides the encoding used to write the template file defined by C(dest).
|
||||
- It defaults to C('utf-8'), but any encoding supported by python can be used.
|
||||
- The source template file must always be encoded using C('utf-8'), for homogeneity.
|
||||
default: 'utf-8'
|
||||
version_added: "2.7"
|
||||
- Overrides the encoding used to write the template file defined by C(dest).
|
||||
- It defaults to C(utf-8), but any encoding supported by python can be used.
|
||||
- The source template file must always be encoded using C(utf-8), for homogeneity.
|
||||
default: utf-8
|
||||
version_added: '2.7'
|
||||
notes:
|
||||
- For Windows you can use M(win_template) which uses '\\r\\n' as C(newline_sequence).
|
||||
- Including a string that uses a date in the template will result in the template being marked 'changed' each time
|
||||
- "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)."
|
||||
- "Also, you can override jinja2 settings by adding a special header to template file.
|
||||
i.e. C(#jinja2:variable_start_string:'[%', variable_end_string:'%]', trim_blocks: False)
|
||||
which changes the variable interpolation markers to [% var %] instead of {{ var }}.
|
||||
This is the best way to prevent evaluation of things that look like, but should not be Jinja2.
|
||||
raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated."
|
||||
- You can use the C(copy) module with the C(content:) option if you prefer the template inline,
|
||||
as part of the playbook.
|
||||
- Including a string that uses a date in the template will result in the template being marked 'changed' each time.
|
||||
- Since Ansible version 0.9, templates are loaded with C(trim_blocks=True).
|
||||
- >
|
||||
Also, you can override jinja2 settings by adding a special header to template file.
|
||||
i.e. C(#jinja2:variable_start_string:'[%', variable_end_string:'%]', trim_blocks: False)
|
||||
which changes the variable interpolation markers to C([% var %]) instead of C({{ var }}).
|
||||
This is the best way to prevent evaluation of things that look like, but should not be Jinja2.
|
||||
- Using raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively
|
||||
evaluated.
|
||||
- You can use the M(copy) module with the C(content:) option if you prefer the template inline,
|
||||
as part of the playbook.
|
||||
- For Windows you can use M(win_template) which uses '\\r\\n' as C(newline_sequence) by default.
|
||||
author:
|
||||
- Ansible Core Team
|
||||
- Michael DeHaan
|
||||
- Ansible Core Team
|
||||
- Michael DeHaan
|
||||
extends_documentation_fragment:
|
||||
- files
|
||||
- validate
|
||||
- files
|
||||
- validate
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
# Example from Ansible Playbooks
|
||||
- template:
|
||||
- name: Template a file to /etc/files.conf
|
||||
template:
|
||||
src: /mytemplates/foo.j2
|
||||
dest: /etc/file.conf
|
||||
owner: bin
|
||||
group: wheel
|
||||
mode: 0644
|
||||
mode: '0644'
|
||||
|
||||
# The same example, but using symbolic modes equivalent to 0644
|
||||
- template:
|
||||
- name: Template a file, using symbolic modes (equivalent to 0644)
|
||||
template:
|
||||
src: /mytemplates/foo.j2
|
||||
dest: /etc/file.conf
|
||||
owner: bin
|
||||
group: wheel
|
||||
mode: "u=rw,g=r,o=r"
|
||||
|
||||
# Create a DOS-style text file from a template
|
||||
- template:
|
||||
- name: Create a DOS-style text file from a template
|
||||
template:
|
||||
src: config.ini.j2
|
||||
dest: /share/windows/config.ini
|
||||
newline_sequence: '\r\n'
|
||||
|
||||
# Copy a new "sudoers" file into place, after passing validation with visudo
|
||||
- template:
|
||||
- name: Copy a new sudoers file into place, after passing validation with visudo
|
||||
template:
|
||||
src: /mine/sudoers
|
||||
dest: /etc/sudoers
|
||||
validate: '/usr/sbin/visudo -cf %s'
|
||||
|
||||
# Update sshd configuration safely, avoid locking yourself out
|
||||
- template:
|
||||
- name: Update sshd configuration safely, avoid locking yourself out
|
||||
template:
|
||||
src: etc/ssh/sshd_config.j2
|
||||
dest: /etc/ssh/sshd_config
|
||||
owner: root
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue