mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 04:40:22 -07:00
Fix docs syntax highlighting errors (#50836)
* Add support for [WARNING]: ... * Fix unreachable/failed output lexing. * Detecting retry/--limit lines. * Removing strange (invisible) characters which cause lexing problems. * Using better-fitting lexers. * Improve YAML lexing: don't accept quotes in keys. * Add Django lexer (unchanged) from Pygments. * Add support for != and % operators.
This commit is contained in:
parent
6345ea2925
commit
f6122fb63b
9 changed files with 164 additions and 35 deletions
|
@ -55,7 +55,9 @@ Or for the openstack plugin:
|
|||
# clouds.yml
|
||||
plugin: openstack
|
||||
|
||||
The ``auto`` inventory plugin is enabled by default and works by using the ``plugin`` field to indicate the plugin that should attempt to parse it. You can configure the whitelist/precedence of inventory plugins used to parse source using the `ansible.cfg` ['inventory'] ``enable_plugins`` list. After enabling the plugin and providing any required options you can view the populated inventory with ``ansible-inventory -i demo.aws_ec2.yml --graph``::
|
||||
The ``auto`` inventory plugin is enabled by default and works by using the ``plugin`` field to indicate the plugin that should attempt to parse it. You can configure the whitelist/precedence of inventory plugins used to parse source using the `ansible.cfg` ['inventory'] ``enable_plugins`` list. After enabling the plugin and providing any required options you can view the populated inventory with ``ansible-inventory -i demo.aws_ec2.yml --graph``:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
@all:
|
||||
|--@aws_ec2:
|
||||
|
@ -88,7 +90,9 @@ You can create dynamic groups using host variables with the constructed ``keyed_
|
|||
# set the ansible_host variable to connect with the private IP address without changing the hostname
|
||||
ansible_host: private_ip_address
|
||||
|
||||
Now the output of ``ansible-inventory -i demo.aws_ec2.yml --graph``::
|
||||
Now the output of ``ansible-inventory -i demo.aws_ec2.yml --graph``:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
@all:
|
||||
|--@aws_ec2:
|
||||
|
|
|
@ -41,24 +41,20 @@ Using lookup plugins
|
|||
|
||||
Lookup plugins can be used anywhere you can use templating in Ansible: in a play, in variables file, or in a Jinja2 template for the :ref:`template <template_module>` module.
|
||||
|
||||
.. code-block:: yaml
|
||||
.. code-block:: YAML+Jinja
|
||||
|
||||
vars:
|
||||
file_contents: "{{lookup('file', 'path/to/file.txt')}}"
|
||||
|
||||
Lookups are an integral part of loops. Wherever you see ``with_``, the part after the underscore is the name of a lookup.
|
||||
This is also the reason most lookups output lists and take lists as input; for example, ``with_items`` uses the :ref:`items <items_lookup>` lookup:
|
||||
|
||||
.. code-block:: yaml
|
||||
This is also the reason most lookups output lists and take lists as input; for example, ``with_items`` uses the :ref:`items <items_lookup>` lookup::
|
||||
|
||||
tasks:
|
||||
- name: count to 3
|
||||
debug: msg={{item}}
|
||||
with_items: [1, 2, 3]
|
||||
|
||||
You can combine lookups with :ref:`playbooks_filters`, :ref:`playbooks_tests` and even each other to do some complex data generation and manipulation. For example:
|
||||
|
||||
.. code-block:: yaml
|
||||
You can combine lookups with :ref:`playbooks_filters`, :ref:`playbooks_tests` and even each other to do some complex data generation and manipulation. For example::
|
||||
|
||||
tasks:
|
||||
- name: valid but useless and over complicated chained lookups and filters
|
||||
|
@ -77,6 +73,8 @@ To ignore errors::
|
|||
- name: file doesnt exist, but i dont care .. file plugin itself warns anyways ...
|
||||
debug: msg="{{ lookup('file', '/idontexist', errors='ignore') }}"
|
||||
|
||||
.. code-block:: ansible-output
|
||||
|
||||
[WARNING]: Unable to find '/idontexist' in expected paths (use -vvvvv to see paths)
|
||||
|
||||
ok: [localhost] => {
|
||||
|
@ -89,6 +87,8 @@ To get a warning instead of a failure::
|
|||
- name: file doesnt exist, let me know, but continue
|
||||
debug: msg="{{ lookup('file', '/idontexist', errors='warn') }}"
|
||||
|
||||
.. code-block:: ansible-output
|
||||
|
||||
[WARNING]: Unable to find '/idontexist' in expected paths (use -vvvvv to see paths)
|
||||
|
||||
[WARNING]: An unhandled exception occurred while running the lookup plugin 'file'. Error was a <class 'ansible.errors.AnsibleError'>, original message: could not locate file in lookup: /idontexist
|
||||
|
@ -103,6 +103,8 @@ Fatal error (the default)::
|
|||
- name: file doesnt exist, FAIL (this is the default)
|
||||
debug: msg="{{ lookup('file', '/idontexist', errors='strict') }}"
|
||||
|
||||
.. code-block:: ansible-output
|
||||
|
||||
[WARNING]: Unable to find '/idontexist' in expected paths (use -vvvvv to see paths)
|
||||
|
||||
fatal: [localhost]: FAILED! => {"msg": "An unhandled exception occurred while running the lookup plugin 'file'. Error was a <class 'ansible.errors.AnsibleError'>, original message: could not locate file in lookup: /idontexist"}
|
||||
|
@ -120,7 +122,9 @@ The default behavior of ``lookup`` is to return a string of comma separated valu
|
|||
|
||||
This was done primarily to provide an easier and more consistent interface for interacting with the new ``loop`` keyword, while maintaining backwards compatibility with other uses of ``lookup``.
|
||||
|
||||
The following examples are equivalent::
|
||||
The following examples are equivalent:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
lookup('dict', dict_variable, wantlist=True)
|
||||
|
||||
|
@ -128,7 +132,9 @@ The following examples are equivalent::
|
|||
|
||||
As demonstrated above the behavior of ``wantlist=True`` is implicit when using ``query``.
|
||||
|
||||
Additionally, ``q`` was introduced as a shortform of ``query``::
|
||||
Additionally, ``q`` was introduced as a shortform of ``query``:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
q('dict', dict_variable)
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue