Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update playbooks_error_handling.rst #2095

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Update playbooks_error_handling.rst #2095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/docsite/rst/playbook_guide/playbooks_error_handling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,30 @@ You can also combine multiple conditions to override "changed" result.
- '"ERROR" in result.stderr'
- result.rc == 2

If you want to introduce your own variables, to avoid repeating a certain term, you can simply reference them in your conditionals
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you want to introduce your own variables, to avoid repeating a certain term, you can simply reference them in your conditionals
You can reference simple variables in conditionals to avoid repeating certain terms, as in the following example:


.. code-block:: yaml

- name: Example playbook
hosts: myHosts
vars:
log_path: /home/ansible/logfolder/
log_file: log.log

tasks:
- name: Create empty log file
ansible.builtin.shell: mkdir {{ log_path }} || touch {{log_path }}{{ log_file }}
register: tmp
changed_when:
- tmp.rc == 0
- 'tmp.stderr != "mkdir: cannot create directory ‘" ~ log_path ~ "’: File exists"'

.. note::
Notice the missing ``{{ }}`` around log_path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Notice the missing ``{{ }}`` around log_path.
Notice the missing double curly braces ``{{ }}`` around the ``log_path`` variable in the ``changed_when`` statement.


Just like ``when`` these two conditionals do not require templating delimiters (``{{ }}``) as they are implied.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Just like ``when`` these two conditionals do not require templating delimiters (``{{ }}``) as they are implied.
Just like ``when`` these two conditionals do not require templating delimiters (``{{ }}``) because they are raw Jinja2 expressions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could add a link to this section of the docs: https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html#basic-conditionals-with-when


Just like ``when`` these two conditionals do not require templating delimiters (``{{ }}``) as they are implied.
If you still use them, ansible will raise a warning ``[WARNING]: conditional statements should not include jinja2 templating delimiters such as {{ }} or {% %}.``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should include the exact warning text here. Granted this might be helpful to users who search for the warning but it adds maintenance overhead to the docs. I also don't believe it's good practice to document errors and warnings - better to document just the behaviour.


See :ref:`controlling_what_defines_failure` for more conditional syntax examples.

Expand Down