Commit graph

606 commits

Author SHA1 Message Date
Rick Elrod
0d7c144ce4
Allow macOS ACLs to work for unpriv -> unpriv ()
Change:
- Use `chmod +a` in the fallback chain to allow MacOS to use ACLs to
  allow an unprivileged user to become an unprivileged user.

Test Plan:
- CI, new tests

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-04 14:32:48 -04:00
Abhijeet Kasurde
a6725d6e2a
docs: Add a note about package requirements for fact gathering ()
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-03 12:09:40 -05:00
Brendon O'Sullivan
9850915bd6
Update intro_getting_started.rst ()
Added two additional learning resources in the See also: section- forgot closing backticks
2020-08-03 10:35:36 -05:00
Rick Elrod
701c638757
Document string tests a bit more ()
- Explain how `regex` differs from `match` and `search`.
- Document `multiline` and `ignorecase`.

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-03 10:19:20 -05:00
Baptiste Mille-Mathias
8c48366f1c
Document to_json will convert to ASCII strings by default ()
... as reported in issue 
2020-07-30 14:45:40 -05:00
Emilien Macchi
37e9d2278a
Fix a typo in "restart mysql" example ()
Fix a typo in "restart mysql" example task. It's missing a space between "state:" and "restarted".
2020-07-29 11:46:16 +05:30
Fixmetal
7a42d27462
Proper example for splitext filter in docs ()
* Update playbooks_filters.rst with a clear example of how to extract its 2 tokens. 

Co-authored-by: Sloane Hertel <shertel@redhat.com>
2020-07-23 15:07:55 -05:00
Sandra McCann
24e5d3a51c
fix rstcheck problem and gitignore collections dir () 2020-07-21 15:59:56 -05:00
David Rieger
633c2d0522
Fix misleading documentation for naming blocks ()
From what I have observed it is the block itself that doesn't support the name attribute rather than the tasks inside the block.

* Update docs/docsite/rst/user_guide/playbooks_blocks.rst

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-07-20 09:48:53 -05:00
Toshio Kuratomi
9dda393d70
Collections docs generation ()
* Build documentation for Ansible-2.10 (formerly known as ACD).

Builds plugin docs from collections whose source is on galaxy

The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.

* Update the python syntax checks
  * docs builds can now require python 3.6+.

* Move plugin formatter code out to an external tool, antsibull-docs.
  Collection owners want to be able to extract docs for their own
  websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs

* Cleanup and bugfix to other build script code:
  * The Commands class needed to have its metaclass set for abstractmethod
    to work correctly
  * Fix lint issues in some command plugins

* Add the docs/docsite/rst/collections to .gitignore as
  everything in that directory will be generated so we don't want any of
  it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages

* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs

* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined

* Remove references to plugin documentation locations that no longer exist.
  * Perhaps the pages in plugins/*.rst should be deprecated
    altogether and their content moved?
  * If not, perhaps we want to rephrase and link into the collection
    documentation?
  * Or perhaps we want to link to the plugins which are present in
    collections/ansible/builtin?

* Remove PYTHONPATH from the build-ansible calls
  One of the design goals of the build-ansible.py script was for it to
  automatically set its library path to include the checkout of ansible
  and the library of code to implement itself.  Because it automatically
  includes the checkout of ansible, we don't need to set PYTHONPATH in
  the Makefile any longer.

* Create a command to only build ansible-base plugin docs
  * When building docs for devel, only build the ansible-base docs for
    now.  This is because antsibull needs support for building a "devel
    tree" of docs.  This can be changed once that is implemented
  * When building docs for the sanity tests, only build the ansible-base
    plugin docs for now.  Those are the docs which are in this repo so
    that seems appropriate for now.
2020-07-17 13:07:35 -07:00
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 () 2020-07-14 17:00:44 -04:00
Karl Goetz
c410311f55
Clarify that index_var is 0 indexed ()
A little further down the page is another index, ansible_loop.index, which shares a similar description but is 1 indexed.
Its zero indexed twin has a 0 suffix.

``ansible_loop.index``      The current iteration of the loop. (1 indexed)
``ansible_loop.index0``     The current iteration of the loop. (0 indexed)

To remove ambiguity around the usage of index_var, explicitly mention that this variable is 0 indexed.
2020-07-13 14:15:44 -05:00
mahadelmi
f4ea43c4a0
Update windows_winrm.rst ()
gcc also needed to be installed alongside python-devel, krb5-devel, krb5-libs, and krb5-workstation.
2020-07-13 13:43:39 -05:00
FloMiau
f7db428375
update documentation link to python 3 ()
update the docs link for strftime on the filters page to point to the python3 docs
2020-07-09 11:58:39 -05:00
David Shrewsbury
4e41e37aa7
Fix flatten null perserve versionadded () 2020-07-02 13:28:39 -05:00
Baptiste Mille-Mathias
9eb904ea61
Add documentation for ipaddr filters () 2020-07-02 11:17:46 -04:00
jafiala
7c90a2d2a6
Update playbooks.rst () 2020-07-02 11:11:09 -04:00
Brian Coca
7a15a3a109
fix flatten handling of nulls/nones ()
* fix flatten loop control issue (break -> continue)

fix issue 

(cherry picked from commit 2127be5ec5)

* fixed null break bug and added option to include

 fixes 
 fixes 

Co-authored-by: pseudocoder <borisovano@users.noreply.github.com>
Co-authored-by: David Shrewsbury <Shrews@users.noreply.github.com>
2020-07-01 18:52:03 -04:00
Brian Coca
5d3d097de3
more correct info about role main.yml ()
fixes 
2020-07-01 16:16:21 -04:00
Alicia Cozine
c89f3cda9e
incorporate minimalism feedback on filters page ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-01 16:15:32 -04:00
Rick Elrod
91aea92c62
Add ability to fallback to chgrp remote_tmp and its files. ()
* Add ability to fallback to chgrp remote_tmp and its files.

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-07-01 15:16:56 -04:00
Mark Sanders
dc6f4b6502
Fix bullet points in intro_getting_started.rst. ()
The layout was jumbled due to issues with whitespace.
2020-06-29 14:05:05 -05:00
Gonéri Le Bouder
b491f776b9
doc: avoid mix of single and double quotes ()
Avoid mix of single and double quotes in the `ternary`, this way
we can copy/past the example without any surprise.
2020-06-29 09:16:20 -05:00
Adam Miller
3c9be97e16
fix runtime.yml splunk.enterprise_security -> splunk.es ()
Signed-off-by: Adam Miller <admiller@redhat.com>
2020-06-25 18:34:11 +01:00
Abhijeet Kasurde
40a42de081
async_status: Update documentation ()
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-06-23 11:45:54 -04:00
Westley Argentum Hennigh-Palermo
5885ed4455
remove gendered example ()
Changed example to not assume things about names and genders
2020-06-19 14:35:03 -05:00
Allen
fb9740db4c
Specify numeric range can contain a stride ()
Updated the range creation example to show that you can also specify a stride value when creating a hostname by numeric range.
2020-06-16 11:31:00 -05:00
Alicia Cozine
851e8e18b2
clarifies that vars can begin with _, with a warning ()
Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com>

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com>
2020-06-11 14:16:41 -04:00
Matt Martz
9667f221a5
Make AnsibleVaultEncryptedUnicode work more like a string ()
* Make AnsibleVaultEncryptedUnicode work more like a string. Fixes 

* Remove debugging

* Wrap some things

* Reduce diff

* data should always result in text

* add tests

* Don't just copy and paste, kids

* Add eq and ne back

* Go full UserString copy/paste

* Various version related fixes

* Remove trailing newline

* py2v3

* Add a test that can evaluate whether a variable is vault encrypted

* map was introduces in jinja2 2.7

* moar jinja

* type fix

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Remove duplicate __hash__

* Fix typo

* Add changelog fragment

* ci_complete

Co-authored-by: Sam Doran <sdoran@redhat.com>
2020-06-08 16:30:14 -05:00
Marco Lussetti
1dd8247fba
Add SLES to user_guide/playbook_conditionals.yml () 2020-05-29 13:39:49 -04:00
Sloane Hertel
e40889e711
Add support to install collections from git repositories ()
* Enable installing collections from git repositories

* Add tests for installing individual and multiple collections from git repositories

* Test to make sure recursive dependencies with different syntax are deduplicated

* Add documentation

* add a changelog

* Skip Python 2.6

* Only fail if no collections are located in a git repository

Add support for a 'type' key for collections in requirement.yml files.
Update the changelog and document the supported keys and allowed values for the type.

Add a note that the collection(s) in the repo must contain a galaxy.yml

* Add a warning about embedding credentials in SCM URLs

* Update with review suggestions

* suppress sanity compile failure for Python 2.6
2020-05-29 13:33:32 -04:00
Brian Coca
d0a25f004c
note that environment is not good for secrets ()
* note that environment is not good for secrets
* Update docs/docsite/rst/user_guide/playbooks_environment.rst
Co-authored-by: Sam Doran <sdoran@redhat.com>
2020-05-28 15:24:32 -05:00
Jeff Geerling
21b65257bf
Fix spacing for playbook collections example. () 2020-05-28 15:21:50 -05:00
Jack Scheible
0ce404c4d9
Update intro_inventory.rst ()
Vars in inventory are merged in ASCII order. Change docs to reflect that.
2020-05-28 15:06:17 -05:00
Pilou
59f2174c8b
Doc: playbook keywords are reserved names too () 2020-05-28 10:32:28 -05:00
Alicia Cozine
6fffb0607b WIP: Docs: User guide overhaul, part 4 ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-05-15 16:18:07 -04:00
Lukas Pirl
34db57a47f
introduce fact "ansible_processor_nproc": number of usable vcpus ()
This fact reflects the number of usable vcpus (which might be different
from ansible_processor_vcpus, e.g., in containers with limits). See
also .

* Add fixture data and update unit tests

Co-authored-by: Sam Doran <sdoran@redhat.com>
2020-05-15 09:38:56 -04:00
Sloane Hertel
55e29a1464
ansible-galaxy - fall back to galaxy.yml when listing collections ()
Fallback to galaxy.yml for listing collections that don't have a FILES.json or MANIFEST.json

Co-authored-by: Sam Doran <sdoran@redhat.com>
2020-05-14 12:28:08 -04:00
Andreas Bühmann
1a5bbfbe01
Fix name of utility "nologin" ()
The utility is `nologin`, not 'no login'. Fix this on the page about Become. In the example further down below it is spelled correctly.
2020-05-04 17:40:44 -05:00
Lucas Ramage
c52121f4c9
Clarification for Ansible and BSD Introduction ()
Bug: https://github.com/ansible/ansible/issues/69274
2020-05-04 16:16:41 -05:00
Douglas Thor
46fea92125
Add note in inventory guide saying group names follow variable name guidelines. () 2020-05-04 16:09:44 -05:00
Sandra McCann
44a4538280
add FQCN for migrated filters () 2020-05-04 16:02:13 -05:00
Sandra McCann
caa263e2cf
Document how to migrate a standalone role to a collection ()
Adds docs for role developers/owners in the collections ecosystem
2020-05-04 15:59:54 -05:00
Abhijeet Kasurde
b437236633
Redirect inventory script links ()
With inventory script migrated to their respective collection,
redirect links in documentation to their respective collection
location.

Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-04-29 16:05:39 -04:00
Abhijeet Kasurde
572fe9e480
Adjust Openstack Inventory script path () 2020-04-24 11:15:51 +05:30
Abhijeet Kasurde
6493a190f6
docs: Update inventory script paths ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-04-15 16:29:55 -04:00
Kenyon Ralph
a681810b2f
doc: variable precedence: "override", not "overwrite" () 2020-04-09 11:55:53 -04:00
pallxk
43270332e7
true and false commands have to be quoted ()
otherwise they will be parsed as bool instead of string by YAML.
2020-04-09 10:22:43 -05:00
nzarin
16e07fe5b5
Fix grammar error in docfile () 2020-04-06 16:03:17 -04:00
John Mahowald
db01053d6a
Remove reference to core Ansible () 2020-03-26 15:22:36 -04:00
Alicia Cozine
9139c1f81d
consistently call tests tests, not filters ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-03-25 21:31:29 -04:00
Toby Foster
913ee9119a
Fix list formatting in Getting Started () 2020-03-25 15:29:09 -04:00
Simon Legner
969e209a48
docs(windows_setup): +choco install openssh ()
Also show most basic way of installing OpenSSH via Chocolatey
2020-03-25 13:53:54 -05:00
Jordan Borean
7ec0d59c30
windows - add docs for UNC path in PSModulePath error () 2020-03-25 14:09:32 -04:00
Jordan Borean
a2deeb8fa2
ansible-galaxy - add download option ()
* ansible-galaxy - add download option

* Fix sanity issues and added integration tests

* Fix doc suggestions

* Added --pre option
2020-03-25 08:32:43 +10:00
Sandra McCann
8fbec3cdeb
add download tarball option () 2020-02-24 16:30:34 -06:00
Andrew Klychkov
05a3192eb7
user_guide/intro_adhoc.rst: fix typo () 2020-02-21 10:56:25 +00:00
Christophe Drevet-Droguet
e867535a57
regex_replace multiline support ()
* document multiline parameter for regex_replace
* add changelog fragment
* tests for regex_replace_multiline
2020-02-19 12:19:40 -05:00
John R Barker
4844adff9a
Collection developer guide - BOTMETA ()
* Docs: Improve how to migrate and create collections
* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-02-19 10:11:38 -06:00
Geoffrey Purdy
82ca00e4fe
Update windows_faq.rst ()
Steers users around the error:  Could not install packages due to an EnvironmentError: [Errno 13] Permission denied: '/usr/local/lib/python2.7/dist-packages/xmltodict.py'
Consider using the `--user` option or check the permissions. -->
2020-02-17 13:38:46 -06:00
Jordan Borean
423a900791
Clarify b64encode with Python 2 () 2020-02-17 13:31:03 -06:00
Sam Doran
f506fd4730
Add ansible-galaxy collection list command ()
* Start adding ansible-galaxy collection list options

* Working list all collections and list a specific collection

* Nuke debugging cruft

* Use to_text to get a string of the FQCN for sorting

* Improve collection output formatting

- add header
- display collection name and version in separate columns
- width of columns is dynamic based on collection name and version length

* Make role list output match collection output list

- add header
- add columns for role name and version
- make column width dynamic based on name and version length

* remove debug statemnt and extra header

* Revert "Make role list output match collection output list"

This reverts commit a0b3db47bb3b198aafd34c1f1be5b6561af2f928.

* Add validate_collection_path function

Utility function for ensuring a collection target ends with 'ansible_collection'

* Use validate_collection_path

* Do not warn if a specific collection in found in any search path

* Fix extraneous warning and remove duplicate code

Do not warn when listing a specific collection and it does not exist
in other collection paths.

Restructure the code that loops through collection paths to remove
duplicate conditional code.

* Indicate role path was found

* Use new function name

* WIP Save Point

* Use separate functions for role and collection list

* Wrap error message

There may be a better way to do this besides hard coding a line break, but this
does make the message a lot more readable.

* Add validate_collection_path function ()

* Add validate_collection_path function

Utility function for ensuring a collection target ends with 'ansible_collection'

* Fix bad syntax

* Correct docstring

* Bikeshed the names

* Properly list a single role

* Simplify _display_warnings()

Only display warnings. Move exception raise back to each caller.

* Move private methods to private functions

They don't need self, so it makes sense to have them as functions
Get rid of _display_warnings() function since it doesn't do anything worthy of
an independent function.

* Add integration tests for ansible-galaxy collection list

* Fix docs sanity test

* Fix bug where ansible_collections dir does not exist

The path may exist, but if there is no ansible_collections dir inside that path,
an exception was raised in find_existing_collections().

Add integration test for this scenario

* Put execute_list() method back

* Add some informational messages for debugging

* Add unit tests

Units tests for the various private methods in support of collection list

* Start adding unit tests for test_execute_list

* Display collection path when listing specific collection

* Add unit tests for listing all collections and specific collection

- Create fixture for creating test objects
- Add function for controlling os.path.isdir results

* Set defaults for minimum collection widths

Ensure that collections with small FQCNs display correctly.
Add unit tests

* Split up unit tests and fix fixtures

Add more fixtures for mocking objects during the specific collection tests

* Change help message for -p in list subcommand

Give accurate description of what it actually does rather than trying to use language shared between sub commands.

* Disable colorized output in unit test

* Add docs for collection list

* Fix integration test on macOS

The temp file path is really long on macOS, so the warning message gets wrapped
across multiple lines. That make seth grep fail. Switch to matching on a smaller
part of the warning.

* Recreate common path options for collections

Improve help about what the '-p' option does and how it works.

* Remove unnecessary elif after continue statements

* Account for duplicate paths in collections_searh_paths

If someone specifies the same path via '-p' that is the COLLECTIONS_PATHS,
do not list the collections twice.

* Docs updates
2020-02-14 14:00:00 -06:00
Ken Dreyer
0485ce9d12
docs: fix path to roles' meta/main.yml file () 2020-02-14 11:10:33 -05:00
Carsten Rösnick-Neugebauer
b625b430f1
Add (more) explicit references to Jinja2 docs in conditionals doc ()
Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-02-14 10:53:14 -05:00
Sloane Hertel
97f011cf94
Add verify subcommand to 'ansible-galaxy collection' ()
* [WIP] Add verify subcommand command to 'ansible-galaxy collection'

* Fix pep8 and use consistent display order

* WIP - docs

* Remove some redundancy in verify display messages by using an error queue for each collection

* Share common code and improve output format

* clean up documentation

* typo

* Apply suggestions from code review

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Move ModifiedContent namedtuple to the global scope

Add a public metadata property

Rename function to _get_json_from_tar_file

* Add some unit tests

* fix using common functions after rebase

* changelog

* Improve efficiency finding specific installed collections

Improve efficiency by only downloading the tar.gz from the galaxy server for comparison after checking that the collection has been installed

Handle multiple collection paths

Fix up tests

* pep8

* reword that for accuracy

* use more common code and verify collection name

* Improve error message and add documentation

* Update unit tests and add coverage for both local and remote collections that are unable to be located

* Only validate collections using the format collection_namespace.collection_name

Fix tests to reflect that

Fix documentation

* Fix a bug when a local collection does not contain a file

* pep8

* Fix formatting

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-02-14 08:57:04 -06:00
tchernomax
53e043b5fe
combine filter: fine list handling (option b) () 2020-02-12 16:40:36 -05:00
Jonas DOREL
29edcdcf5b
Add library in role directory structure ()
* Add library directory to the list of directories in a role
2020-02-11 14:30:59 -06:00
Sriviswajth
070f946745
Update intro_patterns.rst ()
Removed extra quotes from example.
2020-02-11 11:52:00 -06:00
Alex Humphreys
01a6e1c2c9
Mention role defaults file ()
Add info on where role defaults are set; matches the entry for role variables.
2020-02-11 11:50:16 -06:00
JP Mens
585e79942c
Slash missing from /etc/ () 2020-02-10 14:07:22 -05:00
Ilias Trichopoulos
d6f2b4e788
Fix indentation () 2020-02-03 12:30:12 -05:00
Sam Doran
c8568a5c94
Add documentation about vars used in roles at the play level () 2020-01-30 11:08:24 -05:00
Toshio Kuratomi
4273e84962
Upstream jinja has decided not to rename from jinja2. ()
So we're going to keep our intersphinx labels as jinja2 to match what
upstream is doing
2020-01-30 10:57:50 -05:00
Eitan Adler
86663abf37 all: fix all the the duplicate words () 2020-01-28 14:06:40 -05:00
Toshio Kuratomi
14cc63dc0f Switch intersphinx label from jinja2 to jinja ()
* Switch intersphinx label from jinja2 to jinja

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
2020-01-23 14:09:17 -05:00
Alicia Cozine
cb8ce7159d Docs: clarify that roles do not inherit collections set in a playbook ()
Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-01-22 15:08:38 -05:00
Alicia Cozine
0b503f6057 Docs: User Guide overhaul, part 3 () 2020-01-21 16:57:55 -05:00
Walter Sosa
875ac4b7a5 Fix a tiny typo ()
Fixes a very small typo: as --> a in playbook_debuggers.rst
2020-01-18 10:35:31 +05:30
hiyokotaisa
3bcb664497 Fixes add pywinrm version explanation ()
* add pywinrm version explanation

* Update windows_winrm.rst

Changed pywinrm explanation to note style

* Add period

Co-authored-by: Jordan Borean <jborean93@gmail.com>
2020-01-16 08:22:38 +10:00
Jordan Borean
6f04f87a13
Deprecate Windows 2008, and 2008 R2 ()
* Deprecate Windows 2008, and 2008 R2

* Remove shippable nodes

* Update windows_faq.rst

Be less specific about 2008/R2 timeframes

* Update setup.ps1

tweak warning text

Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com>
2020-01-14 11:22:39 +10:00
林博仁(Buo-ren Lin)
011e0176c2 Clarify the advantage include* statement brought regarding looping ()
Signed-off-by: 林博仁(Buo-ren, Lin) <Buo.Ren.Lin@gmail.com>
2020-01-11 11:09:51 -05:00
Abhijeet Kasurde
469f104ec2 loop: simplify dict2items example in docs ()
* Added a simple example to explain "dict2items" filters for better understading.

Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-01-07 10:32:46 -05:00
Anthony Bourguignon
d3e9ef3c35 add a path_join filter which joins path components () 2020-01-06 11:56:40 -05:00
Sandra McCann
80dff8743a fixed some broken links () 2020-01-06 10:24:07 -06:00
Lars Kellogg-Stedman
f85d9d7028 Correct rst syntax in playbooks_filters.rst ()
The `regex_replace` documentation included an example that was meant
to be preformatted text but due to an indentation error was rendering
incorrectly.
2020-01-06 10:13:21 -06:00
Wojciech Sciesinski
aacc2d1a18 Update indentation used in the code examples, unify empty lines () 2019-12-16 11:26:25 -06:00
Steve Leonard
af1c788ba7 Fix list formatting in Getting Started docs page () 2019-12-12 16:52:52 -06:00
Mossroy
c3c1708dea Fix variable name in an example ()
Makes the variable name consistent between the example code (`myname`) and the text below (mentioning a variable called `name`) in the docs.
2019-12-12 16:51:47 -06:00
Sandra McCann
9c30325704 fixed some link nits () 2019-12-12 13:20:08 -06:00
Alicia Cozine
860cacc54f Docs: User guide overhaul, part 2 () 2019-12-12 13:35:17 -05:00
Wojciech Sciesinski
95aef88a45 Update indentation used in the code examples, unify empty lines () 2019-12-10 10:55:51 -05:00
Evgeni Golov
3af1732bd8 fix rendering of GOOD/BAD code for regex_replace examples ()
adds double colon (::) so the examples render as code
2019-12-10 08:49:38 -06:00
Jasper Lievisse Adriaanse
53cd0bdd29 docs: Prefer python3 on OpenBSD () 2019-12-10 09:05:18 -05:00
Sam Doran
21bbf49396 Mention Python builtin methods in filter docs () 2019-12-02 09:44:59 -06:00
林博仁(Buo-ren Lin)
8ebc57c186 Mention that Python keywords are invalid Ansible variable names ()
* Mention that Python keywords are invalid Ansible variable names
Using a Python keyword as a variable name triggers the error `Invalid variable name in 'register' specified: 'return'`.
2019-12-02 09:42:40 -06:00
Niklas Liechti
39ebd244e3 Update playbooks_filters.rst () 2019-11-26 13:39:12 -05:00
Andrew Schultz
756ac826fe Improve ignore_unreachable documentation () 2019-11-26 13:35:02 -05:00
Kenyon Ralph
a797802d27 playbooks_filters_ipaddr.rst: fix syntax, indentation () 2019-11-25 15:00:15 -05:00
Sam Doran
0471ed3731 Add docs clarifying behavior of retry files () 2019-11-25 14:26:46 -05:00
gaoruifeng
f9f7a0c60e fix syntax issue ()
- can disabled  
+ can be disabled
2019-11-25 15:01:10 +00:00
Alicia Cozine
b0c8e7926f link from quickstart page to Network Getting Started () 2019-11-21 11:42:57 -05:00
Baptiste Mille-Mathias
e65be0beee Put all files and Path filters under a specific section ()
Many of the filters in the "other useful filters" list manipulate filenames and paths; add a heading and put them together.
2019-11-19 12:30:56 -06:00
Sandra McCann
a01376a493 update configuring ansible-galaxy client ()
* update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.
2019-11-15 09:49:51 -06:00
Robert de Bock
f17a55a181 Add advice how to prevent jinja2 warning ()
* Add advice how to prevent jinja2 warning

##### SUMMARY
This addition helps users to demonstrate how to prevent `[WARNING]: when statements should not include jinja2 templating delimiters`.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Update playbooks_tests.rst

* Update playbooks_tests.rst

Refer to the advised FAQ about when to use `{{ }}`.
2019-11-14 14:36:05 +00:00
Vincent Bernat
bf19060683 ipaddr: add an option to return peer of a point-to-point link ()
* ipaddr: add an option to return peer of a point-to-point link

Signed-off-by: Vincent Bernat <vincent@bernat.ch>

* ipaddr: extend "peer" to also work with /30
2019-11-13 13:47:05 -05:00
James Cassell
a7f90df0e9 Document match/search tests ()
* clarify `search` vs `match` tests

* string test docs: fix rst formatting
2019-11-13 11:14:10 -06:00
Sorin Sbarnea
7ea1db89d3 Documents storage of task files () 2019-11-08 16:23:33 -05:00
Jordan Borean
901eaf2ecc Add warning about winrm on MacoS () 2019-11-08 16:12:26 -05:00
Jordan Borean
74b0760cb4 Add note about kerberos dependency versions () 2019-11-08 16:11:18 -05:00
Bibas
f21f3219b2 [Fix] Typo in playbooks_environment.rst ()
Change from `varaible` to `variable`
2019-11-06 17:31:16 +05:30
Caleb Collins-Parks
f178c49c02 Add warning about skipped vars () 2019-11-05 16:25:15 -05:00
Hiroki Kobayashi
e7cd5af1a6 Update intro_inventory.rst ()
##### SUMMARY
A minor typo in `user_guide/intro_inventory.rst` is fixed.
Changed from "know" to "known"
2019-11-05 12:42:28 +05:30
Mark Chappell
9b0d487ce1 Add module_defaults group for ovirt ()
* Add module_defaults group for ovirt

* Update docs to list ovirt module_defaults group
2019-11-05 12:30:41 +05:30
Kenyon Ralph
53f07bc283 intro_patterns.rst: fix typo ()
Changed "your" to "you" in intro_patterns.rst
2019-11-05 11:56:41 +05:30
Christian Adams
b1f02be9eb clarify vault warning and fix typo () 2019-11-04 17:47:03 -06:00
Pierre Prinetti
2444fae208 Add a named parameter to the filter to_uuid ()
Let the caller choose a namespace for `to_uuid` and document the
behaviour of both the default case, and the new explicit case.

This PR does not change the existing behaviour of the `to_uuid` UUIDv5
filter.
2019-11-01 13:11:34 -04:00
Brian Coca
885ee62b53 clarified some points on environment keyword usage () 2019-10-29 13:17:41 -04:00
Marek Czernek
18f4f0549f Correct a typo () 2019-10-28 15:01:10 -05:00
AndrewCi
c562e17659 Fixed example error in windows_winrm user guide ()
##### SUMMARY
The example code to configure TLS 1.2 Support using Ansible had an indention error. The register variable 'enable_tls12' was not indented. This caused the subsequent task to fail since the variable was not registered. 


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2019-10-24 14:31:47 -05:00
Pouyan Azari
cfe2beae46 added a link to install instruction of OpenSSH () 2019-10-21 17:02:19 -04:00
Pouyan Azari
f638f29e44 Replaced old DSC links that given 404 ()
Replace DSC links that returned "not found" with updated, working links.
2019-10-16 12:52:30 -05:00
Sandra McCann
ae265bc546 Move galaxy appendix info to a new Galaxy section ()
* start galaxy docs restructure
* shared snippets in txt files
* moved all content to galaxy section
2019-10-11 13:19:44 -05:00
Felix Fontein
aa04e61c89 docker_* modules: add docker module defaults group ()
* Add docker module defaults group.
* Add footnote about docker_stack not being included (instead of remarks column)
2019-10-09 14:12:02 -05:00
Michael C
19587b35da docs: add Centos and Ubuntu to examples for playbook conditionals ()
* docs: add Centos and Ubuntu to examples for playbook conditionals

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-10-09 14:05:21 -05:00
Alicia Cozine
941a9b68fc Docs: User guide overhaul, part 1 () 2019-10-08 13:46:38 -04:00
Abhijeet Kasurde
deda9d4cc5 VMware: Add module defaults for VMware modules ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-10-07 14:24:58 -04:00
Adrian Likins
239d639fee Add support for automation-hub authentication to ansible-galaxy ()
Adds support for token authentication in Automation Hub. Fixes: 
2019-10-04 17:57:37 -04:00
Sam Doran
0311897722 Add docs on hiding sensitive data in loops () 2019-10-03 10:15:00 -05:00
Matt Martz
594a0fa9ae Add new truthy and falsy jinja2 tests () 2019-10-02 13:58:28 -04:00
Chris Houseknecht
911aa6aab9
Default collection install path to first path in COLLECTIONS_PATHS () 2019-10-02 10:22:00 -04:00
Felix Fontein
8bfc39e231 ACME module defaults ()
* Add module defaults group 'acme'.

* Start YAML document.
2019-10-01 17:14:22 -04:00
Andreas Olsson
c8315bfd60 Prefer https:// links in the docs site ()
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
2019-09-30 15:11:19 -04:00
Jeff Pettorino
cea8a222a3 Update playbooks_environment.rst () 2019-09-26 10:42:23 -04:00
Michael Prokop
b33ae14949 doc: fix typos () 2019-09-26 10:18:29 -04:00
Sandra McCann
7e01de96d7
add more anchors to collections docs () 2019-09-25 08:32:44 -04:00
Sandra McCann
7badeb6df0 [docs] split collections into user and dev guide sections ()
* split collections into user and dev guide sections

* sentence case
2019-09-19 15:09:19 -05:00
Horst Gutmann
7047b66d34 Add examples for various inventory setups to the documentation ()
* Add examples for various inventory setups to the documentation. This closes .

* Update docs/docsite/rst/user_guide/intro_inventory.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/user_guide/intro_inventory.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Use code-block and rename groups in inventory setup examples

* Fix group name in inventory setup example

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-19 09:32:04 -04:00
Jordan Borean
d16ee65ecd Add link to become plugins in become docs () 2019-09-18 15:53:16 -04:00
Sloane Hertel
09f1c286e0 Add some details to any_errors_fatal documentation () 2019-09-12 16:15:02 -04:00
createchange
e3ea89801b Update playbooks_prompts.rst ()
Fixed typo: "wierd" > "weird"
2019-09-10 06:57:01 +05:30
Christopher Engelhard
375eb9723a Add caution about handlers & import to Pitfalls ()
* Add caution about handlers & import to Pitfalls on the playbooks_reuse page.
The fact that handlers lose their name: when using import_tasks:, while logical, is not intuitive and should be noted.
Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-05 14:18:09 -05:00
Wojciech Sciesinski
7e7b7bb0b6 Correct indentation of the code in the example () 2019-09-03 10:09:47 -05:00
James Cammarata
51b33b79c0
T woerner max concurrent ()
* play, block, task: New attribute forks

With this it is possible to limit the number of concurrent task runs.
forks can now be used in play, block and task. If forks is set in different
levels in the chain, then the smallest value will be used for the task.

The attribute has been added to the Base class as a list to easily provide
all the values that have been set in the different levels of the chain.

A warning has been added because of the conflict with run_once. forks will
be ignored in this case.

The forks limitation in StrategyBase._queue_task is not used for the free
strategy.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Handle forks in free strategy

The forks attribute for the free strategy is handled in run in the free
StrategyModule. This is dony by counting the amount of tasks where the uuid
is the same as the current task, that should be queued next. If this amount
is bigger or equal to the forks attribute from the chain (task, block,
play), then it will be skipped to the next host. Like it is also done with
blocked_hosts.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Test cases for forks with linear and free strategy

With ansible_python_interpreter defined in inventory file using
ansible_playbook_python.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Changing forks keyword to throttle and adding some more docs
2019-08-28 18:47:39 -05:00
Alicia Cozine
a6f585eb62 remove the word "support" from Windows pages, add Windows Server 2019 ()
* remove support from Windows pages, add Windows Server 2019

* jborean feedback

* Removed CBT info

Removed the CBT note about what transports Ansible actually supports. We've worked with both NTLM and Kerberos for a while now.
2019-08-28 08:05:12 +10:00
Brett Campbell
5b16e012a4 Doc fixes for readability (formatting/punctuation) ()
Variable-width font was extremely difficult to read in a couple places.
Fixed missing close-quote, colon, spelling, etc.
2019-08-22 15:29:53 -04:00
G. Weixelbraun
ab027611d5 fix typo in become.rst ()
change remote_src: yex to remote_src: yes in documentation
2019-08-21 10:58:45 -05:00
Mark Chesney
11be31db71 Fix naming discrepancy in zip filter example ()
Fix naming discrepancy in zip filter example
2019-08-20 09:53:15 -05:00
Jiri Tyr
da18e3b76c Updating intro_inventory.rst () 2019-08-16 09:23:58 -05:00
Jiri Tyr
c4d841f848 Updating intro_inventory.rst () 2019-08-15 14:42:37 -05:00
Aaron
d808b84621 Update intro_getting_started.rst to take into account inventory precedence when proposing '-u' to change the remote user. ()
* Update intro_getting_started.rst
* adds more info about overriding SSH user to intro
2019-08-14 14:29:41 -05:00
Jered Sutton
6915ea96f1 Clarify behavior of --skip-tags, --list-tasks, and --list-tags. () 2019-08-13 09:47:28 -05:00
Felix Fontein
2d98734ad5 Amazon modules: rename _facts with ansible_facts result to _info ()
* aws_s3_bucket_facts -> aws_s3_bucket_info

* cloudformation_facts -> cloudformation_info

* cloudfront_facts -> cloudfront_info

* ecs_service_facts -> ecs_service_info

* efs_facts -> efs_info

* Add changelog and porting guide entry.

* lambda_facts -> lambda_info

* Improve examples.

* Add subsection on renamed modules.

* Add sentence on registering variables.

* Fix ReST.

* Instead of renaming lambda_facts, deprecate it and replace with new module.

* Rename internal variable.

* Re-add sanity ignores for lambda_facts.
2019-08-13 08:01:37 -04:00
kfattig
dd7b9627ad Runas docs ()
* Mention seclogon requirement in runas docs

* Mention seclogon requirement in Win become docs
2019-08-06 10:44:17 +10:00
Peter Mounce
24d8e82655 Windows Setup doc; offer 10x perf improvement ()
* Windows Setup; document 10x perf improvement
2019-07-30 15:53:17 -04:00
d-little
11d61cc01e Swap ordering to ensure Dynamic always first () 2019-07-12 15:52:06 -05:00
Alicia Cozine
0dd3fb82eb get rid of Sphinx 2.1.2 errors () 2019-07-12 16:19:08 -04:00
Samy Coenen
0befccbeb9 Update intro_inventory.rst () 2019-07-09 15:56:21 -05:00
Brian Coca
c2469648e4 Docs on general precedence ()
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-07-09 12:14:40 -05:00
Wojciech Sciesinski
f9a31e3e17 Provide the list of packages in a modern way () 2019-07-09 12:04:12 -05:00
Sloane Hertel
ec1287ca7e
Fix notifying handlers by using an exact match ()
* Fix notifying handlers by using an exact match rather than a string subset if listen is text rather than a list

* Enforce better type checking for listeners

* Share code for validating handler listeners

* Add test for handlers without names

* Add test for templating in handlers

* Add test for include_role

* Add a couple notes about 'listen' for handlers

* changelog

* Add a test for handlers without names

* Test templating in handlers

* changelog

* Add some tests for include_role

* Add a couple notes about 'listen' for handlers

* make more sense

* move local function into a class method
2019-06-27 17:29:20 -04:00
Klaus Frank
ee52b60d7d Add note about delegate_facts to run_once ()
* Add note about delegate_facts to run_once
2019-06-27 17:19:22 -04:00
Alicia Cozine
d4f0bc183e removes last :doc: links in user guide ()
* removes last :doc: links in user guide
2019-06-26 17:07:27 -04:00
Sayed Anisul Hoque
57596edcca Updated the playbooks_tags guide ()
* Updated the playbooks_tags guide
2019-06-21 12:06:23 -04:00
Lucian Maly
446027341a Update playbooks_strategies.rst ()
* Update playbooks_strategies.rst

##### SUMMARY
This page is very confusing and may suggest, that there is still a `serial` strategy (like it used to), but now it is just a directive of `linear` strategy. Multiple people reported this to me and it needs change.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Update docs/docsite/rst/user_guide/playbooks_strategies.rst

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Update docs/docsite/rst/user_guide/playbooks_strategies.rst

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Updates strategies page more broadly

* incorporate samdoran feedback

* fixes broken link

* new page title, focus on user intent

* more sdoran feedback

* adds details on setting the number of forks
2019-06-18 16:52:01 -04:00
Sayed Anisul Hoque
b768a0780c Update playbooks_vault.rst ()
Corrected the internal reference link to point to the FAQ entry.

+label: docsite_pr
2019-06-18 11:23:30 -05:00
Felix Fontein
505c99265c docsite: remove lexers which have been fixed in Pygments 2.4.0 ()
* Remove lexers which have been fixed in Pygments 2.4.0.
* Add Pygments >= 2.4.0 to test runner.
* Fix pages that triggered lexer errors.

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
2019-06-18 10:56:33 -05:00
Sayed Anisul Hoque
2bdc4e5b4a Documentation error in the Test if a list contains a value section ()
* Update docs/docsite/rst/user_guide/playbooks_tests.rst - 'contains' test works with 'select/reject' and 'selectattr/rejectattr' but not 'map'
2019-06-18 09:15:09 -05:00
asouini
a096fa5c12 filter bare variable with |bool (deprecation warn) ()
* filter bare variable with |bool (deprecation warn)

https://github.com/ansible/ansible/pull/57691#issuecomment-502134480
2019-06-17 10:53:30 -04:00
Sayed Anisul Hoque
78f87f2451 Updated "Speeding up Vault Operations" section ()
* Updated "Speeding up Vault Operations" section


Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
2019-06-14 10:17:40 -04:00
Sayed Anisul Hoque
b9c893ec6f Updated the section under "Aborting the play" in the Error Handling In Playbooks page ()
* Updated the section under "Aborting the play"

Updated "Aborting the play" section in the Error Handling In Playbooks page. Removed the reference to marking all hosts as failed.

+label: docsite_pr

* Update docs/docsite/rst/user_guide/playbooks_error_handling.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-06-14 10:04:05 -04:00
Strahinja Kustudic
6131de29d4 Improve regex_replace filter docs ()
* Add a few examples of how to correctly use `regex_replace` filter
because it behaves differently on different Python versions when using
regex qualifiers that can match an empty string (e.g. '*', '?', etc).
2019-06-13 09:12:12 -05:00
Sandra McCann
c06f890f55 add docs for vlan_parser filter () 2019-06-11 11:22:02 -05:00
Felix Fontein
13f73adef5
AWS: _facts -> _info (part 4) ()
* Rename ec2_vpc_dhcp_option_facts -> ec2_vpc_dhcp_option_info.

* Rename ec2_vpc_endpoint_facts -> ec2_vpc_endpoint_info.

* Rename ec2_vpc_igw_facts -> ec2_vpc_igw_info.

* Rename ec2_vpc_nacl_facts -> ec2_vpc_nacl_info.

* Rename ec2_vpc_nat_gateway_facts -> ec2_vpc_nat_gateway_info.

* Rename ec2_vpc_net_facts -> ec2_vpc_net_info.

* Rename ec2_vpc_peering_facts -> ec2_vpc_peering_info.

* Rename ec2_vpc_route_table_facts -> ec2_vpc_route_table_info.

* Rename ec2_vpc_subnet_facts -> ec2_vpc_subnet_info.

* Rename ec2_vpc_vgw_facts -> ec2_vpc_vgw_info.

* Rename ec2_vpc_vpn_facts -> ec2_vpc_vpn_info.

* Update module defaults, add changelog and porting guide.

* Update BOTMETA.
2019-06-10 21:40:05 +02:00
Felix Fontein
804d5eaf8e
AWS: _facts -> _info (part 3) ()
* Rename ec2_ami_facts -> ec2_ami_info.

* Rename ec2_asg_facts -> ec2_asg_info.

* Rename ec2_customer_gateway_facts -> ec2_customer_gateway_info.

* Rename ec2_eip_facts -> ec2_eip_info.

* Rename ec2_elb_facts -> ec2_elb_info.

* Rename ec2_eni_facts -> ec2_eni_info.

* Rename ec2_group_facts -> ec2_group_info.

* Rename ec2_instance_facts -> ec2_instance_info.

* Rename ec2_lc_facts -> ec2_lc_info.

* Rename ec2_placement_group_facts -> ec2_placement_group_info.

* Rename ec2_snapshot_facts -> ec2_snapshot_info.

* Rename ec2_vol_facts -> ec2_vol_info.

* Update module defaults, add changelog and porting guide.

* Forgot one occurence of ec2_instance_facts.

* Update BOTMETA.

* Break too long line.
2019-06-10 19:33:38 +02:00
Sandra McCann
152202ceb0 add info about hwaddr conversion formats () 2019-06-06 12:56:10 -05:00
Abhijeet Kasurde
ee8a607cca ipaddr: Handle network address in ipmath ()
* Updated testcase, documentation

Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-06-04 14:01:18 +05:30
Ilya Reshetnikov
bf0e846a39 Update playbooks_filters.rst ()
* Update playbooks_filters.rst to show JSON in the "JSON Query Filter" example data structure
2019-06-03 11:15:11 -05:00
Thad Guidry
78b003858d Mention other ways to handle private key files ()
Often when I am helping others learn Ansible, they are using nodes spun up on Amazon/Google/etc.  where private key files (pem) are needed.  Mentioning just a bit more on how to handle those private key files on the intro_getting_started page will help more folks get started faster.
I even reviewed the changes with my learning team and they all agreed this helped clarify immediately for them how to really get started with Ansible from a practical perspective.
2019-06-03 10:17:13 -05:00
Bill Nottingham
c493593b4b Adjust assorted terminology and wording around product offerings. ()
* Adjust assorted terminology and wording around product offerings.

* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
2019-05-31 14:24:44 -05:00
Remon van de Kamp
dea9644d21 Use correct variable for run_once regardless of batch example ()
Changes example to `when: inventory_hostname == ansible_play_hosts_all[0]` to really run run_once regardless of serial.
2019-05-29 12:24:12 -05:00
Jonathan Bride
db6407d6bf Correct typo in playbooks_intro.rst ()
Typo in code block line: ansible-lint veryify-apache.yml should be
ansible-lint verify-apache.yml
2019-05-24 09:53:00 -05:00
Anatoly Kamchatnov
9a563f8947 Windows FAQ: fix reference () 2019-05-24 09:39:49 -05:00
CsilLAB
6900378766 [WIP] Tip to see the content of a single encrypted var ()
* Tip to see the content of a single var encrypted with Ansible Vault
2019-05-21 15:37:25 -05:00
Sandra McCann
388f5d0b2b Add links to quickstart guides ()
* shell of quickstart

* link to existing quickstart guides
2019-05-21 10:48:50 -05:00
s-hamann
730456b402 Add seed parameter to random_mac filter () 2019-05-16 13:41:08 -04:00
Pilou
b3ab83bc70 [doc] fix example: always trigger the handler ()
by default, debug task result isn't changed - add 'changed_when: yes' to trigger handler
2019-05-14 09:02:40 -05:00
Brian Coca
8ff27c4e0c more info on how vaults work ()
also add warning about what it covers.
2019-05-07 14:53:34 -05:00
Jim Rollenhagen
86e98c5213 Note that by default the regex test is identical to match, but can do much more ()
* Note that the regex test behaves like 'match', with default settings
2019-05-07 10:00:00 -05:00
Matthew Davis
7d5ada7161 add doc example of multiline failed_when with OR ()
* add doc example of multiline failed_when with OR

* add variety to multiple OR failed_when doc example
2019-05-06 09:11:27 -05:00
Brian Coca
5d4c73e197 unite poll defaults ()
* unite poll defaults and update docs
2019-05-01 13:47:50 -05:00
Alicia Cozine
5439eb8bd8
Clarifies how Ansible processes multiple failed_when conditions ()
Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).
2019-05-01 07:31:59 -05:00
tacatac
dbc64ae64c Clarify poll value behaviour in playbook async doc ()
Clarify the documentation for `async` and `poll`; describe the behavior when `poll` = 0 and when it does not.

* Update docs/docsite/rst/user_guide/playbooks_async.rst

* Update the default poll value in async doc

Co-Authored-By: tacatac <taca@kadisius.eu>
2019-04-25 17:23:13 -05:00
hiyokotaisa
7b86208fcd Add Microsoft Document URL for WinRM Memory Hotfix ()
* Add microsoft document for memory hotfix

* Update docs/docsite/rst/user_guide/windows_setup.rst

Co-Authored-By: hiyokotaisa <thel.vadam2485@gmail.com>
2019-04-25 10:56:34 -05:00
Lars Kellogg-Stedman
a5cb47d697 Improve consistency of loop documentation ()
There were a series of sections with subheadings in the loop
documentation, but the most recent additions did not follow the same
pattern.
2019-04-23 16:39:14 -05:00
tacatac
79198cad7a Clarify the Vault guide and add Vault ID examples ()
updates docs/docsite/rst/user_guide/vault.rst
* Add reference to single variable vault encryption
* rST ref to jump to the section
* Clarify the two targets of vault encryption, with notes about advantages and drawbacks of each
* Add the default form for --vault-id
* Add Vault ID examples for normal operations

Co-Authored-By: tacatac <taca@kadisius.eu>
2019-04-23 16:36:39 -05:00
Matt Martz
db6cc60352
Migrate command line parsing to argparse ()
* Start of migration to argparse

* various fixes and improvements

* Linting fixes

* Test fixes

* Fix vault_password_files

* Add PrependAction for argparse

* A bunch of additional tweak/fixes

* Fix ansible-config tests

* Fix man page generation

* linting fix

* More adhoc pattern fixes

* Add changelog fragment

* Add support for argcomplete

* Enable argcomplete global completion

* Rename PrependAction to PrependListAction to better describe what it does

* Add documentation for installing and configuring argcomplete

* Address rebase issues

* Fix display encoding for vault

* Fix line length

* Address rebase issues

* Handle rebase issues

* Use mutually exclusive group instead of handling manually

* Fix rebase issues

* Address rebase issue

* Update version added for argcomplete support

* -e must be given a value

* ci_complete
2019-04-23 13:54:39 -05:00
spellis
6ea3eca8ff Update windows_setup.rst ()
Wrong protocol and port in command.

+label: docsite_pr
2019-04-22 11:34:13 -05:00
Michelle Perz
960df24272 include windows server 2019 in supported hosts ()
<!--- Your description here -->

+label: docsite_pr
2019-04-16 14:00:33 -05:00
Sam Doran
f7ed194bc9 Clarify how to use variables with handlers ()
* Add clarification on handler names

Add example on how to use variables in handlers

* Update docs/docsite/rst/user_guide/playbooks_intro.rst
2019-04-11 10:23:08 -05:00
Kickimanjaro
4bb5a91acc Docs: Added missing backtick in become ()
Added missing backtick to make eos pretty
2019-04-09 10:46:06 +05:30