Commit graph

172 commits

Author SHA1 Message Date
Alicia Cozine
02baae6e99 revises inventory intro page (#49330)
* revises inventory intro page

* changes :doc: to :ref: for links
2018-11-29 16:33:29 -05:00
Alicia Cozine
e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 14:03:00 -06:00
Brian Coca
8461321a6a clarify registered vs facts (#45432)
* clarify registered vs facts

fixes #45411

* wordsmithing
2018-11-29 15:00:36 -05:00
David M Noriega
0922a6566d Adding note on async+check mode incompatibility (#41427)
Fixes ansible/ansible#40991
2018-11-29 10:33:43 -05:00
Evgeni Golov
7c61ce153f clarify what strict means for the version test (#48979)
Reference the fact that we use the `StrictVersion` parser instead of `LooseVersion` from `distutils` in this case.
2018-11-26 15:55:25 -06:00
Will Thames
960ebd981f k8s append_hash (#48830)
* Add append_hash functionality to k8s module

append_hash adds a hash based on the contents of a ConfigMap
or Secret to the name - this enables immutable ConfigMaps and
Secrets.

* Provide k8s_config_resource_name plugin

The k8s_config_resource_name filter plugin provides a means of determining
the name of ConfigMaps and Secrets created with append_hash

* Add changelog fragment

* fix failing tests

* Update openshift version needed for append_hash
2018-11-22 08:14:43 +00:00
Andreas Krüger
e1fbd54ebb Add link to include / import module doc to discussion of include / import. (#48932) 2018-11-20 14:02:58 -06:00
Dag Wieers
fd02ecd290 Code example improvements in Windows documentation (#45055)
This PR includes:
- Using explicit yaml+jinja code-blocks
- Work around pygments lexer issues with colons (in URLs and options)
2018-11-15 16:17:29 -05:00
Toshio Kuratomi
b759862daa Add an example to serial usage (#48669) 2018-11-14 11:57:10 -05:00
Lars Kellogg-Stedman
220d224433 add note regarding {host,group}_vars directory lookup semantics (#48066)
* add note regarding {host,group}_vars directory lookup semantics

While the 'ansible-playbook' command will look for {host,group}_vars in
both the playbook and inventory directories, the 'ansible' command
will only look in the inventory directory. This follows from a close
reading of the documentation but isn't explicit and leads to the
perhaps unexpected result that you can run both commands with the same
configuration in the same directory and get different results.

This commit adds a note to the documentation making the difference in
behavior explicit.

Closes #48065

* incorporates bcoca feedback
2018-11-09 15:22:23 -05:00
Alicia Cozine
d27d956d71 clarifies FAQ answer about env vars (#48432) 2018-11-09 14:31:29 -05:00
Andreas Krüger
e2bba149d6 playbooks_reuse_roles.rst long and shorthand example actually made equivalent. (#48339) 2018-11-08 08:28:16 -06:00
Rushan
cc5b9c5fe1 enchance yaml filter documentation (#46629)
* update to_*_yaml filter documentation

* update to*_yaml filter documentation
2018-11-07 20:23:46 -05:00
Matt Martz
f728f2bff0
Add a new "contains" jinja2 test (#45798)
* Add contains jinja2 test

* backticks
2018-11-07 14:49:00 -06:00
Brian Coca
8ccb44aa63 clarify insane ini typing (#48169)
* clarify how variables are interpreted in the ini inventory plugin
2018-11-07 14:19:23 -06:00
Mark Jeromin
8d2f6c31de updated user_guide for regex test, #24155 (#47893) 2018-11-02 15:53:55 -05:00
mbk87
5ab30e0079 protocol (#47666)
* clarifies reference to SSH, adds link for further reading
2018-11-02 14:02:13 -05:00
Risto Oikarinen
4b2a090418 Fix vars_prompt "private" description and improve example (#47688)
* Fix vars_prompts "private" description and improve example

* Fix indentation
2018-11-02 14:57:39 -04:00
Risto Oikarinen
f000baf6f7 Add yaml version of using host variables example (#47700) 2018-11-02 14:50:42 -04:00
Moritz Grimm
1a91b797bd updated documentation fixing #47202 (#47267) 2018-10-31 09:36:35 -05:00
Alicia Cozine
7db63851e0 Updates variables docs: facts examples, headers, links, etc. (#47767)
* refreshes ansible facts output and updates some references/headers
2018-10-30 11:37:34 -04:00
Abhijeet Kasurde
6d36849f72 Update plugin filter documentation (#46665)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-10-29 15:04:32 -04:00
mbk87
24e1da972e bad space (#47667)
removes whitespace
2018-10-28 18:55:25 -05:00
Andrea Perotti
8bc4a18500 Updates intro to dynamic inventory page (#46799)
* Added Foreman to the list of inventory scripts
2018-10-26 18:35:44 +01:00
Matt Martz
f7ba63e047
Add shorthand debugger method to recreate the task from the original ds (#46987)
* Add shorthand debugger method to recreate the task from the original ds, and re-template. Fixes #46321

* Fix rst header

* Indicate update_task was added in 2.8
2018-10-25 16:35:59 -05:00
Simon Legner
5959158612 doc(user_guide): fix typos (#47425) 2018-10-24 12:01:24 -04:00
Artem Zinenko
3fa33ce96b Fixed typos in winrm doc (#47351) 2018-10-19 10:34:03 -04:00
Adam Miller
9e2c02455a add note about named tasks in blocks (#46984)
* add note about named tasks in blocks

Signed-off-by: Adam Miller <admiller@redhat.com>

* adds names to tasks within example block, removes 2nd example

* removes traces of bad rebase
2018-10-18 16:24:52 -04:00
Petr Ruzicka
53217a3dbd with_items is obsolete - using loop instead (#46806) 2018-10-16 15:54:09 -05:00
Petr Ruzicka
559c92f9b6 with_items is obsolete - using loop instead (#46805) 2018-10-16 15:53:22 -05:00
Petr Ruzicka
b17f02a89a with_items is obsolete - loop should be used instead (#46524) 2018-10-16 15:52:32 -05:00
Alicia Cozine
b26aa66a41
fixes local toc, updates language (#47054) 2018-10-15 08:39:06 -05:00
Sandra McCann
db3d920cfd WIP: fix build errors due to missing certified_supported label (#46835)
* fix build errors due to missing certified_supported label

* fixed references and toc
2018-10-14 19:08:06 -05:00
Risto Oikarinen
e1cfc2500c Clean playbook filters doc by adding whitespaces (#46569) 2018-10-11 09:02:12 -05:00
Dag Wieers
1771874ac8 Indentation 2018-10-10 01:52:44 +02:00
Dag Wieers
d0f3aaff62 Update wording as requested by review
Also improve wording.
2018-10-10 01:52:44 +02:00
Hayden
a2ac3482b6 Update windows_faq.rst
<!--- Your description here -->

+label: docsite_pr

Windows Subsystem for Linux is now officially supported by Microsoft. It is out of beta and will be shipping on Windows Sever 2019.
2018-10-10 01:52:44 +02:00
Dag Wieers
92037679c4 Fix subelements example correctly (#46482) 2018-10-04 14:18:00 -05:00
Andrew Paradi
641c569a20 Fix spelling error in subelements Filter example (#46446)
<!--- Your description here -->

+label: docsite_pr
2018-10-03 21:54:36 -05:00
Enno Gröper
1ff331e66a Update playbooks_delegation.rst (#46254)
Fix example variable lookup.

+label: docsite_pr
2018-09-28 13:38:52 -05:00
Brendan Jurd
ab96bbdef9 Clean up Vault docs in User Guide. (#46188)
* Fix spelling of 'separate' throughout.

* Various cleanups in the User Guide for Vault.

- Fix spelling of 'algorithm'
- Fix indentation of nested list in payload format
- Fix mysterious refernce to 'b_pkey1'.
- Fix reference to newline as '\n': the backslash is lost when rendered
to the docs website. Specify the hex value for newline instead of the
backslash escape.

* Fix formatting

* Update vault.rst
2018-09-28 10:16:58 -04:00
Sam Doran
4c929d3a7a Correct loop syntax in example (#46178) 2018-09-27 11:55:11 -04:00
Deric Crago
065b7ac300 moved 'strftime' filter into 'Other Useful Filters' section (#45801) 2018-09-27 11:52:50 -04:00
Peter Sprygada
1e68881c40 adds support for null values to the ternary filter (#45303)
* adds support for null values to the ternary filter

This change adds a third optional argument to the ternary filter to
handle a null value.  If the third option is specified null and false
are treated differently.

For instance, take the following example:

{{ enabled | ternary('no shutdown', 'shutdown') }}

If enabled == True, then 'no shutdown' is used.
If enabled in (False, None), then 'shutdown' is used.

With this change the following is possible:

{{ enabled | ternary('no shutdown', 'shutdown', omit) }}

If enabled == True, then 'no shutdown'
If enabled == False, then 'shutdown'
If enabled == None, then omit

* update documentation with example of filter

* update filter documentation example per comments

* fix logic error in user_guide example
2018-09-24 18:57:19 -04:00
Mark Phillips
76a0323918 Changed hash_merge to link for ANSIBLE_HASH_BEHAVIOUR (#45996)
* Changed hash_merge, which goes nowhere, to link for ANSIBLE_HASH_BEHAVIOUR
* Changed link as per bcoca suggestion
2018-09-24 15:03:55 -05:00
Omar Osman
623f803e0b update example to YAML style in documentation (#45968)
The example is in a key=value format which is deprecated.

+label: docsite_pr
2018-09-21 08:42:31 -05:00
Owen Kuemerle
4e532e0ad9 Add workaround for non-standard kerberos environments (#41465)
* Add workaround for non-standard MIT kerberos environments

* Generalize platform specific troubleshooting steps for Kerberos
2018-09-18 09:33:09 -05:00
Raymond Wanyoike
c41632fad2 Add the key_name/value_name options to the dict2items filter (#45550)
* Add the key_name/value_name options to dict2items - as with items2dict, allow users to configure the key/value name for dict2items, add "version added" and examples
2018-09-17 15:53:52 -05:00
Dag Wieers
6999bf318f Fix link and toctree (#45595) 2018-09-13 12:38:49 -05:00
FloMiau
e35c4be1c1 Change "Defaulting Undefined Variables" (#41379)
Rewording the text for the second parameter of default because the original text was misunderstandable. +label: docsite_pr
2018-09-12 14:52:22 -05:00