Commit Graph

2542 Commits (39a49963b5a6652a3d4eaed146dfafe869346457)

Author SHA1 Message Date
sgpinkus 2abb2d3f17
Update playbooks_variables.rst. To say you can define variables within a playbook is somewhat misleading. Variables are defined within plays and are only visible within the play they are defined in *not* the entire playbook. There is no way to define vars to have strictly playbook scope. (#73986)
+label: docsite_pr
4 years ago
Marketka 0bf9b7fdf8
Added prerequisites to install for CentOS (#73993)
* Added prerequisites to install for CentOS as well so CentOS users don't have to look for alternatives for each Ubuntu package.

Signed-off-by: mm667937 <marketa.muzikova@broadcom.com>


Signed-off-by: mm667937 <marketa.muzikova@broadcom.com>
4 years ago
saruter 73c08df2db
Docs: Add filter "urlencode" with example (#74034)
* Add example for URLENCODE filter
4 years ago
Alicia Cozine eb631c1881
use present tense for porting guide entries (#74021)
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Andrew Klychkov 46b02e125f
dev_guide/testing_integration: update image list (#74017) 4 years ago
David Greaves 4881ca1dcb
Introduce the concept of playbooks early on (#74018)
* Introduce the concept of playbooks early on
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Mark Mercado 3bccfb1615
Updating Community docs with DO information (#74019) 4 years ago
Andrew Klychkov 77ec2b3b3a
Documentation: update committer_guidelines.rst (#73782)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Toshio Kuratomi c8a7899869
Update the porting guide for a new ansible version (#74016) 4 years ago
Andrew Klychkov 0543916a86
Docsite: clarify a changelog entry format (#73902)
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Jim Speir 4780e10a2b
Adding jborean93/WindowsServer2019 in docs (#73950) 4 years ago
Matt Davis c6cf7986ab
add porting guide info for optional module_utils (#73979) 4 years ago
Brian Coca ccd9a992cf
complex data example using value and default from list of dicts (#73937) 4 years ago
sgpinkus efe97aeb31
Update developing_inventory.rst (#73931)
* Update developing_inventory.rst

hashes/dictionaries in JSON (JavaScript Object Notation) are represented by what JSON calls "objects", so use that established terminology instead of "hash", "dictionary", or "hash/dictionary" etc.

* Update docs/docsite/rst/dev_guide/developing_inventory.rst

Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
4 years ago
Ompragash Viswanathan 561cdf3ace
Updated COLLECTIONS_4.rst to include ansible-inclusion repo link for new collection submission (#73582)
Co-authored-by: Sandra McCann <samccann@redhat.com>

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Sloane Hertel 95dc8f2361
Add some dev documentation for constructed features (#73497) 4 years ago
Alicia Cozine 30c465c1a9
Promote publication (#72400)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Alicia Cozine b57444af14
Rebased pr73824 (#73934)
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Toshio Kuratomi 0279d02980 Add porting guide for ansible 4 4 years ago
Toshio Kuratomi e10da3c368 Porting guide changes when adding a new ansible release
* Add the ansible-4 porting guide to the index
* Need to exclude the porting guide for ansible-4 from the core docs build
4 years ago
Ikko Ashimine 3098022146
Fix typo in porting_guide_3.rst (#73871)
paramater -> parameter
4 years ago
Toshio Kuratomi 197e8f5640
Mention that minor releases end once the next ansible release is made. (#73836) 4 years ago
Toshio Kuratomi 780f79ecbc
Update the porting guide for a new ansible version (#73856) 4 years ago
Sandra McCann bd020dd14a
describe what ansible-core is (#73829) 4 years ago
Jens Heinrich 27eaab310b
Add direct link to using multiple inventory sources (#73680)
This helps users to find the right ressources more easily and prevents them from clicking the first matching link only to be redirected to a subsection on the samepage from there

Co-authored-by: Jens Heinrich <github.com/JensHeinrich>
4 years ago
Alicia Cozine 474f46ea56
Docs: Updates the release and maintenance page to reflect new cadences (#73781)
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
bylerbk 1ac2858b5a
Update developing_modules_general.rst (#73805)
##### SUMMARY
<!--- Fixing a typo. There was a double "you" in the text. -->


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Alicia Cozine 31932f5fa3
Docs: Update installation page for package split (#73790) 4 years ago
Felix Fontein b2015c98e2
validate-modules: make sure that options that potentially contain secret data have no_log set (#73508)
* Catch more potential errors (and increase false-positive rate).
* Flag some false-positives in lib/ansible/modules/ with no_log=False.

Co-authored-by: John Barker <john@johnrbarker.com>
4 years ago
Yanis Guenane 212837defc
Documentation: Lay the ground for i18n work. (#73746)
* Documentation: Lay the ground for i18n work.

* Translating both ansible-core and ansible docs requires msgcat
  (a program from the gettext package). If msgcat is not present,
  only the ansible-core index file's strings will be extracted for translation.
  If this is a problem, a short hacking script could be written to take the
  place of msgcat (merging the various index pot files into a single pot file).

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
4 years ago
David Shrewsbury 78d3810fdf
Auto cleanup of async cache file (#73760)
* Auto cleanup of async cache file

* Add changelog
4 years ago
Rick Elrod 2d85c9de93
Some changelog fixes for 2.11 (#73778)
Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Sandra McCann 6514027957
add base 2.10 to docs version switcher (#73770) 4 years ago
Felix Fontein c888705493
Add note on infoblox inventory script. (#73676) 4 years ago
Brian Williams 1f2f292290
Fix invalid yaml in collections_using.rst (#73727)
Fix invalid quoting.
4 years ago
Felix Fontein 3cc693b92c
Import test: improve docs, add more tests (#73600) 4 years ago
Brian Coca 91b42d62fa
another useful example (#73728) 4 years ago
Alicia Cozine 29d3951464
Docs: Adds banner for core/package split (#73552)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Sandra McCann f4eab92aa0
fix core version switcher (#73704) 4 years ago
Sviatoslav Sydorenko c22bc46cb9
Mention `ansible-core` @ "Release and maintenance" (#73612) 4 years ago
Viktor Ekholm b28abdfbdb
Fixed typo in vault documentation (#73666)
Example variable was named `my_encrytped_var`. Renamed it to `my_encrypted_var`.
4 years ago
David Shrewsbury c8ee186e11
Remove warning about role validation with deps (#73653)
* Remove warning about role validation with deps

* add changelog

* update cl
4 years ago
Willams de Lima fa05af8321
Fixing ad-hoc commands #73636 (#73646) 4 years ago
Toshio Kuratomi 89ed2353e0
Update the porting guide for a new ansible version (#73650)
* Update the porting guide for a new ansible version

* Add a link to the changelog to the ansible-3 porting guide
4 years ago
Sandra McCann ccbfdec334
Split Ansible docs from core docs (#73616)
* excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build

This solution builds three types of docs:
* ansible-2.10 and earlier: all the docs.  Handle this via `make webdocs
  ANSIBLE_VERSION=2.10`
* ansible-3 and later: a subset of the docs for the ansible package.
  Handle this via `make webdocs ANSIBLE_VERSION=3` (change the
  ANSIBLE_VERSION to match the version being built for.
* ansible-core: a subset of the docs for the ansible-core package.
  Handle this via `make coredocs`.

* `make webdocs` now always builds all the collection docs
*  Use `make coredocs` to limit it to core plugins only
*  The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible
 
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Matt Clay <matt@mystile.com>
4 years ago
Sebastian Haderecker 27baa8cd86
OpenStack guidelines: Replace with link (#73617)
Replace the guidelines page with a link to the current guidelines on opendev.org.
4 years ago
David Moreau Simard d40da3ee0b
Update 2.10 porting guide to include module index (#73615)
This will help users find out where modules and plugins might have been moved.
4 years ago
Felix Fontein 1f3a90270b
Import sanity test for plugins (#72497) 4 years ago
Lydie 4059b37ab1
Conscious language added to user guide, development guide, and Ansible community guide, (#73574)
* Added conscious language note to index pages of guides
4 years ago
David Shrewsbury f0ec10dbc3
Role arg spec validation implementation (#73152)
* Initial import of modified version of alikins' code
* Add unit testing for new Role methods
* Fix validate_arg_spec module for sanity test. Add test_include_role_fails.yml integration test from orig PR.
* Add testing of suboptions
* Use new ArgumentSpecValidator class instead of AnsibleModule
* fix for roles with no tasks, use FQ name of new plugin
* Add role dep warning
4 years ago
Toshio Kuratomi 2b227203a2
Ansible 4 roadmap (#73465)
Co-authored-by: Deric Crago <deric.crago@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Deric Crago <deric.crago@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Brian Coca 1cb753225c
added perf note to inc/imp diffs (#73371) 4 years ago
Brian Coca 4334957e2c
add that we now validate choices to porting guide (#73509)
for those that had choices that didn't match actual values used
4 years ago
Rick Elrod 7cd577cc16
Fill in some 2.11 roadmap dates (#73560)
Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Florian Sey ae241b407a
Update guide_azure.rst (#73030)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Toshio Kuratomi bf10bb370b
Update the porting guide for a new ansible release (#73547) 4 years ago
Matt Martz d3441bc313
Add new split filter (#73532)
* Add version added
4 years ago
Jill R 7fb7d138fb
Update working group links for cloud collections (#73471) 4 years ago
Sloane Hertel bd18be6c0c
Fix ansible-galaxy collection subdir searching and update documentation (#73406)
* Ensure there is a single source of collection metadata
* Allow collection subdirs to be detected by a galaxy.yml or MANIFEST.json
* Add documentation about installing and downloading collection directories
* Add an example for downloading a git repository
* Update documented valid metadata sources for installing git repositories

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Sloane Hertel 9759e0ca49
add option to upgrade collections (#73336)
* Add a flag to ansible-galaxy to update collections


Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
4 years ago
Akira Yokochi fce22529c4
fix typo (#73434) 4 years ago
Toshio Kuratomi 564a0fce4a
Add the porting guide for Ansible-3.x (#73455) 4 years ago
Matt Clay 607af05d36 Fix syntax errors detected by rstcheck.
The errors occur when using sphinx >= 2.0.0.
4 years ago
David Moreau Simard 1265c6def3 Update porting guide for 2.10.6 4 years ago
Felix Fontein 76604397cb
Mention that C(...) should be used for inline code. (#73312) 4 years ago
Sviatoslav Sydorenko ab667200cc
Mention renaming ansible-base to -core @ roadmap (#73354)
* Mention renaming ansible-base to -core @ roadmap

* Replace ansible-base with ansible-core @ roadmap
4 years ago
Sviatoslav Sydorenko 6abeabaff1 Fix `versionadded` syntax @ galaxy user guide 4 years ago
Abhijeet Kasurde 7f6fcc3407
json_query: Update documentation (#73302) 4 years ago
Brian Coca dec443e3a5
why no mfa? (#73324)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
4 years ago
Nilashish Chakraborty 45240c1871
Update NX-OS platform guide with MDS information (#73315)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
4 years ago
luto 51e00c5e86
Fix documentation for slaac filter (#73294)
##### SUMMARY

One of the parameters to the slaac filter was unquoted causing a crash:

```
template error while templating string: expected token 'end of print statement', got ':'. String: {{ fdcf:1894:23b5:d38c:0000:0000:0000:0000 | slaac('c2:31:b3:83:bf:2b') }}
```

This adds the missing quotes.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Brian Coca 13ea312cc8
added pb fqcn docs (#72602)
* added pb fqcn docs
4 years ago
Koki Kato d500e6ec45
doc: fix ansible_play_hosts description about failure (#73190)
The variable ansible_play_hosts actually does _not_ includes failed or unreachable hosts.

+label: docsite_pr
4 years ago
Felix Fontein 73aa571305
Make sure to mention collection version for version_added as well. (#73270) 4 years ago
Martijn Suijlen aa21804165
Added TLS security protocol for Powershell downloads (#73226)
##### SUMMARY
Added `[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12` to the Powershell scripts that use a file download. If not specified the script won't be allowed to download data from the mentioned URL's.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Brian Coca 1202dd000f
Allow restricting config values to enumerated list (#73162)
* Allow restricting config values to enumerated list
* dont document internal entries
* also ignore private defs for ansible-config
* remove invalid value from tests
* added porting entry
4 years ago
Adam Miller e9a1ff296e
Fix block example line emphasis (#73238)
Signed-off-by: Adam Miller <admiller@redhat.com>
4 years ago
Gregor Riepl 403a3b90b5
Fix list to dict example (#73213)
##### SUMMARY
<!--- Your description here -->
single_list must be transformed to a list of pairs before feeding it into dict()

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Felix Fontein 270385f949
Remove 'type: complex' from the example, and mention that it should be avoided. (#73171) 4 years ago
Jens Heinrich 8a202cae3e
Update developing_collections.rst (#73142)
Fix typo - FQCN not FCQN.
4 years ago
Sascha Marcel Schmidt 61f0d6b919
add note regarding datetime docs (#72976)
Adds a note pointing to the datetime documentation as to_datetime does not use the time library but instead uses datetime.
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Tim Herty 995e76c6e3
Update windows_winrm.rst (#73101)
The standard Port for ansible winrm is set to 5986/HTTPS. 
To be able to use Kerberos, you need to set ansible_port: 5985/HTTP otherwiese you get error message or timeout.
HTTPS is not needed for environments with Kerberos, since kerberos has server identification built in to the protocoll.
FYI: HTTP traffic will by default also be encrypted when using kerberos
4 years ago
Sandra McCann 0936623901
update the docs requirements versions (#73108) 4 years ago
Felix Fontein c9f28c1735
Rewrite Docker scenario guide (#73069) 4 years ago
Alicia Cozine 1d8760779c
left a stray </div> by mistake (#73132)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Deric Crago 24e8ba7c9e
Update the porting guide for a new ansible version (#73124) 4 years ago
Abhijeet Kasurde 25792d2388
galaxy: handle plus sign in user token appearing in role url (#73057)
Fixes: #45475

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Sandra McCann 0a3c5d9dcc
remove doc survey banner (#73119) 4 years ago
Jean-Pierre Matsumoto 3074ede8a3
ExecutionPolicy default value is RemoteSigned (#72993)
* ExecutionPolicy default value is RemoteSigned

##### SUMMARY
In Windows setup steps, settings `ExecutionPolicy` is restored to value `Restricted`. But actually default value for Windows server is not `Restricted` but `RemoteSigned` ([source](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1#default)).

I have got issue with `win_dsc` because `ExecutionPolicy` was `Restricted`.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Add changelog fragment

* Apply suggestions from code review

Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Abhijeet Kasurde 776274143f
galaxy: Update example for git+file (#73053)
Use correct syntax for installation of role from
local git repository.

Fixes: #72217

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Simeon Bobylev 202689b1c0
Update lookup.rst (#72831)
##### SUMMARY
Set correct indentation.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Dmitry 79ab1247b8
Fixed vault id in variable encryption example (#72626) 4 years ago
Sam Doooran 103decccac
Add complex example of fileglob with loop (#72396)
* Add complex example of fileglob with loop

* Explain Python unpacking notation

* Add missing paren
4 years ago
Matt Martz 97765f4ebd
Role duplicates docs updates (#72666)
* Change example to use role params to represent the documented outcome. Fixes #68922

* Add notes about how vars vs role params affect variable scoping, and how lazy evaluation and role-deduplicating is affected. Fixes #72650

* link to term
4 years ago
Felix Fontein b514200126
Add link to all module and plugin indexes (#72743)
* Add link to all module and plugin indexes.

* Use glob setting for toctree.

* Explicitly include new file.

* Move all_plugins one level up.

* Revert "Move all_plugins one level up."

This reverts commit bd47e82ead.

* Revert "Explicitly include new file."

This reverts commit 74ae50a734.

* Adjust .gitignore

* Revert "Revert "Explicitly include new file.""

This reverts commit f30d99c861.

* Fix docs make clean

Now that there's a static file in rst/collections, we have to be more
explicit about how we clean the generated files out of that directory.

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
4 years ago
Sam Doooran 8fdb5ace01
Update WSL docs to mention sleep workaround (#72839)
Co-authored-by: Joseph Chambers <joe.chambers@lexisnexis.com>
4 years ago
tkhkokd 389c7b7806
Documentation fix, /etc/apt/source.list from non-code block to code block (#72933)
/etc/apt/source.list
was sentence, not code-block. Therefore made it code-block
4 years ago
azrdev 6487a239c0
developing_inventory sample code: fix undefined var "results" if get_option(cache)=False (#72977)
if user_cache_setting == False, then the previous code didn't parse the inventory source
4 years ago
Jamie Wark 7eee2454f6
Remove note on combining roles and collections (#72957) 4 years ago
flowerysong 8450858651
Remove inaccurate Vault documentation (#72938)
This is not functionality that exists.
4 years ago