Commit graph

455 commits

Author SHA1 Message Date
Toby Foster
913ee9119a
Fix list formatting in Getting Started (#68153) 2020-03-25 15:29:09 -04:00
Simon Legner
969e209a48
docs(windows_setup): +choco install openssh (#68408)
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 (#68421) 2020-03-25 14:09:32 -04:00
Jordan Borean
a2deeb8fa2
ansible-galaxy - add download option (#67632)
* 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 (#67548) 2020-02-24 16:30:34 -06:00
Andrew Klychkov
05a3192eb7
user_guide/intro_adhoc.rst: fix typo (#67644) 2020-02-21 10:56:25 +00:00
Christophe Drevet-Droguet
e867535a57
regex_replace multiline support (#65051)
* 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 (#67538)
* 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 (#67482)
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 (#67488) 2020-02-17 13:31:03 -06:00
Sam Doran
f506fd4730
Add ansible-galaxy collection list command (#65022)
* 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 (#66441)

* 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 (#67408) 2020-02-14 11:10:33 -05:00
Carsten Rösnick-Neugebauer
b625b430f1
Add (more) explicit references to Jinja2 docs in conditionals doc (#61814)
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' (#65618)
* [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) (#57894) 2020-02-12 16:40:36 -05:00
Jonas DOREL
29edcdcf5b
Add library in role directory structure (#67030)
* 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 (#67151)
Removed extra quotes from example.
2020-02-11 11:52:00 -06:00
Alex Humphreys
01a6e1c2c9
Mention role defaults file (#67153)
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/ (#67220) 2020-02-10 14:07:22 -05:00
Ilias Trichopoulos
d6f2b4e788
Fix indentation (#66991) 2020-02-03 12:30:12 -05:00
Sam Doran
c8568a5c94
Add documentation about vars used in roles at the play level (#66907) 2020-01-30 11:08:24 -05:00
Toshio Kuratomi
4273e84962
Upstream jinja has decided not to rename from jinja2. (#66880)
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 (#66784) 2020-01-28 14:06:40 -05:00
Toshio Kuratomi
14cc63dc0f Switch intersphinx label from jinja2 to jinja (#66703)
* 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 (#66667)
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 (#66371) 2020-01-21 16:57:55 -05:00
Walter Sosa
875ac4b7a5 Fix a tiny typo (#66589)
Fixes a very small typo: as --> a in playbook_debuggers.rst
2020-01-18 10:35:31 +05:30
hiyokotaisa
3bcb664497 Fixes #65590 add pywinrm version explanation (#65591)
* 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 (#66257)
* 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 (#66022)
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 (#66235)
* Added a simple example to explain "dict2items" filters for better understading.

Fixes: #65505

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 (#62713) 2020-01-06 11:56:40 -05:00
Sandra McCann
80dff8743a fixed some broken links (#66182) 2020-01-06 10:24:07 -06:00
Lars Kellogg-Stedman
f85d9d7028 Correct rst syntax in playbooks_filters.rst (#66198)
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 (#65874) 2019-12-16 11:26:25 -06:00
Steve Leonard
af1c788ba7 Fix list formatting in Getting Started docs page (#65713) 2019-12-12 16:52:52 -06:00
Mossroy
c3c1708dea Fix variable name in an example (#65760)
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 (#65772) 2019-12-12 13:20:08 -06:00
Alicia Cozine
860cacc54f Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
Wojciech Sciesinski
95aef88a45 Update indentation used in the code examples, unify empty lines (#65346) 2019-12-10 10:55:51 -05:00
Evgeni Golov
3af1732bd8 fix rendering of GOOD/BAD code for regex_replace examples (#65654)
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 (#65447) 2019-12-10 09:05:18 -05:00
Sam Doran
21bbf49396 Mention Python builtin methods in filter docs (#65425) 2019-12-02 09:44:59 -06:00
林博仁(Buo-ren Lin)
8ebc57c186 Mention that Python keywords are invalid Ansible variable names (#65094)
* 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 (#64769) 2019-11-26 13:39:12 -05:00
Andrew Schultz
756ac826fe Improve ignore_unreachable documentation (#64938) 2019-11-26 13:35:02 -05:00
Kenyon Ralph
a797802d27 playbooks_filters_ipaddr.rst: fix syntax, indentation (#65208) 2019-11-25 15:00:15 -05:00
Sam Doran
0471ed3731 Add docs clarifying behavior of retry files (#65153) 2019-11-25 14:26:46 -05:00
gaoruifeng
f9f7a0c60e fix syntax issue (#65166)
- can disabled  
+ can be disabled
2019-11-25 15:01:10 +00:00
Alicia Cozine
b0c8e7926f link from quickstart page to Network Getting Started (#65150) 2019-11-21 11:42:57 -05:00
Baptiste Mille-Mathias
e65be0beee Put all files and Path filters under a specific section (#64913)
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 (#64796)
* 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 (#60594)
* 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 (#59144)
* 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 (#64775)
* 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 (#62345) 2019-11-08 16:23:33 -05:00
Jordan Borean
901eaf2ecc Add warning about winrm on MacoS (#64472) 2019-11-08 16:12:26 -05:00
Jordan Borean
74b0760cb4 Add note about kerberos dependency versions (#64478) 2019-11-08 16:11:18 -05:00
Bibas
f21f3219b2 [Fix] Typo in playbooks_environment.rst (#64496)
Change from `varaible` to `variable`
2019-11-06 17:31:16 +05:30
Caleb Collins-Parks
f178c49c02 Add warning about skipped vars (#63599) 2019-11-05 16:25:15 -05:00
Hiroki Kobayashi
e7cd5af1a6 Update intro_inventory.rst (#64345)
##### 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 (#64377)
* 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 (#64422)
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 (#64419) 2019-11-04 17:47:03 -06:00
Pierre Prinetti
2444fae208 Add a named parameter to the filter to_uuid (#64057)
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 (#64065) 2019-10-29 13:17:41 -04:00
Marek Czernek
18f4f0549f Correct a typo (#64020) 2019-10-28 15:01:10 -05:00
AndrewCi
c562e17659 Fixed example error in windows_winrm user guide (#63922)
##### 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 (#63548) 2019-10-21 17:02:19 -04:00
Pouyan Azari
f638f29e44 Replaced old DSC links that given 404 (#63556)
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 (#63356)
* 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 (#63164)
* 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 (#63085)
* 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 (#63056) 2019-10-08 13:46:38 -04:00
Abhijeet Kasurde
deda9d4cc5 VMware: Add module defaults for VMware modules (#63197)
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 (#63031)
Adds support for token authentication in Automation Hub. Fixes: ansible/galaxy-dev#96
2019-10-04 17:57:37 -04:00
Sam Doran
0311897722 Add docs on hiding sensitive data in loops (#63096) 2019-10-03 10:15:00 -05:00
Matt Martz
594a0fa9ae Add new truthy and falsy jinja2 tests (#62602) 2019-10-02 13:58:28 -04:00
Chris Houseknecht
911aa6aab9
Default collection install path to first path in COLLECTIONS_PATHS (#62870) 2019-10-02 10:22:00 -04:00
Felix Fontein
8bfc39e231 ACME module defaults (#62719)
* 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 (#62939)
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 (#62800) 2019-09-26 10:42:23 -04:00
Michael Prokop
b33ae14949 doc: fix typos (#62852) 2019-09-26 10:18:29 -04:00
Sandra McCann
7e01de96d7
add more anchors to collections docs (#62827) 2019-09-25 08:32:44 -04:00
Sandra McCann
7badeb6df0 [docs] split collections into user and dev guide sections (#62363)
* 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 (#62323)
* Add examples for various inventory setups to the documentation. This closes #12480.

* 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 (#62462) 2019-09-18 15:53:16 -04:00
Sloane Hertel
09f1c286e0 Add some details to any_errors_fatal documentation (#62029) 2019-09-12 16:15:02 -04:00
createchange
e3ea89801b Update playbooks_prompts.rst (#62003)
Fixed typo: "wierd" > "weird"
2019-09-10 06:57:01 +05:30
Christopher Engelhard
375eb9723a Add caution about handlers & import to Pitfalls (#61060)
* 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 (#61622) 2019-09-03 10:09:47 -05:00
James Cammarata
51b33b79c0
T woerner max concurrent (#60702)
* 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 (#61404)
* 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) (#61086)
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 (#61011)
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 (#60918)
Fix naming discrepancy in zip filter example
2019-08-20 09:53:15 -05:00
Jiri Tyr
da18e3b76c Updating intro_inventory.rst (#60676) 2019-08-16 09:23:58 -05:00
Jiri Tyr
c4d841f848 Updating intro_inventory.rst (#60651) 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. (#59858)
* 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. (#60492) 2019-08-13 09:47:28 -05:00