Commit Graph

840 Commits (3a4b69096f68cf73ed8fc45cbd4b8be429871170)

Author SHA1 Message Date
Sam Doran b55cc61ef0 Clarify docs to explain that max_fail_percentage uses batch size (#33720) 7 years ago
Matt Martz 2d2f288e77
Add docs describing some additional behaviors around modules (#33631)
* Add docs describing some additional behaviors around modules, to outline why generic modules will not be accepted

* Add/copy the generic module guidelines to developing_modules

* Edits for clarity

* Edits for clarity
7 years ago
John R Barker c2bef76c46
Various doc formatting fixes (#33626)
* Avoid italics from `with_`
* C() is for Modules, not for RST
* RST uses ``...`` for code
7 years ago
Matt Martz 349099a4c6
Fix sorting in man template on python3. Fixes #33663 (#33673) 7 years ago
John R Barker f4cc3fb56d
Remove fixme coment 7 years ago
John R Barker e4a465b6e8
Docs: Network become for privilege mode (#33367)
* Network become for privilege mode

* Document what privilege mode is
* How to tell if you need it
* How to enable
* Tidy up formatting on page
* authorize & auth_pass
* network group_vars.
7 years ago
Renato Piccoli 794c5a6e53 A small typo (RFX->RFC) in vault.rst (#33553)
Correction for a typo in vault.rst.
7 years ago
Matt Clay 90ac38bd4c Fix module validator handling of empty options. 7 years ago
David Chkhikvadze 84ace7acc3 Add missing `be` (#33507) 7 years ago
Ganesh Nalawade 11c9ad23d5
Refactor common network shared and platform utils code into package (#33452)
* Refactor common network shared and platform specific code into package (part-1)

As per proposal #76 refactor common network shared and platform specific
code into sub-package.
https://github.com/ansible/proposals/issues/76

*  ansible.module_utils.network.common - command shared functions
*  ansible.module_utils.network.{{ platform }} - where platform is platform specific shared functions

*  Fix review comments

* Fix review comments
7 years ago
Nathaniel Case 7f90c9d1a7
Warn on `provider` with network_cli (#33355)
* Warn on `provider` with network_cli

also unify action plugins

* Add to porting guide about connection warnings
7 years ago
Zbigniew Jędrzejewski-Szmek 4c29396217 Add dnf and yum commands in "Installation" section (#33369)
* Add dnf and yum commands in "Installation" section

Even though the command is very simple, it's good to be able to c&p it.
There were already commands for apt, emerge, pip, even direct installation
from git, so adding Fedora/RHEL/CentOS examples is reasonable.

Since yum is not installed by default on any supported Fedora releases
(F26 and F28 currently), recommend dnf.

* Tiny edit
7 years ago
Toshio Kuratomi 7bd0af15d2
Enhance empty __init__ code-smell to check module_utils (#33438)
Empty __init__ will allow us to use python namespaces with all of these
files.  That may be something we want to take advantage of for allowign
them to be expanded by user dirs.  Also might be needed for AnsiballZ or
other wrapper enhancements in the future.
7 years ago
Jordan Borean a12e1bfced
stat: added information about get_md5 deprecation to porting guide (#33334)
* stat: added information about get_md5 deprecation to porting guide

* Edit
7 years ago
Eike Frost 16081d2751 Add keycloak_client module for administration of Keycloak clients (#31716)
Allows administration of Keycloak (http://www.keycloak.org/) clients via the Keycloak REST API
7 years ago
Toshio Kuratomi 6e36354740 Update version numbers for the release 7 years ago
Michihito Shigemura 63231457a1 Update links in become.rst (#33383) 7 years ago
Matt Martz 84b8f674a7
Fix py3 docs build (#33345)
* Open file in binary mode to support py3 writes using bytes

* Update sort filter to use an attribute, so that py3 can sort dictionaries
7 years ago
Brian Coca 08f1d1972e correctly document random doc range (#33308)
* correctly document random doc range

fixes #33226

* Edited for clarity.
7 years ago
Matt Martz 4fe08441be Deprecate tests used as filters (#32361)
* Warn on tests used as filters

* Update docs, add aliases for tests that fit more gramatically with test syntax

* Fix rst formatting

* Add successful filter, alias of success

* Remove renamed_deprecation, it was overkill

* Make directory alias for is_dir

* Update tests to use proper jinja test syntax

* Update additional documentation, living outside of YAML files, to reflect proper jinja test syntax

* Add conversion script, porting guide updates, and changelog updates

* Update newly added uses of tests as filters

* No underscore variable

* Convert recent tests as filter changes to win_stat

* Fix some changes related to rebasing a few integration tests

* Make tests_as_filters_warning explicitly accept the name of the test, instead of inferring the name

* Add test for tests_as_filters_warning

* Update tests as filters in newly added/modified tests

* Address recent changes to several integration tests

* Address recent changes in cs_vpc
7 years ago
Samer Deeb cbf28c20cb Add Support for Mellanox switches: first module: mlnxos_command (#33121)
* Add Support for Mellanox switches: first module: mlnxos_command

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Add cliconf support for mlnxos

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* 1- Fix short description, 2- remove waitfor

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* remove usage of check_args

Signed-off-by: Samer Deeb <samerd@mellanox.com>
7 years ago
gaellick bb38e34fc5 add prequisites for ubuntu dev env (#30713) 7 years ago
Pilou 16bcb0393e dev_guide: format code in testing_units_modules.rst (#33009)
* dev_guide: highlight Python code snippets

* dev_guide: use monospace for inline source code

* dev_guide: use links for classes and methods

Methods and classes prefixed with :method: and :class: will become
links once we have documentation for the relevant classes and methods.

Thanks to Toshio for pointing that.
7 years ago
Wolfgang Felbermeier 817a5efff9 Fix css of elbow indentation for firefox (#33225) 7 years ago
Brian Coca 18a4cd3985
draft implicit localhost docs (#31840)
* draft implicit localhost docs

* updated per feedback

* corrected docs to follow desired behaviour

* Edits
7 years ago
Sebastian Safari a05bbb8a1b Update location of facts.py on module dev documentation (#32209)
* Update location of facts.py

I spent some time trying to find out where it was, since it's a 404 on a google search.

* Edits
7 years ago
Brian Coca be00d93eb4 update with implicit localhost (#33146)
* update with implicit localhost

* Minor edit
7 years ago
Sorin Sbarnea 33ce1e1886 Documented use of ANSIBLE_STRATEGY variable (#32973)
Change-Id: I4a14520c14a9d93f06b235eb79720fc674e20cb5
7 years ago
Richlv f8a51355c7 Update playbooks_blocks.rst (#31088)
fix "block:" being referenced as "blocks:"
7 years ago
Siddharth Singh 6674b8e155 Changed Indentation (#31031)
The children 'northeast', 'northwest', 'southwest' weren't properly indented in yaml code.
7 years ago
Wolfgang Felbermeier 496ce388ab documentation: render nested return dicts for more then one level (#33143)
* Render nested return value documentation for more then one level
in the generated webdocs.

* Remove unnecessary code and cleanup

* Implement recursive option documentation

* Build elbow intendation style for options and return documentation
7 years ago
Strahinja Kustudic 673ec2cb78 Add changes to succeeded/failed tests to the 2.4 porting guide (#33201)
* Add changes to succeeded/failed tests to the 2.4 porting guide

* Edit for grammar and clarity
7 years ago
Simon Wydooghe c0fced0d89 Add 'datacenter' keyword arg to secrets.py (#24598)
Fix adds documentation about 'datacenter' in environment variable which is required for gce.py dynamic inventory.
7 years ago
scottb 6ac9d05de6
Removing obsolete version behavior callout notes - initial pass. (#33172)
* Removing obsolete version behavior callout notes - initial pass.

* Fixed example text punctuation.

* Removed old version callout.

* Typo fix

* Updated example

* Fixed awkward sentence

* Fixed incorrect feature name

* Reinstated current version callout
7 years ago
Ganesh Nalawade 0ddf092ae3
Add new filter to parse xml output for network use cases (#31562)
* Add new filter to parse xml output for network use cases

Fixes #31026
*  Add parse_xml filter
*  Add documentation for parse_xml filter

* Edited for clarity.

* Fix review comment and add unit tests

* Fix unit test CI failure

* Fix CI issues

* Fix unit test failures

* Fix review comments

* More copy edits.
7 years ago
André Althaus a9b15ce881 Scan group_vars/host_vars in sorted order 7 years ago
Tom Mast 2995439fbf Fixed simple typo on galaxy page (#33033) 7 years ago
John R Barker 6e4aa49a31 No hardcoding roadmaps (#32981) 7 years ago
Brian Coca afc460c943 tollerate 'string' descriptions 7 years ago
Julien Palard 73d6975611 FIX: Missing space in intro_inventory.rst 7 years ago
Major Hayden 6957339fce [Docs] Fix old YAML style in async docs (#31421)
* [Docs] Fix old YAML style in async docs

This patch fixes some old-style YAML in the documentation for
asynchronous playbooks.

* Removed hard-to-localize colloquialisms
7 years ago
Jiri Tyr f4f5c4d92a Documenting second parameter of the default filter (#31184)
* Documenting second parameter of the default filter

* Edited for clarity and grammar.

* Adding missing colon
7 years ago
Matt Martz 99d4f5bab4 Remove uses of assert in production code (#32079)
* Remove uses of assert in production code

* Fix assertion

* Add code smell test for assertions, currently limited to lib/ansible

* Fix assertion

* Add docs for no-assert

* Remove new assert from enos

* Fix assert in module_utils.connection
7 years ago
Brian Coca a0c0076cfb added note about serial behaviour (#32461)
* added note about serial behaviour
7 years ago
Toshio Kuratomi faa74a8ccd
Add the template lookup escaping to the 2.4 porting guide (#32760)
* Add the template lookup escaping to the 2.4 porting guide
7 years ago
Toshio Kuratomi e07cbb033f Keywords docs (#32807)
* Fixup keyword dumping

* Clarify introductory text
* Turn links in the keyword description into seealso entries in the rst.

* Have plugin_formatter cleanup trailing whitespace

The indent filter in jinja2 < 2.10 indents blank lines by default which
leads to trailing whitespace.  Cleanup after that filter.

* Edits

* Copy edit
7 years ago
Will Thames 316e7939d6 [cloud] Improve aws testing and use `{{ region }}` var (#26892)
* Protect AWS credentials from accidental commits

* Improve documentation for IAM policies

* Update ELB tests to be multi region

Allow AZs to reflect the region in which the tests are run.

This will not work for regions with fewer than three AZs,
but those are relatively rare
7 years ago
Brian Coca 76202bc7c3 removed since 1.2 7 years ago
cnasten f1fe467c22 nso_config module for setting configuration in Cisco NSO (#30973) 7 years ago
Jordan Borean 2f93b7bcb5
win_become: add info about recent admin changes (#32583)
* win_become: add info about recent admin changes

* edits from review
7 years ago
Jordan Borean 15c10981a0
win_dsc: update documentation for latest DSC changes (#32581)
* win_dsc: update documentation for latest DSC changes

* review changes
7 years ago
Trishna Guha 4cc7a89244
Add trishna to committer list (#32663)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
7 years ago
Ganesh Nalawade ff20ac6c52
Add ganeshrn to committer list (#32662) 7 years ago
Kedar K 9b896ca712
add kedarX to commiters list (#32659) 7 years ago
Martin Krizek cd80f26035
Add mkrizek as a commiter (#32644) 7 years ago
Sam Doran d60a1f39d6
Update committers (#32646) 7 years ago
Matt Clay ddae61aab0 Update people section of committer guidelines. 7 years ago
Brian Coca 4fe2c8fece added missing sam 7 years ago
Sloane Hertel 8478b5b6f8
add shertel as a commiter (#32639) 7 years ago
Matt Davis 8a24116dcb
remove experimental warning from become/runas (#32604)
* updated docs/changelog accordingly
7 years ago
Dylan Silva 4bcab82cdb
2.5 roadmap documentation (#32333)
* 2.5 roadmap

* Update ROADMAP_2_5.rst

Minor edits for caps.

* Formatting

* Network Documentation wording & formatting

* Remove smart quotes

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst
7 years ago
James Beake 162ca628d4 fix typo/ URI error (#32531)
URI uses singular: "Listener"

Using current command Listener(s) - plural generates the following error:
PS C:\windows\system32>   winrm enumerate winrm/config/Listeners
WSManFault
    Message
        ProviderFault
            WSManFault
                Message = The WS-Management service cannot process the request. The resource URI does not support the Enumerate operation.

Error number:  -2144108495 0x80338031
The WS-Management service cannot process the request because the WS-Addressing Action URI in the request is not compatible with the resource.
7 years ago
Michihito Shigemura c34c1b6ebd Fix typo/link in plugins/cache 7 years ago
Dmitry Marakasov 843fba509f Documentation typo fixes (#32473) 7 years ago
Jordan Borean d43985aa46
windows development: info about module_utils and requires (#32060)
* windows development: info about module_utils and requires

* Edits.

* update for CI fix

* removed link to Python module utils
7 years ago
Brian Coca 52c97a1cf4 added doc notes about vars plugins in precedence 7 years ago
Victor Martinez 4faf4ff215 Fixed typo (#32450) 7 years ago
Brian Coca 41685fb516 fix precedence issue with facts and vars (#32302)
avoid making gathered facts high precedence, only set_fact is supposed to be.
vars set via set_fact with cacheable are higher precedence than plain facts.

Previously (after 6fbd0a8bb5) regular facts would end up with a
higher precedence than host or play vars, but they should not be. Facts were getting added to 'non_persistent_facts' (equivalent to 'register' vars) which is higher precedence than facts should be.

added 'cacheable set_facts' to precedence docs

'ansible_facts_cacheable' ->  '_ansible_facts_cacheable' (made 'private')
7 years ago
Toshio Kuratomi 42655f737a
Clarify the release and maintenance cycle (#32402)
* Clarify the release and maintenance cycle
* Namespace refs a little
* Fix an unrelated problem with plugin return docs to fix docs build
7 years ago
irsl b456e637e0 become-user example was incorrect
Example was incorrect:
--become-user doesn't imply --become (http://docs.ansible.com/ansible/latest/become.html)
7 years ago
Ed Santiago 47fb002c88 (minor) fix broken link, awkward phrasing (#32085)
* (minor) fix broken link, awkward phrasing

Simple transposition error was resulting in a link not
being properly htmlified.

Also clean up redundant 'this' and trailing whitespace.

Signed-off-by: Ed Santiago <santiago@redhat.com>

* Edits
7 years ago
Greg DeKoenigsberg 80031720d1 Deprecate old community guide (#32266)
For anywhere we still have links, we want to deprecate this page and point them to the right new page.
7 years ago
Greg DeKoenigsberg c5b4d53c09 Update index.rst to point to new community guide (#32263)
We made this change a couple of months ago, deprecating community.html in favor of community/index.html and its full guide, but the change was never made here in the index.
7 years ago
Aaron Huslage 01af68911f Change 'connection' to 'inventory' in description
Fixing a copy/paste typo.
7 years ago
Toshio Kuratomi cf2c22770a Update release and maint for new release 7 years ago
John R Barker 1d86205933 Correct formatting --arguments (#31808)
* Correct formatting

* Use RST :option:

* ansible-pull --vault-password-file

* Streamlined the language a bit in the intro.

* Exclamation point removal!
7 years ago
Matt Clay 36b13e3e3d Fix ansible-test default image. (#31966)
* Add openssh-client to default docker container.
* Include Azure requirements in default container.

To do so, handling of pip requirements was updated to install each
set of requirements separately and then run a verification pass to
make sure there are no conflicts between requirements.

* Add missing --docker-no-pull option.
* Add documentation for the azure-requirements test.
7 years ago
mikedlr fbbffbabde Mdd module unit test docs (#31373)
* new documentation for unit testing - especially module unit testing

* unit test documentation reformatting and further fixes

* unit test documentation - point to online coverage reports & fix bad spaces

* Small copy edits.

* First pass copy edit / rewrite. More info needed.

* testing documentation - clean up structure, especially code coverage - reduce repetition

* module unit test documentation - improved introduction

* testing documentation - more fixes from and inspired by review from dharmabumstead

* testing documentation - fixes from mattclay + some other minor tweaks

* More copy edits.

* testing documentation - further fixes from review

* Copy edits

* Copy edits

* More copy edits.
7 years ago
Dan Bohea be3f911ce3 Typo on "Prompts" page (#31882) 7 years ago
Dag Wieers 3182a878b5 Fix small typo 7 years ago
Jordan Borean 836677522d fixed up code-block for powershell block 7 years ago
Abhijit Menon-Sen a84545dc33 Fix typo 7 years ago
Gregory M. Dulin 29a5938fb1 Update --extra-vars documentation. Fixes #11647 (#31433)
* Update --extra-vars documentation to address #11647

* Fix some grammar

* Fix indentation

* Reshuffle and add versionadded tags

* Remove code-block tags

* Add lf after versionadded lines
7 years ago
wxdao 8a86746223 Fix typo in playbooks_error_handling (#31636) 7 years ago
Jordan Borean f2fed10ad8 update Windows docs (#30783)
* first round of splitting and expanding Windows docs

* Added info about WinRM and started the usage page

* more details onf usage around command/shell

* added more info

* missed a page

* added info about hotfix and ps upgrade script

* Added DSC information

* filled in FAQ and fixed up links

* changes per PR review and typo fixes found by myself

* fixed sanity check

* updated external script URLS

* Edits

* Edits

* Edits

* Copy edits.

* More copy edits.

* Added info about becoming a local service account

* some formatting changes on become and DSC indent fix

* Copy edits/rewrites

* Copy edits/rewrites

* minor updates to UAC text, typos

* minor wording updates

* minor wording tweaks/typos

* minor wording tweaks/typos

* minor tweaks/typos

* fix indent issue

* fix title underline length

* fix quote issue
7 years ago
Peter Weldon 94a558887a Fix typo in command output of encrypt_string example. (#31601) 7 years ago
Tim Rupp 20e546258d Adds new committer to Ansible core (#31544)
This is me (Tim) signing and agreeing to the committer guidelines.
7 years ago
Brian Candler 6f9e2b9a63 Add ellipsis to indicate YAML example is excerpt, not standalone 7 years ago
Brian Coca 2ed46e04f4 more updates to plugin/config generation (#30787)
* fixed module generation

added missing lookup page
point to plugins when plugins
made modules singular
add display for verbose an debug messages
nicer templating, changed generation order for ref
corrected links
moved most of lookup docs to plugin section

* Copy edits
* Fixed typos
* Clarified wording
7 years ago
Brian Coca d84df2405d move from with_<lookup>: to loop:
- old functionality is still available direct lookup use, the following are equivalent

  with_nested: [[1,2,3], ['a','b','c']]

  loop: "{{lookup('nested', [1,2,3], ['a','b','c'])}}"

- avoid squashing with 'loop:'
- fixed test to use new intenal attributes
- removed most of 'lookup docs' as these now reside in the plugins
7 years ago
Toshio Kuratomi c81314dcb9 Add a hack to test whether type=path should be used in a module 7 years ago
Brian Coca dc69af50dc clarified inventory_dir changes for 2.4 (#31484)
* clarified inventory_dir changes for 2.4

added example on how to restore (mostly) old behaviour for add_hosts

fixes #30901
7 years ago
Brian Coca 7d49b27218 added toggle to control vars plugin behviour
this should allow user to control how they want the playbook dirs inspected
for additional vars, default now reverts to 2.3 behaviour (top).
corrected paths order
minor doc reword
7 years ago
Richlv 1037c211d9 Update playbooks_lookups.rst
fix doublequote being used in place of the colon
7 years ago
Lindsay Hill 146f90e16b Fixed RST hyperlink issues (#31394) 7 years ago
sduthil 15dffe04dd fix misformatted docsite link (#31384)
reason: The link is showing verbatim in the docs, where it should only
show "knowledge base article".

Also, generating the docs shows a lot of:

docs/docsite/rst/win_acl_module.rst:424: WARNING: Unknown target name: "know ledge base article<https://access.redhat.com/articles/rhel-top-support-policies>".
7 years ago
John R Barker b79d15e67f Improve and link Network Proxy docs (#31316)
* Improve and link Network Proxy docs

It is possible for proxy issues to cause "unable to open shell", so
detail there.

Having the "how-to" in the debug page makes more sense than on the
porting page, so move it.

Fixed a few formatting issues at the same time.

* Edits

* typo
7 years ago
Brian Coca 5085c3b859 made note about cwd not working for hostlist anymore (#31258)
* made note about cwd not working for hostlist anymore

fixes #31041

* Edits
7 years ago
Jorgen c41f781e1d Make YUM repo URL clickable again (#31264)
Make YUM repo URL clickable again
7 years ago
Andreas Olsson ba0b91b51b Remove git:// urls from docsite and from packaging (#30459)
It's almost always preferable to clone by way of https:// rather than
using the bare git:// protocol. Not only does https:// provide
stronger guarantees it also plays nicer with corporate proxies, etc.
7 years ago