Commit graph

2422 commits

Author SHA1 Message Date
Sayee
ecd3b52ad7
Writing style updates to Developing dynamic inventory topic ()
* modified the writing style

* incorporated peer feedback
2020-08-17 14:16:19 -05:00
Abhijeet Kasurde
ecea018506
Fix 404 links ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-17 13:52:45 -04:00
Felix Fontein
ee48e0b0ad
Fix roadmap formatting. () 2020-08-17 13:50:22 -04:00
Felix Fontein
61b7f234bd
Update auto-generated 2.10 porting guide in devel. () 2020-08-17 13:49:38 -04:00
Andrew Klychkov
a496b89d6f
overview_architecture.rst: fix playbook example () 2020-08-17 13:44:05 -04:00
Andrew Klychkov
9296ee9329
developing_modules_in_groups.rst: add note about releasing () 2020-08-17 13:43:15 -04:00
Baptiste Mille-Mathias
92d59a58c0
Fix code markups and add link to CVE () 2020-08-17 10:55:30 -04:00
Toshio Kuratomi
e507c127e5
Move 2.10.0rc1 release date a few days forward. ()
At yesterday's meeting it was decided to have ansible-2.10.0 depend on
ansible-base-2.10.1 so that we can get several fixes for ansible-base's
routing (including adding the gluster.gluster collection).
ansible-base-2.10.1 will release on September 8th.  So we will plan on
releasing ansible-2.10.0rc1 on the 10th.

https://meetbot.fedoraproject.org/ansible-community/2020-08-12/ansible_community_meeting.2020-08-12-18.00.html
2020-08-13 17:21:36 -05:00
Sayee
4f0bd5de38
a few writing style updates () 2020-08-13 10:53:29 -05:00
Sandra McCann
553ccedcd3
Update release page for ansible and ansible-base ()
* [docs] 2.7 is EOL, add 2.10 which is almost out
- Remove 2.7 support from the maintenance schedule
- Add 2.10 which is in RC and will be out soon enough.
Signed-off-by: Rick Elrod <rick@elrod.me>

* Update docs/docsite/rst/reference_appendices/release_and_maintenance.rst, fix table and separate ansible-base from ansible, fix rstcheck errors, clean up sections, explain the two packages
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
2020-08-12 15:51:38 -05:00
Alicia Cozine
ae3b8eec12
Adds fest link ()
* adds two possible links to AnsibleFest - pick one

* selected preferred text

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-08-12 16:44:56 -04:00
Sam Doran
888be697cb
Revert "Change default file permissions so they are not world readable ()" ()
* Revert "Change default file permissions so they are not world readable ()"

This reverts commit 5260527c4a.

* Revert "Fix warning for new default permissions when mode is not specified ()"

This reverts commit dc79528cc6.
2020-08-12 12:29:04 -05:00
Andrew Klychkov
19589db10c
Fix references to Ansible Collections Overview () 2020-08-12 12:06:22 -04:00
Sayee
7195788ffe
updates per writing style ()
* updated to follow IBM and Ansible style guides
* modified heading underlines
* incorporated peer review feedback
2020-08-10 17:39:34 -05:00
Abhijeet Kasurde
0a7ab396c7
filters: minor doc fix ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-10 16:32:15 -04:00
Sandra McCann
172230d7b8
update Ansible-maintained platform guides with FQCN ()
* update platform guides with FQCN
* implemented feedback
* fix remainin fqcn
* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-08-10 15:09:35 -05:00
Sandra McCann
f4388de14d
add another resource module example ()
* Update docs/docsite/rst/network/user_guide/network_resource_modules.rst
Co-authored-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
2020-08-10 11:18:43 -05:00
Håkon Solbjørg
e72e12aa27
docs: 'ansible_play_hosts' lists active hosts, not limited by serial ()
ansible_play_batch lists the currently targeted host(s) in the serial/batch, while
ansible_play_hosts lists all the hosts which will be targeted by the play.
2020-08-10 09:42:45 -05:00
Brian Coca
f46b124d65
start of 'data manipulation' examples ()
Co-authored-by: Klaus Frank <agowa338@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-10 10:18:41 +05:30
kshitijcode
5f8b45a70e
Updating Getting Started with Resources section ()
* Updating Getting Started with Resources section 
* Add links, including Workshops URL 
2020-08-07 16:09:19 -05:00
Sandra McCann
56748a8060
remove network for 2.10 base porting guide () 2020-08-07 14:27:01 -05:00
Sandra McCann
abe4a1d533
remove network section from base porting guide () 2020-08-07 14:26:49 -05:00
Toshio Kuratomi
0a9638ce4b
Update the porting guide for ansible-2.10.0a8 () 2020-08-07 12:22:02 -04:00
Daniel Finneran
fb9c9570d5
Fixes due to branch being renamed ()
The ansible collection repository correctly renamed their default branch from `master` to `main`, which has caused a number for broken urls. This PR fixes those urls.
2020-08-06 14:14:27 -05:00
Liviu Chircu
cb9336ab6d
Docs: Fix typo ()
Fix typo
2020-08-06 14:12:33 -05:00
Rick Elrod
4e55b93613
virt facts: allow guest/host to have >1 virt tech ()
Change:
- Allow systems to declare multiple virt techs. For example if a system
  is both a docker container, but virtualized on KVM, show both. If a
  system is set up to run virtualbox and KVM VMs, show both.

- This is done by introducing new facts keys:
  - virtualization_tech_guest
  - virtualization_tech_host

- Backwards compatibility is preserved by keeping track of the previous
  return-points and refusing to update those keys after we would have
  returned, but now returning them at the end, so that the new keys can
  accumulate their data.

Test Plan:
- Local
- CI

Tickets:
- Refs 
- Refs 
- Refs 
- Probably others

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-06 09:45:37 -05:00
Toshio Kuratomi
fb144c4414
Update ansible doc formats ()
* Fix tty_ify bugs and refactor

* Move tty_ify() and supporting attributes to the DocCLI class as that's
  the only thing using it.
* Add unittest for the code.
* Fix a bug where the substitution macros can be detected when they are
  a part of another word.
* Add support for L(), R(), and HORIZONTALLINE which were added to the
  website docs many years ago.

* Update test/units/cli/test_doc.py

Co-authored-by: Matt Clay <matt@mystile.com>

Co-authored-by: Matt Clay <matt@mystile.com>
2020-08-05 10:53:25 -07:00
Sandra McCann
72d3d44163
add note to uninstall older versions of ansible for pip ()
* add note to uninstall older versions of ansible for pip

* combine with the other PR
2020-08-04 13:39:24 -05:00
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
Jeff Groom
79f7104556
Update platform_index.rst () 2020-08-04 14:31:37 -04:00
Abhijeet Kasurde
0055673c70
VMware: Inventory scenario guide for hostnames ()
Added a scenario guide for ``hostnames`` parameter
for vmware_vm_inventory.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-04 14:30:33 -04:00
Sloane Hertel
a9eb8b0488
Add some documentation for the format of meta/runtime.yml ()
* Document the format of meta/runtime.yml

* Document multiple Ansible versions

Clarify difference between deprecation and tombstone fields

* add note
2020-08-04 11:25:08 -04:00
Rick Elrod
7f62a9d7b5
Make cache adjudicator's flush call plugin flush ()
Change:
- Previously CachePluginAdjudicator#flush only removed entries from the
  cache backend that it knew about by using them earlier. Now it calls
  the underlying plugin's flush() method.

Test Plan:
- New unit tests

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-03 17:16:15 -05:00
Brian Coca
11a31e99e6
added note about fakeroot ()
see 
2020-08-03 16:36:26 -04:00
Nathaniel Case
a0523e5b8a
Update documentation of httpapi's handle_httperror method for clarity () 2020-08-03 16:35:00 -04:00
Alicia Cozine
4f4436c124
updates changelog types; some updates for easier translation ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-08-03 13:46:41 -04:00
Toshio Kuratomi
e10902d744
Add the ansible_2_10 intersphinx reference. ()
There are links from the scenario guides to collections but collections
docs aren't built in testing or locally when we're on the devel branch.
Due to that we need to make sure those references resolve to the
production docsite.  We can use intersphinx to make sure that happens.

* The test for binary files wasn't reading enough of the file.

Checking for null bytes in the first 1024 bytes failed to diagnose the
ansible_2_10.inv file as binary
2020-08-03 12:31:36 -05: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
Terciero
864573a38d
Document common return values with examples ()
* adding return value examples
* shift to console code blocks
* cleaning up whitespace and shortening invocation example
* reordering diff section
2020-08-03 11:51:58 -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
EthanHur
0c855dc70b
Guide users to use ansible-runner ()
Update the docs to guide users to use `ansible-runner` instead of using Python API directly. In many use cases, executing Ansible playbooks are sufficient. In those use cases, `ansible-runner` is easier and much stable to use comparing with Python API, but there is no mention of it.
2020-08-03 10:15:37 -05:00
Sandra McCann
54bee7152b
Update network platform guides with FQCN ()
* fqcn all the docs things!
2020-07-31 15:57:57 -05:00
Felix Fontein
61b36c6f30
Porting guides for ansible-base 2.10 and ansible 2.10 ()
* Fix changelog link title.

* Rename Ansible 2.10 and 2.11 porting guides to Ansible-base porting guides.

* Add stub for automatically generated 2.10 porting guide.

* Move things that should not be in the ansible-base porting guide to the ansible porting guide.

* Apply changes to base porting guides.

* Add remark that ansible-base is mainly for developers.

* Ansible Base -> Ansible-base

* Fix link in base porting guide.

* Add generated porting guide.

* Use same header signs as antsibull-changelog's RST builder.

* Update generated porting guide.
2020-07-31 15:28:18 -05:00
Felix Fontein
698efb8981
'Foreport' changes to 2.10 porting guide from stable-2.10 to devel. ()
Without this, this change would get lost when backporting , or would make backporting a lot harder.
2020-07-31 12:53:23 -05:00
Baptiste Mille-Mathias
5019335660
Document how to upgrade to ansible with pip ()
Fixes 
2020-07-31 13:13:54 -04:00
Sandra McCann
58145dff9c
document how to migrate between collections ()
* document how to migrate between collections
* Apply suggestions from code review

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-07-30 15:51:53 -05:00
Alicia Cozine
9879da8e23
DOCS: add 2.10 collections roadmap ()
* draft of 2.10 collections roadmap

* incorporates feedback from felixfontein

* gundalow and samccann feedback, fix link

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-30 16:26:03 -04:00
Baptiste Mille-Mathias
d62dffafb3
Add latest rc from ansible-base ()
* Add latest rc from ansible-base
2020-07-30 14:56:56 -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
Sam Doran
dc79528cc6
Fix warning for new default permissions when mode is not specified ()
Follow up to 
Related to 
CVE-2020-1736

When set_mode_if_different() is called with mode of 'None', ensure we issue
a warning about the change in default permissions.

Add integration tests to ensure the warning works properly.

* Fix tests
- actually use custom module 🤦‍♂️
- verify file permission on created files
- use remote_tmp_dir so we're ready for split controller
- improve test module so we can skip the call to set_fs_attributes_if_different()
- fix tests for CentOS 6
2020-07-30 00:05:29 -04:00
Rick Elrod
14dc4de424
Update docs for --tags default, and add some tests ()
Change:
- Clarify that not passing `--tags` will cause `ansible_run_tags` to
  default to `["all"]`.
- Add some extra coverage around `ansible_run_tags`

Test Plan:
- New integration and unit tests

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-07-29 17:16:57 -05:00
Sam Doran
7f0c84ea15
Update module debugging docs ()
- Combine remote and local debugging instructions.
- Update the example code to match current AnsiballZ structure and behavior
- Change reference name and update references
- Clarify how PYTHON path is modified
- Also add note about other remote debugging tools.

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-07-29 12:14:49 -04: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
PJ Waskiewicz
69e5c6c14a
Update network_best_practices_2.5.rst ()
Fix a small typo in the playbook tasks sample section
2020-07-29 11:41:18 +05:30
Sandra McCann
748ba96610
How to use rst :ref: for modules in collections () 2020-07-28 17:40:16 -05:00
Sorin Sbarnea
787e6108e0
Document galaxy install from local clones () 2020-07-28 14:05:28 -04:00
Sandra McCann
8fb8f1b2a0
fix changelog link () 2020-07-28 11:11:15 -04:00
Felix Fontein
7e2cc7db12
validate-modules: fix version_added validation for top-level, fix error codes ()
* Also validate top-level version_added.

* Fix error code.

* Produce same version_added validation error in schema than in code (and stop returning it twice).

* Return correct error codes for invalid version_added for options and return values.

* Add changelog.

* Fix forgotten closing braket.

* Accept 'historical' for some top-level version_added.
2020-07-28 10:10:35 -05:00
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
Sviatoslav Sydorenko
20bb915092
Refactor Python API examples and docs
PR : it's a follow-up for .

It includes a merge of `examples/scripts/uptime.py` and a similar
code snippet from `docs/docsite/rst/dev_guide/developing_api.rst`.

This patch also changes the docs RST file to include contents of
the example file instead of holding a copy of a similar code.
2020-07-23 18:24:02 +02:00
Matt Davis
4c0af6c808
fix internal cases of actions calling unqualified module names ()
* fix internal cases of actions calling unqualified module names

* add porting_guide entry
* misc other fixes around action/module resolution broken by redirection

ci_complete

* Update docs/docsite/rst/porting_guides/porting_guide_2.10.rst

Co-authored-by: Rick Elrod <rick@elrod.me>

* Update docs/docsite/rst/porting_guides/porting_guide_2.10.rst

Co-authored-by: Rick Elrod <rick@elrod.me>

* address review feedback

* pep8

* unit test fixes

* win fixes

* gather_facts fix module args ignores

* docs sanity

* pep8

* fix timeout test

* fix win name rewrites

Co-authored-by: Rick Elrod <rick@elrod.me>
2020-07-23 09:02:57 -07:00
Alicia Cozine
b28d59124b
WIP: add collections as an intersphinx link ()
* adds collections as a ref for intersphinx

* no need for intersphinx

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-23 08:44:05 -07:00
Sam Doran
5260527c4a
Change default file permissions so they are not world readable ()
* Change default file permissions so they are not world readable

CVE-2020-1736

Set the default permissions for files we create with atomic_move() to 0o0660. Track
which files we create that did not exist and warn if the module supports 'mode'
and it was not specified and the module did not call set_mode_if_different(). This allows the user to take action and specify a mode rather than using the defaults.

A code audit is needed to find all instances of modules that call atomic_move()
but do not call set_mode_if_different(). The findings need to be documented in
a changelog since we are not warning. Warning in those instances would be frustrating
to the user since they have no way to change the module code.

- use a set for storing list of created files
- just check the argument spac and params rather than using another property
- improve the warning message to include the default permissions
2020-07-22 17:05:38 -04:00
David Shrewsbury
bf98f031f3
Sanitize URI module keys with no_log values ()
* Add sanitize_keys() to module_utils.

* More robust tests

* Revert 69653 change

* Allow list or dict

* fix pep8

* Sanitize lists within dict values

* words

* First pass at uri module

* Fix insane sanity tests

* fix integration tests

* Add changelog

* Remove unit test introduced in 69653

* Add ignore_keys param

* Sanitize all-the-things

* Ignore '_ansible*' keys

* cleanup

* Use module.no_log_values

* Avoid deep recursion issues by using deferred removal structure.

* Nit cleanups

* Add doc blurb

* spelling

* ci_complete
2020-07-22 14:49:37 -05:00
Sayee
1733253297
Modification of 'Adding modules and plugins locally' topic ()
* Remediated the topic to comply with IBM style guide and minimalism practices
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-07-22 11:59:18 -05:00
Sorin Sbarnea
b7ee07215d
Update Molecule support contact ()
As Molecule started to use https://github.com/ansible-community/molecule/discussions we need to update documentation before retiring
the molecule-users mailing list.
2020-07-22 11:53:52 +01:00
Sandra McCann
2a7df5e07b
add note for write permission on rst files ()
* add note for write permission on rst files
* Update docs/docsite/rst/community/documentation_contributions.rst

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-07-21 16:00:47 -05:00
Sandra McCann
24e5d3a51c
fix rstcheck problem and gitignore collections dir () 2020-07-21 15:59:56 -05:00
Baptiste Mille-Mathias
59513ae673
Fix incorrect statement to set a variable for a playbook ()
Fixes 
2020-07-20 13:45:40 -05:00
Baptiste Mille-Mathias
92e16c2838
Few fixes for reference_appendices/faq.html ()
* Format using `` instead of `, add line breaks for long lines, rephrase or remove useless text.
Move some text.

* Add clearer version of OpenSSh is affected by SCP bug

* Review some pages using ansible doc writing guide.
2020-07-20 13:43:39 -05:00
Stef B
fb3db170cc
Make Sources, Plugins sections easier to read ()
Re-wrote the Inventory Sources section and also the next section to have shorter, clearer sentences with a more active voice.
2020-07-20 13:30:06 -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
Matt Davis
02c63ec285
update roadmap rc1 date () 2020-07-15 11:47:36 -07:00
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 () 2020-07-14 17:00:44 -04:00
Alicia Cozine
f1f782fc37
partial update of community docs to reflect collections transition () 2020-07-14 15:47:18 -04:00
Abhijeet Kasurde
375c6b4ae4
docs: update date format in removed_at_date ()
removed_at_date requires YYYY-MM-DD format.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-07-14 11:43:25 -04:00
Abhijeet Kasurde
20209c508f
docs: update module development docs ()
Update module development docs for flattened modules directory.

Fixes:  (at least partially)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-07-13 14:41:59 -05: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
Andrew Klychkov
edcd1a1a70
Doc: fix examples of changelog entries. () 2020-07-10 16:17:03 -04:00
Amin Vakil
9c40b1b2ff
Replace filename with file in apt_key ()
* Replace filename with file from apt_key check

  one is internal variable, the other is actual parameter used and required for parameter check.
2020-07-10 12:42:49 -04: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
Mark Chappell
e1ba7dc52a
Update AWS Integration test docmentation () 2020-07-08 08:01:37 +05:30
Rick Elrod
707458cc8c
Make netbsd virtualization facts more specific ()
Change:
Our handling of NetBSD virtualization facts led to facts that were just
plain incorrect. One example is reporting Xen even when the system is
running on something completely different (like KVM).

As stated by the reporter of , NetBSD has a better sysctl setting
to use for this information, machdep.hypervisor.

This PR does the following:

- Try to use machdep.hypervisor sysctl value if the other sysctl values
  we check don't end up with enough information to be useful
- Only look for /dev/xencons and assume Xen if nothing else works
  (Really this should probably return 'unknown' since the file exists on
  non-Xen systems and is not very useful).
- Add a few more patterns (Xen matches and also Hyper-V) to
  VirtualSysctlDetectionMixin#detect_virt_product.

This change is slightly breaking:
- If the first two attempts at using sysctl worked before,
  (machdep.dmi.system-product and machdep.dmi.system-vendor), they will
  continue to work.
- For cases when those values didn't work, previously the existence of
  /dev/xencons was checked, and if found, we reported 'xen' (even on
  non-Xen systems when the file existed). After this PR, we try the
  machdep.hypervisor sysctl key before still falling back to
  /dev/xencons. This means that in some cases, we might go from
  (wrongly) saying "xen" to giving a more accurate value such as "kvm"
  or "Hyper-V".

Test Plan:
- Tested with local NetBSD VM and got 'kvm' instead of 'xen' back.

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-07-07 17:28:13 -05:00
Baptiste Mille-Mathias
bd1378405b
Small documentation fixes ()
* Add type for options in the sample module shown in Developing Modules, as this is required to have the tests being
green
* Remove duplicated strings: the same sentence is in "Python tips" and "Module security", keeping the
latter.
2020-07-06 12:53:10 -05:00
Sviatoslav Sydorenko
8d97c8c222 Fix the internal Python API usage examples
Previous version initialized the `TaskQueueManager` after calling
`Play.load()` while advertising a way to inject a custom library
location path. This caused the tasks loader not to find any custom
modules because it was triggered before the path was actually added
to the module loader.

This patch changes the order of the operations to ensure that the
customized `context.CLIARGS` actually influences things.

Resolves https://github.com/ansible/ansible/issues/69758.
2020-07-03 10:44:54 +02:00
Michael Ritsema
82e5d03bdb
Suggest ansible ad-hoc command while developing module ()
If a local module has no documentation, the doc command will fail without any hints of what is wrong. Add another way to confirm the presence of a local module.
* Update docs/docsite/rst/dev_guide/developing_locally.rst

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-07-02 17:23:37 -05:00
David Shrewsbury
4e41e37aa7
Fix flatten null perserve versionadded () 2020-07-02 13:28:39 -05:00
Sandra McCann
aa59c23aed
update platform table with links to collections () 2020-07-02 10:20:11 -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
Sir Mobus Gochfulshigan Dorphin Esquire XXIII
a1ac595d42
Minor grammatical fix ()
'you' -> 'your'
2020-07-01 10:47:08 +05:30
Sandra McCann
5a28b2b86c
Add steps for how to create changelog.rst for a collection ()
* Update docs/docsite/rst/dev_guide/developing_collections.rst
* add steps to create changelogs, add sentence about not using the tool
* add note for rerunning the command

Co-authored-by: Felix Fontein <felix@fontein.de>
2020-06-29 14:22:31 -05:00
Abhijeet Kasurde
e4f48c920c
Docs: mention about Ansible workshops ()
Lightbulb is deprecated in favor of https://ansible.github.io/workshops/
Update links accordingly.
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-06-29 14:06:04 -05: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
Sandra McCann
83f6e4850b
document FQCN for M() and :seealso: in DOCUMENTATION blocks ()
* document FQCN for M() in DOCUMENTATION blocks

* add note about c
2020-06-29 11:16:59 -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
Matt Clay
4816bb4f43
More boilerplate fixes. ()
* Fix boilerplate in hacking dir.
* Fix boilerplate in docs dir.
* Fix boilerplate in integration tests.
* Fix boilerplate in examples.
2020-06-22 19:05:30 -07:00
Alicia Cozine
4a0f42923b
adds japanese translation as a version-switcher option ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-22 16:25:44 -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
Abhijeet Kasurde
da868d9d60
docs: Add note about ansible-doc ()
ansible-doc can only parse Python modules, added a note about
this is developer guide; Fixes: 
2020-06-19 14:28:02 -05:00
Jill R
0ef75f65d9
Fix broken link in AWS Guide ()
Point to collection rather than ansible/ansible for example.
2020-06-19 14:18:55 -05:00
Sandra McCann
647c6cd289
updates to ansible-maintained collections guidelines () 2020-06-19 14:04:19 -05:00
Jill R
8ad46870a4
Update note about AWS collection test requirements in docs () 2020-06-19 13:40:19 -04:00
Rick Elrod
cc071cdea6
Bump devel to 2.11.0 ()
Signed-off-by: Rick Elrod <rick@elrod.me>
2020-06-17 14:22:38 -05:00
Philipp Schmiedel
5f30f4e524
Use default network in Google Cloud Platform Guide ()
* Update guide_gce.rst
The given example is not working as a SSH connection is not possible because of . Instead, in this tutorial the default network should be used which allows SSH connections in most cases.

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-06-16 13:15:11 -05:00
Sandra McCann
c9c8cd34b2
added documentation for R() ()
* Updated docs/docsite/rst/dev_guide/developing_modules_documenting.rst, added documentation for R()
* added link to how to add anchors, anchor, and clarification on when to use each option

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-06-16 11:50:50 -05:00
Alicia Cozine
923655642b
mentions minimum required boto versions ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-16 12:32:44 -04: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
Felix Fontein
9c753341e2
Porting guide: transfer entries to collection changelogs ()
* Remove community.crypto parts from porting guide.
* Remove community.general parts from porting guide.
* Removed 'modules removed' section, since this is better suited for a general entry on the collection split.
2020-06-16 10:04:32 -05:00
Sandra McCann
2609482975
How to contribute to Ansible maintained collections ()
contributor info with HTML table
2020-06-15 15:38:42 -05:00
James Cammarata
9c92c96918
Updating 2.10 roadmap with adjusted beta release date ()
Co-authored-by: James Cammarata <jimi@cube.sngx.net>
2020-06-15 19:10:51 +01:00
John R Barker
37785255f2
validate ansible-base's and collections runtime.yml ()
* Validate ansible-base & collection's runtime.yml

Add new test `runtime-metadata`

* Schema validation of file
* Error if a a legacy meta/routing.yml exist in a collection
* removal_date OR removal_version

* Add tombstone validation.

* Allow both ISO 8601 date strings and datetime.date objects (from YAML dates).

* Address review comments.

* Add metadata to test collection.

* Add requirements file.

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-06-12 15:34:34 +01:00
Sandra McCann
524257a7b0
Document the ability to deprecate by date ()
* Document the ability to deprecate by date
* deprecated_in and deprecated_by_date are mutually exclusive
2020-06-11 15:28:24 -05:00
Felix Fontein
a114da80ee
Use antsibull-changelog instead of packaged changelog generator ()
Replace the ansible-base changelog linting and generation tool with antsibull-changelog and make it available for linting collections. Previously changelog linting was limited to ansible-base.
2020-06-11 11:21:21 -07: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
Alicia Cozine
d7c03e9fdb
Update testing collections to mention ansible-base versions ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-10 16:22:01 -04:00
Felix Fontein
a862ff2d43
Deprecation revisited ()
* Allow to specify collection_name separately for deprecation.

* Use new functionality in Ansible.

* Use new functionality in tests.

* Update tagging/untagging functions.

* Update pylint deprecated sanity test.

* Update validate-modules. Missing are basic checks for version_added (validate semantic version format for collections).

* Improve version validation. Re-add version_added validation.

* Make sure collection names are added to return docs before schema validation.

* Extra checks to avoid crashes on bad data.

* Make C# module utils code work, and update/extend tests.

* Add changelog fragment.

* Stop extracting collection name from potentially tagged versions/dates.

* Simplify C# code.

* Update Windows modules docs.

* Forgot semicolons.
2020-06-09 15:21:19 -07:00
Nilashish Chakraborty
5a7f2f9d5d
Add platform guide for FRR ()
* Add platform guide for FRR

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Add entry in index

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2020-06-09 10:22:30 +05:30
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
usatosi
ff98ecc4d0
Update developing_modules_best_practices.rst ()
##### SUMMARY
wrong module path for module_utils.basic in developing_modules_best_practices.rst
2020-06-08 13:28:17 +05:30
Brian Coca
062e780a68
starting metadata sunset ()
* starting metadata sunset

 - purged metadata from any requirements
 - fix indent in generic handler for yaml content (whey metadata display was off)
 - make more resilient against bad formed docs
 - removed all metadata from docs template
 - remove metadata from schemas
 - removed mdata tests and from unrelated tests

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Rick Elrod <rick@elrod.me>
2020-06-04 21:01:46 -04:00
Sam Doran
d7f61cbc28
Update 2.10 roadmap dates () 2020-06-01 13:36:14 -05:00
Rick Elrod
2abaf320d7
[ansiballz] ensure that '' is not in sys.path ()
Change:
On OpenBSD when using pipelining, we do not set cwd which results in a
permissions fatal. Ensure that `''` - cwd - is not in `sys.path`.

Test Plan:
Tested against local OpenBSD VM

Tickets:
Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-06-01 03:43:20 -05:00
Marco Lussetti
1dd8247fba
Add SLES to user_guide/playbook_conditionals.yml () 2020-05-29 13:39:49 -04:00
Adriano C
bfc510a0f8
Update other_tools_and_programs.rst () 2020-05-29 13:38:06 -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
Dmitry
925199511e
Add JetBrains platform tools () 2020-05-29 12:09:26 -05:00
Sandra McCann
c884c5fddf
add pointer to namespace and collection name restrictions () 2020-05-29 11:58:15 -05:00
Sandra McCann
3a4e227efa
remove build errors including guess ()
* remove build errors including guess

* fixed shippable errors
2020-05-29 11:56:49 -05:00
Sandra McCann
f110bcd59e
Turn on linkchecker in sphinx for documentation ()
* add make linkcheckerdocs as option to verify external links

* add back anchor checks

* spacing nit

* fix shippable issue

* Update docs/docsite/rst/conf.py

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
2020-05-29 11:48:53 -05:00
Jordan Borean
f81f5da20e
Ansible.Basic added generic fragment merger for module options () 2020-05-29 16:11:38 +10:00
Felix Fontein
40f21dfd3c
Version source tagging (automatic and manual) for version_added and deprecation versions ()
* Track collection for version_added.
Validate *all* version numbers in validate-modules.
For tagged version numbers (i.e. version_added), consider source collection to chose validation.

* Make tagging/untagging functions more flexible.

* Tag all versions in doc fragments.

* Tag all deprecation versions issued by code.

* Make Display.deprecated() understand tagged versions.

* Extend validation to enforce tagged version numbers.

* Tag versions in tests.

* Lint and fix test.

* Mention collection name in collection loader's deprecation/removal messages.

* Fix error IDs.

* Handle tagged dates in Display.deprecated().

* Also require that removed_at_date and deprecated_aliases.date are tagged.

* Also automatically tag/untag removed_at_date; fix sanity module removal version check.

* Improve error message when invalid version number is used (like '2.14' in collections).
2020-05-28 22:46:16 -07:00
Andrew Klychkov
1e01ac413b
Improve the changelog-how-to documentation. ()
* Improve the changelog-how-to documentation:
* remove repetitions
* mention starting with lowercase
* update the link to examples, remove an irrelevant link
* change win_ example to apt_repository
* add info about collections
2020-05-28 15:56:26 -05: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
Anatoly Pugachev
09f86c1410
docs: communications update ()
* add some more info on IRC support channels to docs
2020-05-28 15:12:24 -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
Felix Fontein
ea04e0048d
Allow to deprecate options and aliases by date ()
* Allow to deprecate options and aliases by date instead of only by version.

* Update display.deprecate().

* Adjust behavior to conform to tested behavior, extend tests, and improve C# style.

* Parse date and fail on invalid date.

This is mainly to make sure that people start using invalid dates, and we eventually have a mess to clean up.

* C# code: improve validation and update/extend tests.

* Make sure that deprecate() is not called with both date and version.

* Forgot to remove no longer necessary formatting.

* Adjust order of warnings in C# code.

* Adjust unrelated test.

* Fix grammar (and make that test pass).

* Don't parse date, and adjust message to be same as in .

* Sanity tests: disable date in past test.

* Validate-modules: validate ISO 8601 date format.

* Validate-modules: switch schema declaration for deprecated_aliases to improve error messages for invalid dates.

* Use DateTime instead of string for date deprecation.

* Validate that date in deprecated_aliases is actually a DateTime.

* Fix tests.

* Fix rebasing error.

* Adjust error codes for pylint, and add removed_at_date and deprecated_aliases.date checks to validate-modules.

* Make deprecation date in the past error codes optional.

* Make sure not both version and date are specified for AnsibleModule.deprecate() calls.

* Stop using Python 3.7+ API.

* Make sure errors are actually reported. Re-add 'ansible-' prefix.

* Avoid crashing when 'name' isn't there.

* Linting.

* Update lib/ansible/module_utils/csharp/Ansible.Basic.cs

Co-authored-by: Jordan Borean <jborean93@gmail.com>

* Adjust test to latest change.

* Prefer date over version if both end up in Display.deprecated().

Co-authored-by: Jordan Borean <jborean93@gmail.com>
2020-05-26 20:23:56 -04:00
Jordan Borean
ecea15c508
Unify ansible-galaxy install -r ()
* Unify ansible-galaxy install -r

* Minor nit fixes for docs

* Re-align warnings

* Fix up integration test

* Fix up test where no roles/collections were in file
2020-05-19 05:09:42 +10:00
Rick Elrod
3dedf95dbd
Remove RPM packaging infrastructure ()
Change:
- Nuke `make rpm` and friends from Makefile
- Nuke packaging/rpm

We are no longer going to be pushing RPMs to releases.ansible.com
post-2.10, so this is no longer necessary for us, and users should
prefer RPMs from their distro instead.

Test Plan:
Grepped the Makefile for all of: /rpm/i, /mock/i, /fedora/i

Tickets:
Refs 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-05-15 20:29:05 -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
Felix Fontein
0e15375ffe
Add deprecated removed_in_version and deprecated_aliases version tests () 2020-05-13 13:58:09 -07:00
Gonéri Le Bouder
e70f5cc132
vmware: example should use FQCN ()
For instance, you should use `community.vmware.vmware_guest` instead of just
`vmware_guest`.

This way, the examples don't depend on the `collections` directive of the
playbook.

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-05-11 16:27:20 -04:00
Serienmorder
366f808683
Correct debugging modules documentation () 2020-05-06 12:20:47 -05:00
Sloane Hertel
34458f3569
Update inventory caching documentation () 2020-05-05 15:10:57 -05: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
Jon Dufresne
eab4f9afc4
docs: Small grammar improvement in the community guide ()
The comma should not be included as it is not joining two independent
clauses.
2020-05-04 16:06:23 -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
Sandra McCann
7e0794085e
add links to new docsites () 2020-05-04 14:59:09 -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
Brian Coca
babac66f9c
Be strict about what is a boolean for keywords ()
* be strict about what is a boolean for keywords

 - found and fixed typo in test , 'yes' != 'yes.'
2020-04-28 13:55:26 -04:00
Alexandre Chouinard
91bb5af688
Update ansible-galaxy to handle role requirements ()
* Update galaxy role object to handle requirements

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2020-04-28 10:42:57 -04:00
John R Barker
53cf6c60cb
ROADMAP - s/ansible/ansible-base/g () 2020-04-28 10:44:20 +01:00
Abhijeet Kasurde
572fe9e480
Adjust Openstack Inventory script path () 2020-04-24 11:15:51 +05:30
Felix Fontein
abb807e5dd
Extend dev guide for collection testing and collection hacking ()
* Make clear which BOTMETA.yml is meant (some collections also have one), fix itemization, document /rebuild and /rebuild_failed, add section on how to test collections with ansible-test, update supported versions for compile tests, add a section on hacking collections, implement feedback. 

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

Co-Authored-By: Felix Fontein <felix@fontein.de>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-04-15 15:51:19 -05:00
Abhijeet Kasurde
6493a190f6
docs: Update inventory script paths ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-04-15 16:29:55 -04:00
Abhijeet Kasurde
c7997a77d2
VMware: Document vm properties ()
VMware vm inventory uses configuration properties, rather than
relying on external documents, point user to this document.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-04-15 16:26:58 -04:00
Jake Jackson
d60b17082e
small fix to install command as no longer needs -p by default () 2020-04-15 16:23:37 -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
Matt Martz
087be1da50
Allow tasks to notify a fqcn handler name ()
* Allow tasks to notify a fqcn handler name

* Add tests. Fixes 

* Add changelog fragment

* Add test to ensure handlers are deduped properly with fqcn, role, and just handler names

* Add some docs about new special vars
2020-04-08 11:36:38 -05:00
Andrew Klychkov
598ead965d
Dev guide: add notes about different image types for integration and unit/sanity tests ()
* Dev guide: add notes about different image types for integration and unit/sanity tests
* Update docs/docsite/rst/dev_guide/testing_integration.rst

Co-authored-by: Matt Clay <matt@mystile.com>
2020-04-07 09:17:44 -05:00
Ken Dreyer
318d5606c1
doc: explain default "required" value for argument_spec () 2020-04-06 16:07:30 -04:00
nzarin
16e07fe5b5
Fix grammar error in docfile () 2020-04-06 16:03:17 -04:00
Jeff Geerling
cfc9b4a1e2
Add Kubernetes Working Group to Communicating guide. () 2020-03-26 15:56:35 -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
Sandra McCann
f633772942
Update documenation contributions to reflect that some docs are in collections now () 2020-03-25 14:04:53 -05: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
Tomáš Pospíšek
ddef49bb7f
correctly escape parameters with dashes () 2020-03-25 14:49:05 -04:00
Sandra McCann
8042d226e4
fix make webdocs warnings () 2020-03-25 13:13:56 -05:00
Jordan Borean
7ec0d59c30
windows - add docs for UNC path in PSModulePath error () 2020-03-25 14:09:32 -04:00
Sandra McCann
02e36fbfc2
fix broken link in developing collections () 2020-03-25 13:07:03 -05: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
Fedor V
967e05bb23
DOC fix: typo in group addressing syntax () 2020-03-24 09:03:08 +01:00
dirkvbok
4083514d3e
Fix typo and styling FAQ docs () 2020-03-24 09:00:03 +01:00
Matt Davis
ed9de94ad9
remove azure extras and extras_require support ()
* remove azure extras and extras_require support

* Since Azure will be collectionized, the requirements will float more frequently than Ansible releases; the Azure collection needs to host the requirements now.
* Removed the dynamic extras support as well, since Azure was the only thing using it. If we need it again, it's easy to pull back from history.

* Mark azure-requirements as orhpaned.

This keeps the docs around so that existing links from old test runs remain valid.

Co-authored-by: Matt Clay <matt@mystile.com>
2020-03-23 13:07:33 -07:00
Matt Martz
6369591b11
Update 2.10 roadmap () 2020-03-23 13:33:44 -05:00
Matt Martz
2d93cebb72
Update pip install instructions ()
* Update pip install instructions

* Remove a few words

* We are not maintaining RPMs on releases.ansible.com any longer
2020-03-23 12:34:23 -05:00
Alicia Cozine
69543b47c9 fix last 7 docs errors on post-migration test runs ()
* address toc-tree-glob-pattern-no-match errors

* address Include-file-not-found error

* address 2.10 porting guide errors, add warning to page

* updates individual plugin type pages

* Add ignores.

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-03-23 11:14:21 -05:00
Alicia Cozine
4e8b240b8b
Intersphinx ()
* try to route 2.9 porting guide links to 2.9 module docs

* refreshed existing .inv files

* better URL

* new .inv file for version-specific links

* adds targets for version-specific docs

* fixes 2.5 porting guide refs

* fixes 2.8 porting guide refs

* fixes 2.7 porting guide refs

* fixes links on ACI guide

* adds .inv files for versions 2.5 through 2.8

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-03-06 14:16:35 -08:00
Sandra McCann
75b088d6a9
Remove extra Ansible in network automation section header () 2020-02-27 15:28:34 -06:00
Matt Clay
b68e55da26
Remove test/legacy/ directory. ()
* Remove `test/legacy/` directory.

* Remove references to `test/legacy/` directory.

* Update the remaining valid legacy reference.

* Remove outdated legacy references.
2020-02-26 11:48:30 -08:00
Abhijeet Kasurde
a4da73e961
misc typo fixes ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-02-26 10:58:39 -05:00
TAKAHASHI Shuuji
b950d18912
Add an example of specifying a specific commit hash. () 2020-02-25 10:40:12 -05:00
Sandra McCann
8fbec3cdeb
add download tarball option () 2020-02-24 16:30:34 -06:00
Sam Doran
6c70959131
Update example requirements file docs ()
Use "name" when possible rather than "src" to make the examples
of roles and collections in a single requirements files more
coherenant. Fundamentally, roles and collections are completely different.
But we can make the requiremets file easier to read by unifying the
format as much as possible.
2020-02-24 14:37:10 -05:00
Alicia Cozine
75191c1484
fixes link, makes intrapage TOC local () 2020-02-24 14:29:22 -05:00
Andrew Klychkov
ad8df69b58
docs/docsite/rst/: fix typos () 2020-02-21 10:57:07 +00:00
Andrew Klychkov
244277addd
dev_guide/developing_modules_best_practices.rst: fix typo () 2020-02-21 10:56:35 +00:00
Andrew Klychkov
05a3192eb7
user_guide/intro_adhoc.rst: fix typo () 2020-02-21 10:56:25 +00:00
Andrew Klychkov
907c98ebcd
/docs/docsite/rst/dev_guide: fix typos () 2020-02-21 10:56:12 +00:00
Matt Martz
c61c0f7ad5
Add warning when running devel ()
* Add warning when running devel. Addresses 

* Add config entry to disable devel warning, so it doesn't impact CI

* Update warning about using devel
2020-02-19 15:17:42 -06:00
Mark Chappell
052e8b7be4
ec2_tag - Deprecate the use of state=list ()
* ec2_tag - Deprecate the use of state=list

* Update lib/ansible/modules/cloud/amazon/ec2_tag.py

* Add changelog and porting_guide entries

Co-authored-by: flowerysong <junk+github@flowerysong.com>
2020-02-19 13:54:34 -05:00
Marco Bellaccini
a8d72a9923
Adding nanvault to Other Tools list ()
##### SUMMARY
Adding nanvault - a standalone tool to encrypt and decrypt files in the Ansible Vault format, featuring UNIX-style composability.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-02-19 18:31:09 +00:00
Akira Yokochi
887263c315
fix indents of EOS Platform Options () 2020-02-19 13:26:49 -05:00
Felix Fontein
4373863f25
Module validation: sanity check mutually_exclusive, required_if, required_xxx ... ()
* required_if checks should have three or four parts.

* Validate mutually_exclusive, required_together, required_one_of, required_if and required_by.

* Simplify code.

* Improve messages.

* Add changelog.

* Sanity check.

* Update docs.

* Update ignore.txt.

* Don't continue with tests when terms are not strings.

* Remove ignore.txt entry.

* Make sure validate-modules doesn't choke on things already flagged by schema test.

* Check required_if requirements list for strings.
2020-02-19 12:26:42 -05: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
Rohit
9eb7709c61
Vyos static route module added ()
* Vyos static route module added

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fixes

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* empty config traceback fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity check fix

* model specific changes and SI test cases updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* new state changes and SI test cases updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fixes

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* UT cases added

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* replaced operation fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* review comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* shippable fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* delete opr updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2020-02-18 07:32:26 -05:00
Abhijeet Kasurde
b6753b46a9
Replace 'message' in module parameters ()
* 'message' parameter is replaced by 'commit_message' in grafana_dashboard
* 'message' parameter is replaced by 'notification_message' in datadog_monitor

This change is required since 'message' as parameter name is used internally by
Ansible core engine.

Fixes:    

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-02-18 13:00:16 +01:00
Sandra McCann
a60feeb3c1
Specify lowercase only for Galaxy namespaces ()
* specify lowercase only for galaxy namespaces
* doh... include meta file
2020-02-17 15:26:47 -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
Sloane Hertel
6a8b1f867e
[aws_s3] fix deleting versioned objects before deleting bucket ()
* [aws_s3] fix deleting the current objects and the previous versions from a version-enabled bucket

* use existing paginated_list function to keep compatibility with the other places it is called

* changelog

* Add noteworthy change to the porting guide

* Reword that with acozine's suggestion

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-02-17 13:16:09 -05:00
Sandra McCann
39fef58bea
Add note that devel branch should not be used in real environments () 2020-02-17 10:53:16 -06:00
Adam Miller
98c1fc9d3a
add a testing section to collections dev guide ()
Signed-off-by: Adam Miller <admiller@redhat.com>
2020-02-14 16:57:24 -06:00
Francisco J. Capdevila
ed4fccb308
Fix typo () 2020-02-14 15:22:58 -05: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
Bas
f35293c052
Update YAMLSyntax.rst with yamllint ()
* Update YAMLSyntax.rst with yamllint

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-02-14 12:18:13 -05: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
Mark Chappell
90898132e4
CloudRetry/AWSRetry : Disable catching of NotFound exceptions ()
* CloudRetry/AWSRetry : Remove default catching of NotFound exceptions

* Add docs

* Changelog updates from review

* Update unit tests after removing 'NotFound' from default retries
2020-02-13 16:59:00 -05:00
Jordan Borean
ed863b377b
win_package: add missing porting guide entries () 2020-02-13 16:59:44 +10:00
tchernomax
53e043b5fe
combine filter: fine list handling (option b) () 2020-02-12 16:40:36 -05:00
Sandra McCann
a6bb3ae291
fix some broken links () 2020-02-12 10:47:00 -06:00
Bill Brubaker (wwbrubak)
561f8c1d60
Update macOS installation instructions ()
On macOS Catalina ``pip install --user ansible`` results in warnings and errors. This updates the reference documents to reflect changes Catalina+ with a safe, easy install for Ansible, accessing pip as a module and installing ansible with --user.

Co-authored-by: Sam Doran <sdoran@redhat.com>
2020-02-12 09:06:23 -06:00
Roger D. Winans
888a059ee7
Can we simplify _How to test a PR_? ()
Switch the instructions on testing PRs to use the `refs/pull/XXXX/head` refspec as described in [_Checking out pull requests locally_](https://help.github.com/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally#modifying-an-inactive-pull-request-locally).
2020-02-11 15:53:23 -06:00
Piotr Stawarski
a0247d13d8
New magic var: ansible_config_file ()
* Add `ansible_config_file` magic variable

* Add ansible_config_file to INTERNAL_VARS

* Add changelog fragment

* Update Special Variables docs
2020-02-11 15:49:55 -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
Sandra McCann
7ef7c1b5d7
add note on write access to socket_path ()
* Change socket_path error messages to not directly refer to socket_path
* Apply suggestions from code review

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
2020-02-11 09:49:20 -06:00
Mario Lenz
808bf02588
Remove options from some vmware modules that are not used in the code () 2020-02-11 12:30:22 +01:00
Nilashish Chakraborty
88f0c85228
Remove deprecated attributes from nxos_igmp_interface ()
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2020-02-11 12:27:07 +01:00
Wojciech Sciesinski
49e7f9afe2
Link the testing documentation to the module documenting page () 2020-02-10 15:30:04 -05:00
JP Mens
585e79942c
Slash missing from /etc/ () 2020-02-10 14:07:22 -05:00
Sandra McCann
4dd2513371
add info on creating doc fragments in a collection ()
* add info on creating doc fragments in a collection
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-02-10 10:23:28 -06:00
Felix Fontein
f725dce936
Clean up FILE_COMMON_ARGUMENTS ()
* Clean up FILE_COMMON_ARGUMENTS.

* postgresql_pg_hba doesn't declare the backup option.

* uri doesn't declare the remote_src option.

* Add documentation.

* maven_artifact seems to use directory_mode, which it doesn't declare.

* Update changelogs/fragments/66389-file-common-arguments.yml
Update docs/docsite/rst/porting_guides/porting_guide_2.10.rst

ci_complete

Co-Authored-By: Jill R <4121322+jillr@users.noreply.github.com>
2020-02-07 18:56:01 -05:00
Mitsuru Nakakawaji
c55ba658c6
add note for Azure Availbility Zone ()
* add note for Azure Availbility Zone

* Change title

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

* Update docs/docsite/rst/scenario_guides/guide_azure.rst

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

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-02-05 12:04:47 -05:00
Jordan Borean
12e3adb23a
win_domain_controller - add a deprecation warning for the log_path option () 2020-02-05 10:46:47 +10:00
Jordan Borean
78470c43c2
Removed deprecated items in Windows modules () 2020-02-05 09:02:04 +10:00
Felix Fontein
23b2bb4f4d
docker_container: change behavior for one-port container ranges to be same as docker CLI ()
* Adjust docker_container behavior for one-port container ranges to be similar to docker CLI.

* Add changelog.

* Add documented examples for ports:.
2020-02-03 23:27:40 +01:00
Ilias Trichopoulos
d6f2b4e788
Fix indentation () 2020-02-03 12:30:12 -05:00
Sander
87a5e433ef
update guide_azure.rst ()
changed example for ping linux machines. Looks liked it was wrongly copy paste.
2020-02-03 12:26:14 -05:00
Simon Dodsley
b1a8bded3f
Remove deprecated parameter for 2.10 in purefb_fs () 2020-02-02 15:30:01 +01:00
Mark Chappell
919a9e33e8
Minor AWS argument checks (required_if / mutually_exclusive) fixups ()
* aws_netapp_cvs_snapshots - minor required_if fixup (state must be set if state=present)

* ec2 - fix typo in mutually_exclusive definition

* rds_instance: fix typo in mutually_exclusive restore_to_time should be restore_time - currently throws a boto error
2020-01-31 22:17:46 +01:00
Mark Chappell
5d4d9d40af
ansible-test - Add 'get' to the list of bad choices for state ()
* ansible-test - Add 'get' to the list of bad choices for state

* Changelog fragment
2020-01-30 22:38:47 +01: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
Abhijeet Kasurde
2728c2476e
docs: Fixed "Edit on GitHub" link for plugin, cli ()
Fixed sphinx theme to navigate "Edit on Github" link to locate correct
plugin, cli source in GitHub repo.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-01-30 10:55:46 -05:00
Felix Fontein
5fdc9a61f0
docker_container: pass volumes only for anonymous volumes ()
* Simplify code.

* Only pass anonymous volumes.

* Add changelog and update porting guide.

* Add integration tests.
2020-01-30 14:08:25 +01:00
Dusan Matejka
57805b7def
zabbix_proxy interface option documentation and argspec fixes ()
* zabbix_proxy interface option documentation and argspec fixes

* Update changelogs/fragments/66837-zabbix-proxy-interface.yml

Co-Authored-By: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
2020-01-30 14:06:44 +01:00
Mark Chappell
1156962cde
Forbid state=(list|info) in modules via ansible-test sanity check
PR 

This change introduces a new sanity check with code
`parameter-state-invalid-choice` in the `ansible-test sanity`
validator. It enforces modules not to support `list` or `info`
as their `state`.

Co-Authored-By: Sviatoslav Sydorenko <webknjaz@redhat.com>
Co-Authored-By: Felix Fontein <felix@fontein.de>
2020-01-29 21:06:36 +01:00
Eitan Adler
86663abf37 all: fix all the the duplicate words () 2020-01-28 14:06:40 -05:00
Mark Chappell
35652ca788 Add tests to make sure that the documented 'elements' matches that defined in argument_spec ()
* Add tests to make sure that the documented 'elements' matches that defined in argument_spec

* Mass-add test/sanity/ignore.txt
2020-01-28 12:33:03 -05:00
Toshio Kuratomi
abc8b0ae73 This was changed to python 2.7 but should have remained python 2.6 ()
* Modules are still python-2.6+ unless there's a compelling reason not
  to be.
2020-01-28 09:32:03 -06:00
Mark Chappell
5ff899662d Add sanity test to require elements entry when argument type=list ()
* Require elements entry for lists

* Bulk add initial test/sanity/ignore.txt
2020-01-28 10:23:22 -05:00
Walter Sosa
2dc9841806 doc: Fix tiny typo in example: change --> changed ()
##### SUMMARY
Fixed another tiny typo: change --> changed

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-01-28 10:34:36 +01:00
Martin Krizek
4ca0c7f116 Fix case sensitivity for lookup() ()
This brings consistency to lookup(), with_ and ansible-doc.

Fixes 

* Add a porting guide entry
2020-01-27 15:09:45 -05:00
Sandra McCann
68ab8c23be Network prompts ()
* add network prompt examples and module examples

* Update docs/docsite/rst/network/user_guide/network_working_with_command_output.rst

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
2020-01-23 18:02:16 -06: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
Jill R
ac881b0026 Add section to aws devel guidelines about module_defaults () 2020-01-23 09:47:51 -05:00
Abhijeet Kasurde
fc6476bd72
VMware: Handle multiple tags with different category ()
vmware_tag_info used to return dict of tag information which caused
data loss when there are multiple tags with same name and different category ids.
This fix will add additional fact "tag_info" which will deprecated existing fact
"tag_facts".
The "tag_info" is a list which handles multiple tags with same name.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-01-23 10:15:57 +05:30
Toshio Kuratomi
0da13469d3 Add a script to update the intersphinx inventory ()
* Add a script to update the intersphinx inventory files

* We're about to add intersphinx inventories for separate ansible docs
  so we need an easy way to update them.  Also, we should be updating
  these cache files for other upstreams occassionally as well.  With a
  script, we can add updating them to a release process.
* Now that we don't know what the version of the cache is, change the
  filenames to not contain versions.

* Update the intersphinx cache files with the latest upstream versions

Results of running:

hacking/build-ansible.py update-intersphinx-cache -o docs/docsite -c docs/docsite/rst/conf.py

* Add a comment to the configuration file which says how to structure the intersphinx mapping and why.

* Update docs/docsite/rst/conf.py

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

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-01-22 17:20:02 -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
Sam Doran
20eb1dca99
Update Galaxy docs to use "token" rather than "API key" ()
We have called an API token many things. I changed the command line argument to
"--token", so now I'm unifying the documentation. I looked at both Galaxy and
Automation Hub and Galaxy is the only place that still uses the term "API Key",
which it could be argued should change.
2020-01-21 15:13:25 -05:00
Logan Mzz
986c9cf6a1 Docs: Fix collection adjacent folder tree ()
##### SUMMARY

Previously folder tree example for collection adjacent to the current playbook were displaying a subfolder below the playbook instead of being a sibling.
2020-01-21 10:20:37 -05:00
Marko Kohtala
c423b1f213 dev_guide: Correct path to ansible-test requirements files ()
The requirements path was old due to file relocation in
commit d651bda123.
2020-01-21 10:16:48 -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
Sandra McCann
599cc0bdfa restructure headings and copy-edit shell completion ()
* restructure headings and fix shell completion, apply suggestions from code review

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-01-16 10:30:26 -06:00
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
Sandra McCann
4fedc10035 added guidelines for seo; () 2020-01-13 15:46:44 -06:00
Xavier PV
9dd548ebb7 Update developing_python_3.rst ()
##### SUMMARY

fix link § redirection

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-01-13 15:40:37 -05: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
Bill Dodd
5f966ef664 Update deprecation version and porting guide for resource_id option ()
* update deprecation version and porting guide for resource_id option

* add changelog fragment
2020-01-10 16:37:53 -06:00
Sandra McCann
1a0724fdd4 Trim down to one Ansible search option ()
* move swiftype search to upper left of docsite, fix spacing and length issues for search icon and searchbox
2020-01-10 16:31:46 -06:00
Sandra McCann
9922014441 add details on network gather facts improvements ()
* add details on network gather facts improvements, implement feedback
2020-01-10 15:06:49 -06:00
Sandra McCann
2ad6055efd Document network resource modules ()
* add network resource module details to docs

(cherry picked from commit 3e35d2d63ce17fb694e645785ad855f01420f7d8)

* network resource module page, with example output
2020-01-10 14:12:26 -06:00
Sandra McCann
136b3be722 added unit test details for resource modules ()
* added unit test details for resource modules
2020-01-10 13:49:42 -06:00
Jordan Borean
595ab62ab8
Ansible.Basic - Added deprecated_aliases () 2020-01-10 09:13:13 +10:00
kaorihinata
3ca4580cb4 Allow no_log=False to silence the no_log warnings for module parameters ()
As AnsibleModule._log_invocation is currently implemented, any parameter
with a name that matches PASSWORD_MATCH triggers the no_log warning as a
precaution against parameters that may contain sensitive data, but have not
been marked as sensitive by the module author.

This patch would allow module authors to explicitly mark the aforementioned
parameters as not sensitive thereby bypassing an erroneous warning message,
while still catching parameters which have not been marked at all by the
author.

Adds tests for various no_log states including True, False, and None (as
extracted by AnsibleModule._log_invocation) when applied to an argument with
a name that matches PASSWORD_MATCH.

Fixes:  
2020-01-09 16:47:57 -05:00
Sandra McCann
0ca79a4234 Clarify how to use the Galaxy token ()
* DOCS: clarify how to use the Galaxy token, with info for installs and api-key
2020-01-07 13:57:47 -06: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
Mark Chappell
458268f4cb AWS Guidelines: Make 'security_token' optional so that they can be run outside of CI () 2019-12-30 08:38:20 +00:00
Pilou
7ee3103a86 clc_aa_policy: deprecate unused 'wait' parameter () 2019-12-20 23:46:53 -05:00
Ganesh Nalawade
1cfab26fab
Fix netconf plugin related to collections ()
* Fix netconf plugin related to collections

Fixes  (partly)

*  Make netconf plugins configurable so that the
   information of ncclient device handler
   for give platform resides in the platform
   specific netconf plugin.
*  If the device handler value in ncclient is
   different from the ansible_network_os value
   the right value of `ncclient_device_handler`
   should be set in the plugin documentation.

* Fix review comments

* Fix CI issue

* Fix review comment
2019-12-20 12:25:59 +05:30
Bill Dodd
973e36c6b6 Fix version param in deprecate() call and update porting guide ()
* fix version= param in deprecate() call and update porting guide

* add changelog fragment
2019-12-19 07:09:28 +01:00
Sandra McCann
80f5503ed0 Use requirements.txt to install prereqs for docs build ()
* Use requirements.txt to install prereqs for docs build

* implement feedback
2019-12-17 15:09:05 -06:00
Wojciech Sciesinski
aacc2d1a18 Update indentation used in the code examples, unify empty lines () 2019-12-16 11:26:25 -06:00
Alicia Cozine
40fb46f1e8
fixes import paths for ansible unit testing ()
* fixes import paths for ansible unit testing

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-12-16 11:07:26 -06:00
Evgeni Golov
057e137998 clarify returned value of RETURN nlock () 2019-12-12 17:12:38 -06:00
yiskylee
1f0b5b09cd Explanation for "check_mode: no" is confusing ()
When an ansible module, e.g., command, does not support check mode, you can use "check_mode: no" in that task to execute the task in normal mode, even when "--check" flag is used. The current document basically says, use "check_mode: no" to run in check mode, which is confusing and inaccurate.
2019-12-12 17:04:57 -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
anshulbehl
b349ec8fcf Adding network plugin changes for netconf and network_cli ()
* Adding network plugin changes for netconf and network_cli
2019-12-11 18:42:01 -06:00
Sandra McCann
5eceebcaf3 Clarify how to install roles and collections from same requirements file () 2019-12-11 10:21:41 -06:00
Chris Budzilowicz
5ebce4672b VMware: add note to vmware_guest faq ()
* add note to vmware_guest faq about the vmware API being read-only unless you're a paid subscriber
2019-12-10 15:45:32 -06:00
Wojciech Sciesinski
95aef88a45 Update indentation used in the code examples, unify empty lines () 2019-12-10 10:55:51 -05:00
lotaris-xx
c185c46501 Update guide_azure.rst ()
Adds subscription_id to the list of user/password credentials.
2019-12-10 08:58:01 -06: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
Mark Chappell
d8943d495e AWS NLB: Deprecate current default behaviour of 'absent' ()
* Deprecate elb_network_lb default of *delete*.

* Add changelog fragment

* Porting guide entry
2019-12-09 15:55:32 +01:00
Jordan Borean
fcdebe41e9
win_find - Refactor for better performance and alignment to find ()
* win_find - refactor to make more performance and use newer style

* win_find - refactor for performance improvements and alignment to find

* More path alignment to find

* Fix yamllint error
2019-12-06 10:01:11 +10:00
Felix Fontein
4be8b2134f Sanity checks: make sure that required in argument spec coincides with documentation ()
* Add sanity test for required parameters, update ignore.txt, and add changelog.
2019-12-03 09:15:07 -06:00
Sandra McCann
41472ee387 Describe different ways to set connection timeout options ()
* add timeout option examples, link to new section, implement feedback
2019-12-02 10:42:45 -06: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
Sandra McCann
7084dd727a clarify httpapi with an example () 2019-11-25 16:30:16 -06:00
Sandra McCann
b2fc12a29f clean up network toc () 2019-11-25 15:17:49 -06:00
Kenyon Ralph
a797802d27 playbooks_filters_ipaddr.rst: fix syntax, indentation () 2019-11-25 15:00:15 -05:00
Sandra McCann
af64e9ce6a add Automation Hub stub page ()
* add Automation Hub stub page

* implement feedback
2019-11-25 13:58:01 -06:00
Sam Doran
0471ed3731 Add docs clarifying behavior of retry files () 2019-11-25 14:26:46 -05:00
Sloane Hertel
c1f280ba6e
Inventory CLI - Ignore settings for when vars plugins should run ()
* Inventory CLI - Ignore settings for when vars plugins should run and just always run them

* Add note to porting guide

* Fix loading vars plugins

* changelog

* Remove a staging test for ansible-inventory since it ignores that setting
2019-11-25 13:16:03 -05:00
gaoruifeng
f9f7a0c60e fix syntax issue ()
- can disabled  
+ can be disabled
2019-11-25 15:01:10 +00:00
Trevor Pounds
8daa42bb3d Support non-KV and KV v1/v2 secret engines ()
* Support generic and KV v1/v2 secret engines.

Fixes 
Fixes 
Fixes 
Fixes 

* Update KV v2 compatibility notes/usage docs.

* Add tests for KV v1/v2 and generic secrets engines.

* Add changelog fragment.

* Add KV v2 behavior changes to porting guide.

* Fix pylint blacklisted name warnings.
2019-11-25 06:18:49 +01:00
Felix Fontein
f4d45ffdff
docker_container: change network_host default behavior for Ansible 2.14 ()
* Update network_mode docs.

* Announce default change for 2.14.

* Add changelog fragment.
2019-11-24 05:05:00 +01:00
Chris Budzilowicz
0ab21fd1ec add note re required forward slash on url () 2019-11-22 15:22:48 -06:00
Mark Chappell
6e652ae6df Improve consistency of IAM_{role,user,group} behaviour ()
* iam_user: use AnsibleAWSModule.client to fetch connection rather than C&P code

* iam_role: Add deprecation warning so we can switch purge_polices default behaviour from true to false

* iam_user/role/group: Rename 'managed_policy' and 'purge_policy'

Rename from singluar to plural (we accept a *list* of policies), and add aliases for the old values.

* Cleanup documentation

* Changelog
2019-11-21 14:38:44 -07:00
Felix Fontein
784e507671 module sanity checks: improve alias handling ()
* add_file_common_args is only of interest on top-level.
* Handle undocumented arguments in one place.
* Update ignore.txt
* Add changelog
2019-11-21 15:33:27 -05:00
Egor Zaitsev
f3575c5025 docs: add solution to timeout errors to docs () 2019-11-21 15:05:07 -05:00
Alicia Cozine
b0c8e7926f link from quickstart page to Network Getting Started () 2019-11-21 11:42:57 -05:00
Mark Chappell
f1311d3e98 Rewrite iam_policy using boto3 ()
* reworked iam_policy

* Deprecate policy_document option

* deprecate defaulting skip_duplicates to true

* No longer explicitly catch ParamValidationError.

ParamValidationErrror is already caught by ClientError

* Work with complex policy objects rather than json documents

comparisons can better cope with the special cases (eg True vs "True" )

* Enable check_mode tests and fix related 'changed' bug

* changelog

* doc cleanup based on review
2019-11-20 16:59:02 -07: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
Felix Fontein
b6f0f14dd3 Document diff. () 2019-11-19 09:46:59 -05:00
Xu Yuandong
09aebf33e4 Add doc to ce for user guide. () 2019-11-19 09:45:07 -05:00
Sloane Hertel
a4b36b2e6a Update cache plugin documentation ()
* Update cache plugin documentation since all cache plugins shipped with Ansible can be used for caching inventory since 2.8

* Update docs/docsite/rst/plugins/cache.rst

Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>

Co-Authored-By: John R Barker <john@johnrbarker.com>
2019-11-18 16:00:26 -06:00
Sandra McCann
2749090bc6 fix collection broken links () 2019-11-18 13:50:23 -06:00
Baptiste Mille-Mathias
1d0a832692 Fix link to Roles () 2019-11-18 12:05:18 -05:00
Baptiste Mille-Mathias
f198036d7f Remove duplicated and broken link to Roles () 2019-11-18 12:04:38 -05:00
Alicia Cozine
1df62f129a Collections versions () 2019-11-18 09:31:29 -05:00
Maciej Delmanowski
45527716fd Add module ldap_attrs; deprecate ldap_attr ()
* Add ldap_attrs module

* Fix codesyle error

* Apply deprecation rules

* Add support for X-ORDERED extension in ldap_attrs

The 'X-ORDERED' LDAP extension allows definition of ordered LDAP object
attributes. This extension is used in OpenLDAP "cn=config" database to
support ordered configuration options.

Specification: https://tools.ietf.org/html/draft-chu-ldap-xordered-00

* Update ldap_attr deprecation notice

* Documentation improvements based on suggestions

* Remove redundant dots from documentation

* Correct 'insertations' to 'insertions'

* Remove insecure 'params' option

* Fix sanity ignore errors

* Improve module documentation

* Change example value from string to list

* Fix support for "" values
2019-11-16 15:53:35 +01:00
Mario Lenz
034df49c56 VMware: New module vmware_host_dns ()
* Restore module vmware_dns_config
* Remove domainname and change_hostname_to
* Changed version_added from 2.10 to '2.10'
* Add setup_attach_host: true to test case
* Add 'vcsim is not defined' block to integration tests
* Change 'result' to 'dns_config_result'
* Bugfix: Changing some static configurations while keeping others can crash the module
* Implement changing DNS config from DHCP to static on a cluster
* Update documentation for vmware_host_dns
* vmware_host_dns integration tests: Always revert to original DNS configuration, even if a test fails
* Deprecate vmware_dns_config
2019-11-16 11:25:06 +05:30
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