1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

1461 commits

Author SHA1 Message Date
Alicia Cozine
9dad5d6b7f creates structure for network docs (#35514) 2018-01-31 10:01:55 -08:00
Abhijeet Kasurde
9d3ba7e36a VMware: Add basic vmware module related guide (#35128)
* VMware: Add basic vmware module related guide

This fix adds page tries to consolidate various information related
to vmware modules and debugging related information.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Copy edits

* Added module reference

* Edits

* Fixing invalid characters
2018-01-31 09:57:05 -08:00
John R Barker
06734f27c6
Network Doc status (#35475)
Plus remove trailing whitespace
2018-01-31 09:04:06 +00:00
Kylie Liang
e497509e51 Update guide_azure.rst to include note about running ansible from within azure (#35441)
* Update guide_azure.rst

Add one more option to run Ansible in Azure

* Minor edit
2018-01-30 17:31:10 -08:00
Matt Martz
3729cc57d0
Add porting guide note about include inheritance change (#35199)
* Add porting guide note about include inheritance change. Fixes #35096

* Also make note of using import_* when possible

* Edited for clarity.
2018-01-30 09:09:41 -06:00
John R Barker
a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
Jordan Borean
4da19f2d6b Added code-smell check to verify filenames are allowed with Windows (#35436) 2018-01-29 13:46:02 -08:00
Alessandro Pilotti
1baa9b4d90 Use TEMP variable instead of hardcoded path (#35380)
The script fails if a Temp directory is not present in the system drive (e.g. C:\Temp).
This can be solved by using the TEMP environment variable instead.
2018-01-29 11:47:06 +10:00
Anton Ovchinnikov
afc4d3c203 Small documentation fix in vault.rst (#35384) 2018-01-26 13:06:40 -08:00
Dag Wieers
1719267779 Sort arguments and return values in module docs
Comparing the old module docs, with the devel docs the
options/arguments/parameters are no longer sorted.

Also, both in the old module docs and the devel docs the result values
are not sorted where they probably should.
2018-01-25 18:34:27 -08:00
Dag Wieers
73f3b36fb1
Fix modules index delimiter and improve readability (#35187)
* Fix modules index delimiter and improve readability

* Hopefully fixes the links correctly :-/

* Anoteher attempt at this madness
2018-01-25 23:28:57 +01:00
John R Barker
3fadc5d614 Formatting and broken links (#35226) 2018-01-25 13:06:03 -08:00
Matt Clay
7abdab6c9e Convert ansible-test compile into a sanity test. 2018-01-25 09:45:36 -08:00
Matt Clay
e0010f15e4 Add pslint sanity test. (#35303)
* Add pslint sanity test.

* Fix `no-smart-quotes` sanity test.

* Add docs for `pslint` sanity test.
2018-01-24 17:22:14 -08:00
John R Barker
181085821b
Clarify when and how to enable ANSIBLE_DEBUG (#35220) 2018-01-23 17:10:17 +00:00
Trishna Guha
ba9b5ca048
doc update (#35214)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-01-23 09:51:11 +05:30
Abhijeet Kasurde
c0df05c028
github_release: Fix state returned from module (#33735)
This fix corrects the module state returned by github_module.
Now,
* When the release already exists, state is "ok"
* When the release is created, state is "changed"

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-01-23 08:37:41 +05:30
Kedar Kekan
5c2f3e3b8c
Update ROADMAP_2_5.rst 2018-01-23 07:09:20 +05:30
Toshio Kuratomi
f94fe61b6b Documentation and changelog for the plugin_filtering config option 2018-01-22 17:13:41 -08:00
Aidan Feldman
de60328d94 add documentation around commonly-used Facts for Conditionals (#34263)
* add documentation around commonly-used Facts for Conditionals

There are a few Facts that are often used for Conditionals, so
documenting them on the Conditionals page with their possible values.

* Edit
2018-01-22 13:37:19 -08:00
Jordan Borean
d0e6889f93 win_become: another option to support become flags for runas (#34551)
* win_become: another option to support become flags for runas

* removed uneeded entries

* fixed up whitespace issue

* Copy edit
2018-01-19 13:58:10 -08:00
Matt Martz
3c400c5899
ANSIBLE_METADATA doesn't support YAML currently, change 315 to invalid data type (#35009) 2018-01-17 14:15:22 -06:00
Matt Martz
a352d43824
Compare arg+aliases between docs and argument_spec (#34809)
* compare arg+aliases between docs and argument_spec

* Add some special handling for the network modules provider options that also appear in the top level arg spec

* Fix error code for bigip_hostname

* Address merge conflicts due to changes in f5 modules

* Update validate-modules ignore based off a clean execution

* Address merge conflicts

* Address renamed module

* Address recent changes to modules

* Add ignore for ucs_ip_pool

* Update aci modules to get more reliable documentation comparison, but not mutating the module_utils aci_argument_spec

* Update ignore.txt after recent aci updates

* Add extra guard to ensure we handle provider special only for network modules

* Address additional changes to modules
2018-01-17 10:11:30 -06:00
Nigel Rahkola
2a6156a9d8 Fix syntax error in intro_inventory yaml example (#34960) 2018-01-16 15:41:17 -06:00
Matt Davis
9cf217a151
allow cert validation to be disabled for Azure modules (#34906)
* `validate` or `ignore` values may be set by module, credential profile, or env. Module has highest precedence, followed by credential profile, then environment, and defaults to `validate` if not otherwise specified.
* fixes #33455
2018-01-16 10:14:08 -08:00
Alexander Lex
59042d79f5 Update developing_api.rst to use correct inventory format for single explicit host (#34919)
Fix for #34918
2018-01-16 09:57:11 -06:00
Brian Coca
bbd6b8bb42 Temporary (#31677)
* allow shells to have per host options, remote_tmp

added language to shell
removed module lang setting from general as  plugins have it now
use get to avoid bad powershell plugin
more resilient tmp discovery, fall back to `pwd`
add shell to docs
fixed options for when frags are only options
added shell set ops in t_e and fixed option frags
normalize tmp dir usag4e

- pass tmpdir/tmp/temp options as env var to commands, making it default for tempfile
- adjusted ansiballz tmpdir
- default local tempfile usage to the configured local tmp
- set env temp in action

add options to powershell
shift temporary to internal envvar/params
ensure tempdir is set if we pass var
ensure basic and url use expected tempdir
ensure localhost uses local tmp
give /var/tmp priority, less perms issues
more consistent tempfile mgmt for ansiballz
made async_dir configurable
better action handling, allow for finally rm tmp
fixed tmp issue and no more tempdir in ballz
hostvarize world readable and admin users
always set shell tempdir
added comment to discourage use of exception/flow control

* Mostly revert expand_user as it's not quite working.

This was an additional feature anyhow.

Kept the use of pwd as a fallback but moved it to a second ssh
connection.  This is not optimal but getting that to work in a single
ssh connection was part of the problem holding this up.

(cherry picked from commit 395b714120522f15e4c90a346f5e8e8d79213aca)

* fixed script and other action plugins

ensure tmpdir deletion
allow for connections that don't support new options (legacy, 3rd party)
fixed tests
2018-01-15 21:15:04 -08:00
Matt Martz
ae49dd65d9 Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance (#34769)
* Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance
2018-01-15 10:00:59 -08:00
jctanner
b10d5f34ea Extend validate-modules to check the next to last line (#34819)
* Add validation for the next to last line of a module

* Fix last error code

* Reduce to a single conditional

* Fix conditionals

* Move the final warnings statement to main() in mysql_replication
2018-01-15 15:49:35 +00:00
Matt Martz
86e4619dcf
Update echo ansible-vault example with -n as without this, you get a newline. Fixes #34795 (#34823) 2018-01-12 16:16:37 -06:00
Matt Martz
dcc05093db Validate modules arg spec fixes (#34477)
* Update validate-modules arg_spec introspection to be faster, by only mocking the imports we explicitly list
* The use of types.MethodType in redhat_subscription wasn't py3 compatible, use partial instead
* Remove argument_spec import hacks, make them errors, we can ignore them with ansible-test
* Enable the --arg-spec flag for validate-modules
2018-01-11 15:41:53 -08:00
Samer Deeb
f8884f12bc Mellanox OS name change: MLNXOS changed to ONYX (#34753)
* Mellanox OS name change: MLNXOS changed to ONYX

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

* Fix alphabetical order of modules metadata

Signed-off-by: Samer Deeb <samerd@mellanox.com>
2018-01-11 22:21:17 +00:00
Ricardo Carrillo Cruz
e9d62e18c7 Mark cliconf refactor on 2.5 roadmap as done (#34735) 2018-01-11 12:44:47 +00:00
Pilou
b66863abf0 dev_guide: don't ask to use '© Ansible Project' (#34704)
contributor don't sign any copyright assignment, then this makes no
sense.
2018-01-11 14:23:36 +10:00
Nathaniel Case
caf1b357aa
Update ROADMAP_2_5.rst
Mark connection-related tasks as done
2018-01-10 10:00:32 -05:00
Matt Martz
d1846425db
Provide a way to explicitly invoke the debugger (#34006)
* Provide a way to explicitly invoke the debugger with in the debug strategy

* Merge the debugger strategy into StrategyBase

* Fix some logic, pin to a single result

* Make redo also continue

* Make sure that if the debug closure doesn't need to process the result, that we still return it

* Fix failing tests for the strategy

* Clean up messages from debugger and exit code to match bin/ansible

* Move the FieldAttribute higher, to apply at different levels

* make debugger a string, expand logic

* Better host state rollbacks

* More explicit debugger prompt

* ENABLE_TASK_DEBUGGER should be boolean, and better docs

* No bare except, add pprint, alias h, vars to task_vars

* _validate_debugger can ignore non-string, that can be caught later

* Address issue if there were no previous tasks/state, and use the correct key

* Update docs for changes to the debugger

* Guard against a stat going negative through use of decrement

* Add a few notes about using the debugger on the free strategy

* Add changelog entry for task debugger

* Add a few versionadded indicators and a note about vars -> task_vars
2018-01-09 13:50:07 -06:00
osLEccse
9c7d987395 Update developing_api.rst (#34629)
Module path needs to be array instead of a string variable in order to work.
2018-01-09 11:23:01 +00:00
Lars Kellogg-Stedman
29fbf0c756 remove erroneous '.' in docsite footer (#34592)
This removes an erroneous '.' in the docsite that someone pointed out
on irc.
2018-01-08 22:36:47 -08:00
Cedric Pimenta
cd1b144c0a Improve documentation about Comment filter (#34539)
Include a mention to the decoration option, which allows someone to
specify the character comment to be used.
2018-01-08 15:07:32 -08:00
Adam Miller
a67e922a40 fix ansible-galaxy requirements.yml import_tasks->include in docs (#34519)
Signed-off-by: Adam Miller <admiller@redhat.com>
2018-01-08 16:18:40 -06:00
John R Barker
42dd48a6d0
Update done Network 2018-01-08 15:21:43 +00:00
John R Barker
1e292c0211
Correct broken link to playbooks_tests 2018-01-08 12:28:48 +00:00
Yuji Konishi
2039366380 typo (#34549) 2018-01-07 20:31:06 +01:00
John R Barker
1826c27e68
All 2.5 release dates to be pushed out by one week (#34456) 2018-01-05 13:19:48 +00:00
Trishna Guha
9d2182bcf8 Deprecate nxos_switchport and Add nxos_l2_interface DI module (#33813)
* Deprecate nxos_switchport

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_l2_interface DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* pep8 fixes

* aggregate test for nxos_l2_interface

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* revert nxos_switchport test change

* gundalow's comment

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-01-05 07:44:02 +00:00
Jordan Borean
a830cae160
windows become - info about blank passwords (#34331)
* windows become - info about blank passwords

* Edited for clarity
2018-01-05 06:00:08 +10:00
Abhijeet Kasurde
f58d9da703 Update link in common footer (#34397)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-01-03 20:52:14 -08:00
Tomáš Karásek
ec7b412193 Fix Packet guide to comply with latest version of the packet module (#31410)
* Fix Packet guide to comply with latest version of the packet module

* Fix backticks in rst

* rephrase wait_for_public_IPv description

* Edited for clarity.
2018-01-03 19:05:04 -08:00
Jordan Borean
278663ad2c
windows: updated docs to include info regarding https validation (#34128)
* updated docs to include info regarding https validation

* some doc edits
2018-01-04 08:47:37 +10:00
Jordan Borean
57ed6a866f windows: Add IPv6 address support and docs to go with it (#34072)
* windows: Add IPv6 address support and docs to go with it

* minor docs fix

* fixed some doc sentances
2018-01-03 09:26:53 -08:00
John R Barker
43b0ba0679 Docs network best 2.5 (#33544)
* Best practices for Ansible 2.5 networking

* How to use network_cli
* How to pass credentials

* Proxy

* rename facts-demo.yml + tree

* code-block formatting

* Move platform specific notes to new page (PR pending)

* use ansible_network_os rather than group_names

* Scott's comments

* Update network_best_practices_2.5.rst
2018-01-03 05:44:55 -05:00
Pilou
6a6f5129a9 dev_guide: fix a slip (#34143)
replace 'Formatting options' with 'Formatting functions'
2017-12-26 10:18:09 +00:00
Matt Martz
57575d1cfa
Fix tests as filters #4 (#33930)
* Resolve newly added tests as filters

* Add code smell to test for ansible provided jinja tests as filters syntax

* Add docs for no-tests-as-filters code smell test

* Address tests as filters in new integration tests

* Address feedback

* Address feedback 2
2017-12-21 13:42:53 -06:00
Toshio Kuratomi
94d952f94b
Documentation on how to make a release. (#31426)
* Release Engineering Docs with pointer to the Docs on how to actually make the release.
2017-12-21 08:14:49 -08:00
scottb
f8f34c7bab
Moved generated module RSTs to their own directory. (#33966)
* Moved generated module RSTs to their own directory.

* WIP commit - fixed conflict with conf.py exclude_patterns by renaming module RST output directory to 'module_docs'.

* Added new directory to formatter module links; aded new module directory to makefile clean.

* Removed illegal comment from block.
2017-12-21 01:47:39 -08:00
John R Barker
c50da48049
Fix various RST warnings (#34084)
* Fix various RST warnings

* shorter lines
2017-12-20 15:20:05 +00:00
John R Barker
7381554e42 Compact documentation (#34081)
Before this fix lists of `documentation:` were in individual <p> tags
causing a lot of whitespace on the rendered _module.html pages.
2017-12-20 20:49:09 +10:00
Jordan Borean
0880297909 fix options output for bool type (#34074) 2017-12-20 09:48:17 +00:00
Trishna Guha
be89822bb5
Deprecate nxos_portchannel and add nxos_linkagg DI module (#33376)
* deprecate nxos_portchannel

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_linkagg DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* remove nxos_portchannel unit test

* fix syntax issues

* fix ansible-doc failure

* update nxos_portchannel unittest

* minor fixes and integration test

* update nxos_linkagg
2017-12-20 11:26:07 +05:30
Trishna Guha
3cce8dfafd
Deprecate nxos_ip_interface and Add nxos_l3_interface DI module (#33866)
* Deprecate nxos_ip_interface module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_l3_interface DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add integration test

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* pep8 fixes

* Add nxapi cli test

* Improve complexity

* manage layer3 interface

* fix unit test
2017-12-20 11:07:23 +05:30
aaron jheng
378636078a use print function (#34013) 2017-12-19 09:31:30 -06:00
Martin Krizek
35c6b17a14 playbook_loops.rst: fix formatting (#34026) 2017-12-19 11:26:05 +00:00
Jordan Borean
a2810f44a8 Fixed up windows command quoting example 2017-12-18 06:26:04 +10:00
Will Thames
5f29cd5e60 Add validation test for new copyright (#32919)
* Update validation test for new copyright

Ensure new modules without the new copyright header fail
validation
Ensure existing modules without copyright in top 20 lines fail

* Add documentation of 108 error

Create label in developing modules documentation so that
the validation page can point to it

* Ensure new style copyright header passes test!
2017-12-16 09:23:54 -08:00
Micah Abbott
2f2f118665 python_3_support.rst: fix broken links (#33951)
The links pointing to 'Building From Source' and 'Inventory' were not
valid, so I updated them to point to locations that seemed
appropriate.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
2017-12-15 20:04:53 +00:00
Brian Coca
2b7799f817
added flatten filter (#33102)
* added flatten filter
2017-12-15 14:40:02 -05:00
John R Barker
f127e5d535
Fix a few docs build issues (#33685)
Noticed when doing `make webdocs`
2017-12-14 17:33:27 +00:00
Sam Doran
bf29cc79a6 Further clarify what determines batch size in a play (#33833) 2017-12-13 10:38:30 -06:00
Jordan Borean
07e9df11b3
windows dev docs - vagrant info (#33515)
* windows dev docs - vagrant info

* added info about FileUtil and LinkUtil

* Initial edit pass - WIP

* updated some wording

* fix some more general sayings to be more professional
2017-12-12 08:16:22 +10:00
John R Barker
33c7a157ab
Create network_working_with_command_output.rst (#33709)
Move this content to new location prior to intro_networking.rst refactor
2017-12-11 13:22:58 +00:00
Pilou
326b208b19 osx_say: add espeak support, rename module to say (#33071)
* Rename osx_say module into say

* say: remove undocumented default value for voice parameter

* say: add support for espeak command

* say: handle check_mode

* say: handle GNUstep tool
2017-12-09 13:45:31 +00:00
Sam Doran
b55cc61ef0 Clarify docs to explain that max_fail_percentage uses batch size (#33720) 2017-12-08 12:09:38 -05:00
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
2017-12-07 15:31:26 -05:00
John R Barker
c2bef76c46
Various doc formatting fixes (#33626)
* Avoid italics from `with_`
* C() is for Modules, not for RST
* RST uses ``...`` for code
2017-12-07 14:25:46 +00:00
Matt Martz
349099a4c6
Fix sorting in man template on python3. Fixes #33663 (#33673) 2017-12-07 09:16:04 -05:00
John R Barker
f4cc3fb56d
Remove fixme coment 2017-12-07 10:34:10 +00:00
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.
2017-12-07 10:27:43 +00:00
Renato Piccoli
794c5a6e53 A small typo (RFX->RFC) in vault.rst (#33553)
Correction for a typo in vault.rst.
2017-12-06 08:42:59 +05:30
Matt Clay
90ac38bd4c Fix module validator handling of empty options. 2017-12-05 16:46:05 -08:00
David Chkhikvadze
84ace7acc3 Add missing be (#33507) 2017-12-04 13:21:54 +01:00
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
2017-12-03 21:42:30 +05:30
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
2017-12-01 12:22:54 -05:00
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
2017-12-01 02:19:08 -08:00
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.
2017-11-30 15:47:38 -08:00
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
2017-11-30 10:14:34 +10:00
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
2017-11-29 16:44:35 -05:00
Toshio Kuratomi
6e36354740 Update version numbers for the release 2017-11-29 12:12:44 -08:00
Michihito Shigemura
63231457a1 Update links in become.rst (#33383) 2017-11-29 19:48:33 +00:00
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
2017-11-28 12:05:19 -06:00
Brian Coca
08f1d1972e correctly document random doc range (#33308)
* correctly document random doc range

fixes #33226

* Edited for clarity.
2017-11-28 01:26:36 -08:00
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
2017-11-27 17:58:08 -05:00
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>
2017-11-27 20:55:08 +00:00
gaellick
bb38e34fc5 add prequisites for ubuntu dev env (#30713) 2017-11-27 14:58:13 -05:00
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.
2017-11-27 14:41:53 -05:00
Wolfgang Felbermeier
817a5efff9 Fix css of elbow indentation for firefox (#33225) 2017-11-27 13:13:17 +10:00
Brian Coca
18a4cd3985
draft implicit localhost docs (#31840)
* draft implicit localhost docs

* updated per feedback

* corrected docs to follow desired behaviour

* Edits
2017-11-22 19:13:56 -05:00
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
2017-11-22 15:26:27 -08:00
Brian Coca
be00d93eb4 update with implicit localhost (#33146)
* update with implicit localhost

* Minor edit
2017-11-22 14:48:40 -08:00
Sorin Sbarnea
33ce1e1886 Documented use of ANSIBLE_STRATEGY variable (#32973)
Change-Id: I4a14520c14a9d93f06b235eb79720fc674e20cb5
2017-11-22 14:47:21 -08:00
Richlv
f8a51355c7 Update playbooks_blocks.rst (#31088)
fix "block:" being referenced as "blocks:"
2017-11-22 14:40:41 -08:00
Siddharth Singh
6674b8e155 Changed Indentation (#31031)
The children 'northeast', 'northwest', 'southwest' weren't properly indented in yaml code.
2017-11-22 14:39:24 -08:00
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
2017-11-22 16:53:53 -05:00
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
2017-11-22 16:14:31 -05:00
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.
2017-11-22 15:17:29 +00:00
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
2017-11-21 20:14:27 -08:00
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.
2017-11-21 12:16:18 +05:30
André Althaus
a9b15ce881 Scan group_vars/host_vars in sorted order 2017-11-20 21:57:42 -05:00
Tom Mast
2995439fbf Fixed simple typo on galaxy page (#33033) 2017-11-18 10:22:58 +01:00
John R Barker
6e4aa49a31 No hardcoding roadmaps (#32981) 2017-11-16 08:03:10 -08:00
Brian Coca
afc460c943 tollerate 'string' descriptions 2017-11-14 11:18:48 -05:00
Julien Palard
73d6975611 FIX: Missing space in intro_inventory.rst 2017-11-14 10:54:02 -05:00
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
2017-11-13 18:32:37 -08:00
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
2017-11-13 15:51:22 -08:00
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
2017-11-13 11:51:18 -05:00
Brian Coca
a0c0076cfb added note about serial behaviour (#32461)
* added note about serial behaviour
2017-11-12 14:05:34 -08:00
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
2017-11-12 14:01:14 -08:00
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
2017-11-10 16:59:26 -08:00
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
2017-11-09 11:56:31 -05:00
Brian Coca
76202bc7c3 removed since 1.2 2017-11-09 09:59:43 -05:00
cnasten
f1fe467c22 nso_config module for setting configuration in Cisco NSO (#30973) 2017-11-09 13:34:41 +00:00
Jordan Borean
2f93b7bcb5
win_become: add info about recent admin changes (#32583)
* win_become: add info about recent admin changes

* edits from review
2017-11-09 10:02:33 +10:00
Jordan Borean
15c10981a0
win_dsc: update documentation for latest DSC changes (#32581)
* win_dsc: update documentation for latest DSC changes

* review changes
2017-11-09 10:02:17 +10:00
Trishna Guha
4cc7a89244
Add trishna to committer list (#32663)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2017-11-08 06:46:16 +00:00
Ganesh Nalawade
ff20ac6c52
Add ganeshrn to committer list (#32662) 2017-11-08 11:12:26 +05:30
Kedar K
9b896ca712
add kedarX to commiters list (#32659) 2017-11-08 08:03:37 +05:30
Martin Krizek
cd80f26035
Add mkrizek as a commiter (#32644) 2017-11-07 18:51:58 +01:00
Sam Doran
d60a1f39d6
Update committers (#32646) 2017-11-07 12:44:55 -05:00
Matt Clay
ddae61aab0 Update people section of committer guidelines. 2017-11-07 09:29:25 -08:00
Brian Coca
4fe2c8fece added missing sam 2017-11-07 12:20:43 -05:00
Sloane Hertel
8478b5b6f8
add shertel as a commiter (#32639) 2017-11-07 11:11:53 -05:00
Matt Davis
8a24116dcb
remove experimental warning from become/runas (#32604)
* updated docs/changelog accordingly
2017-11-06 15:37:45 -08:00
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
2017-11-06 08:40:32 -08:00
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.
2017-11-05 11:46:07 +00:00
Michihito Shigemura
c34c1b6ebd Fix typo/link in plugins/cache 2017-11-02 19:40:09 -04:00
Dmitry Marakasov
843fba509f Documentation typo fixes (#32473) 2017-11-02 11:15:53 +00:00
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
2017-11-02 07:15:25 +10:00
Brian Coca
52c97a1cf4 added doc notes about vars plugins in precedence 2017-11-01 11:40:49 -07:00
Victor Martinez
4faf4ff215 Fixed typo (#32450) 2017-11-01 16:46:19 +00:00
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')
2017-11-01 11:42:17 -04:00
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
2017-10-31 22:08:14 -07:00
irsl
b456e637e0 become-user example was incorrect
Example was incorrect:
--become-user doesn't imply --become (http://docs.ansible.com/ansible/latest/become.html)
2017-10-29 00:58:26 -04:00
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
2017-10-27 21:39:23 -07:00
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.
2017-10-27 17:49:08 +01:00
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.
2017-10-27 17:48:14 +01:00
Aaron Huslage
01af68911f Change 'connection' to 'inventory' in description
Fixing a copy/paste typo.
2017-10-25 16:25:19 -04:00
Toshio Kuratomi
cf2c22770a Update release and maint for new release 2017-10-25 12:52:22 -07:00
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!
2017-10-24 13:23:04 +01:00
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.
2017-10-20 08:48:01 -07:00
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.
2017-10-19 13:36:57 -07:00
Dan Bohea
be3f911ce3 Typo on "Prompts" page (#31882) 2017-10-19 10:50:27 +10:00
Dag Wieers
3182a878b5 Fix small typo 2017-10-18 16:47:58 +02:00
Jordan Borean
836677522d fixed up code-block for powershell block 2017-10-17 13:36:49 +10:00
Abhijit Menon-Sen
a84545dc33 Fix typo 2017-10-16 20:58:27 +05:30
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
2017-10-16 10:50:38 -04:00
wxdao
8a86746223 Fix typo in playbooks_error_handling (#31636) 2017-10-12 21:08:35 -07:00
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
2017-10-12 18:40:47 -07:00
Peter Weldon
94a558887a Fix typo in command output of encrypt_string example. (#31601) 2017-10-11 14:24:33 -07:00
Tim Rupp
20e546258d Adds new committer to Ansible core (#31544)
This is me (Tim) signing and agreeing to the committer guidelines.
2017-10-11 22:08:47 +01:00
Brian Candler
6f9e2b9a63 Add ellipsis to indicate YAML example is excerpt, not standalone 2017-10-11 17:04:12 -04:00
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
2017-10-11 00:15:25 -04:00
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
2017-10-10 15:43:49 -04:00
Toshio Kuratomi
c81314dcb9 Add a hack to test whether type=path should be used in a module 2017-10-09 21:15:56 -07:00
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
2017-10-09 20:56:32 -07:00
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
2017-10-09 12:31:15 -04:00
Richlv
1037c211d9 Update playbooks_lookups.rst
fix doublequote being used in place of the colon
2017-10-09 10:00:05 -04:00
Lindsay Hill
146f90e16b Fixed RST hyperlink issues (#31394) 2017-10-06 01:30:10 -07:00
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>".
2017-10-05 18:52:30 -07:00
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
2017-10-05 18:47:32 +01:00
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
2017-10-04 14:18:43 -04:00
Jorgen
c41f781e1d Make YUM repo URL clickable again (#31264)
Make YUM repo URL clickable again
2017-10-03 22:32:20 -07:00
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.
2017-10-03 12:16:25 -07:00
Michihito Shigemura
a71ca66e6e Fix typo in dev_guide/testing 2017-10-02 16:11:08 -04:00
Michihito Shigemura
78fd326908 Fix typo in dev_guide/developing_program_flow_modules 2017-10-02 16:10:45 -04:00
Dylan Silva
614a2b403e fixed url issue for rpm location (#31164)
Thanks @thaumos!
2017-10-02 02:20:03 -07:00
Michihito Shigemura
d0d1c7d249 Fix typo in dev_guide/developing_plugins (#31142) 2017-10-01 02:00:38 -07:00
Michihito Shigemura
221c01ff49 Fix typo in dev_guide/developing_modules_general (#31122) 2017-10-01 01:39:02 -07:00
Michihito Shigemura
b7b8c669a3 Fix typo in dev_guide/developing_modules_documenting (#31120) 2017-09-30 17:19:09 -07:00
Daniel Linder
90dd698b86 Example of idempotent (pseudo-)random() usage. (#31048)
Add note to use idempotent random() seed based on inventory_hostname.
2017-09-28 12:59:10 -07:00
Luke Short
c6a676c025 correct the Python 3 Pip environment setup instructions (#30988) 2017-09-28 13:21:38 +10:00
tom-clx
04bfbb14d6 Update playbooks_blocks.rst (#24069)
* Update playbooks_blocks.rst

The rescue section documentation should be clear that successful completion of a rescue section will override other error handling behavior.

* more precise rescue docs

explains in detail the consequences of successful rescue
2017-09-27 14:57:42 -07:00
Dag Wieers
e63d949951 Add a blank line, and use the Copyright format as used during rewrite
So there is a discrepancy between the dev guide and what has been changed on disk by toshio.
Not a big deal, but needlessly confusing.
2017-09-27 20:44:22 +02:00
Brian Coca
cd5cadfe69 added note about inventory_dir new behaviour (#30865)
* added note about inventory_dir new behaviour
2017-09-27 12:00:06 -04:00
Michihito Shigemura
b3cee37dc1 Update links in style_guide/trademarks (#30809) 2017-09-27 01:29:56 -07:00
Brian Coca
17f094bb6a corrected import_play into to import_playbook (#30853)
* corrected import_play into to import_playbook

fixes #30744
2017-09-26 17:27:21 -04:00
Matt Martz
d40eff720c Update API example for 2.4 2017-09-26 14:39:36 -04:00
scottb
6c732bb670 Plugin doc update edits for #30490 (#30889)
* Edit pass 1 for #30490 - command line tools and developing plugins.

* Continuing edit pass for #30490. WIP

* Last round of copy edits for #30490.
2017-09-25 15:37:33 -07:00
cclauss
25e17b4035 Clearify that Python 3 support is still a tech preview (#30789)
setup.py does not contain any Python 3 trove classifiers.
2017-09-25 12:36:58 -07:00
Michihito Shigemura
b3177383da Fix typo in docs spelling_word_choice (#30785)
shocked that someone else spells the correst way, like me
2017-09-25 11:09:18 -04:00
Brian Coca
8d56064ce4 fixed typo in if, restore module docs 2017-09-24 10:18:21 -04:00
Michihito Shigemura
303d622dcb Refactor doc resources in style_guide (#30794)
- Change links from http to https
- Correct or remove dead links
2017-09-23 09:13:17 +00:00
Brian Coca
b233f3f296 updated plugin docs (#30490)
* updated  docs

- for devs:
  - added inventory/vars section
  - made some updates to general section and other plugin types
- for users:
 - added 'user' plugin section to start describing the plugins
 - docs on types, what they are and how to use

- removed ref to deleted AUTHORS file
- corrected several typos/headers
- added descriptions to config.rst template
- ignore generated files for cli/plugins and config
- remove new generated files on `make clean`
- moved details from devguid and intro doc to plugin specific pages
- pretied up lookup notes
- changed precedence ref to not conflict config
- removed duplicate config data, as config is autogenerated and up to date
- put new plugins under playbooks
- added `pass` cause rst/python dislikes fractions
- removed dupe in .gitignore, alpha sorted to avoid moar dupes
- added try cause rst/python freaks out

* generate plugins into their own dir

only do plugins that support docs
use toctree from main plugins page
2017-09-22 23:19:50 -04:00
Matt Bruzek
aaaf88908d Adding a section to the FAQ about array notation. (#30782)
* Adding a section to the FAQ about array notation.

* Fixing spelling of jinja and Celsius.

* Adding an example that uses dots.
2017-09-22 19:02:51 -04:00
Michihito Shigemura
b5546328dc Fix typo in docs grammar_punctuation (#30718) 2017-09-22 10:18:26 +00:00
David Moreau Simard
f8230d961d Link to all the porting guides instead of just the 2.0 one (#30671) 2017-09-21 10:32:13 +00:00
jborean93
0e22afef52 fix for make webdocs 2017-09-20 22:45:24 -04:00
Dag Wieers
31e7d735a3 win_environment: Make this the Windows reference module
As discussed before we selected win_environment to the documentation,
and point to win_uri for a more advanced module.

If we want to make this the reference module, we have to get this one
absolutely right in every possible way.

This PR cleans up both win_environment and win_uri, and makes the
required changes to the windows module development section.
2017-09-21 03:20:17 +02:00
Brian Coca
5220f30244 decelerate docs! 2017-09-20 17:30:59 -04:00
Dylan Silva
2f67dd1e0f Updated release table for docs (#30649)
- Updated table to reflect release of 2.4
- Added in 2.5 as current devel
2017-09-20 13:58:21 -07:00
Brian Coca
a030472092 More porting updates (#30635)
* Update porting_guide_2.4.rst with more docs and some rst fixes
2017-09-20 15:12:01 -04:00
Monty Taylor
700a032bf1 Add an example of complex return argument (#28610) 2017-09-20 15:51:45 +01:00
Brian Coca
22c8522cbf added missing feature info (#30560)
* added missing feature info

mostly config related

* Copy edit

* Copy edit

* Copy edit. Clarified warning.
2017-09-19 17:43:15 -04:00
Austin S. Hemmelgarn
d5ae9d1018 Fix build on Python 3.x by using sys.maxsize. (#30424)
As outlined in https://docs.python.org/3.1/whatsnew/3.0.html#integers,
sys.maxint doesn't exist anymore in Python 3.x because there is no maximum
value for integers in Python 3.x.  sys.maxsize is present in all
versions of Python that are currently supported by Ansible, so use that
instead as an arbitrarily large index value.

Fixes the following build error when building with Python 3.x:
make -j1 docs
mkdir -p ./docs/man/man1/ ; \
PYTHONPATH=./lib docs/bin/generate_man.py --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/*.py
Traceback (most recent call last):
  File "docs/bin/generate_man.py", line 253, in <module>
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "docs/bin/generate_man.py", line 119, in opts_docs
    'long_desc': trim_docstring(cli.__doc__),
  File "docs/bin/generate_man.py", line 34, in trim_docstring
    indent = sys.maxint
AttributeError: module 'sys' has no attribute 'maxint'
make: *** [Makefile:347: generate_asciidoc] Error 1
2017-09-19 16:23:16 -04:00
Adrian Likins
da15cf1f54 Generate plugin rst (#28901)
Generate rst docs for plugins 

Based on rst generated for modules. But generated plugin
docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst
( docs/docsite/rst/plugins/connection/ssh.py for ex)

* move plugins docs to rst/*_plugins/ subdirs for namespace
* Only gen support pages for modules for now.
* Add generated plugin docs to gitignore* add list_*_plugins templates
* support MODULES/PLUGINS filters for make htmldocs

   Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for.

* fixup 'historical' version_added, skip plugins/loader.py
* Fix plugins_by_support ref link to new plugins/*/ location
* use :ref: for common_return_values, allow empty version_added
* warnings on missing doc info
* add a prefix to _random_choice
  It was colliding with the target for random_choice plugin
2017-09-19 11:14:27 -04:00
Toshio Kuratomi
c82cf791dd Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
Brian Coca
1062f52f4c cleanup generated CLI rst 2017-09-18 16:20:49 -04:00
John R Barker
5a256dd1c0 porting_guide_2.4 stub entries (#30456)
Addtions to porting_guide_2.4

* deprecated notice for win_package return values
* Added vars plugins, config api, inventory plugins.  These were mostly backwards compatible.
  Added notes for users and devs to check out new features once i write the 'feature docs' I'll
  come back and link to them from here
2017-09-17 16:57:10 -07:00
Adrian Sadłocha
22f3898412 Fix a typo in docs 2017-09-17 19:13:21 -04:00
James Cammarata
366a9d861f Cleaning up use of include: in docs (#30466)
* Cleaning up use of include: in docs

Switching to import_*/include_* instead.

* Update playbooks_best_practices.rst

* Fix rst syntax
2017-09-17 18:02:46 +00:00
John R Barker
785e604c57 Porting Guides 2.4 (#24539)
* Porting Guides for Ansible Versions

Improve the user facing documentation.
Tell people what changes they need to make

* More porting guides

* Link porting guides from TOC

* Link porting guides from CHANGELOG.md

* typo in link

* Review feedback

* Better CHANGELOG links

* Better links

* code blocks

* Minor changes

* Correct links, comment out network section in 2.4

* Typos

* Revert non 2.4 changes

* Add placeholders for other items

* multiple inventory

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* add win_command/win_shell escaping notes

* Added some windows porting info

* Edit for grammar

* Correct links, delete Net Platform Agnostic

* 2.5 link

* Network changes in 2.4

* facts_namespacing was pushed back to 2.5

Due to lack of time we pushed this back to 2.5 so that the facts in the namespace could be shortened.

* Python version

* Remove FIXMEs - move to seperate PR
2017-09-16 12:10:12 +01:00
Ganesh Nalawade
11310b8c4a Update removed_in_version to 2.9 for network module top level cred args (#30416)
* Update removed_in_version to 2.9 for network module top level credential args

* Add documentation
2017-09-15 21:20:07 +05:30
Toshio Kuratomi
8a2f069468 Document boolean default value treatment (#30062)
* Consistency and document treatment of default bool values

* Document that default bool values can be any Ansible recognized bool.
  choose the one that reads better in context
* For fragments used by the copy module, make bool types use type=bool and not choices

* Edit for clarity
2017-09-14 13:27:16 -07:00
Adrian Likins
dfc0084f01 rename dev..general_OLD.rst to ._rst (#30291)
So we don't try to build the rst, since it causes
lots of warnings to be shown and doesn't render correctly.
2017-09-14 11:23:36 -04:00
Adrian Likins
9cc63326b1 Misc docsite fixes (#30290)
* Fix refs for local_facts and various cli :option:
* Fix dev_guide/testing_pep8 refs
* remove ref to non-existing 'developing_test_pr'
* Fix ref to ansible-vault encrypt_string
* Removed hard-to-localize colloquialism.
* Rename '_ansible-pull' in playbooks_intro.

It was conflicting with rst/ansible-pull.rst. Nothing
seems to reference it.

* Add explicit targets for and update refs

Replace some ':doc:' use with ':ref:'.

Replace some :ref: to section names with explicit targets
(:doc:`Dynamic vs. Static` -> :ref:`dynamic_vs_static` etc)

* The 'YAML+Jinja' syntax lex fails here, so just use yaml

Since the yaml+jinja highlight fails, code wasnt highlighted
at all, but 'yaml' works more or less.

* just use no lexer for the < python2.6 examples

py3 will fail highlighting them, and 'python2' throws
a lexer warning, and nothing actually highlights it, so
just disable.
2017-09-14 11:17:56 -04:00
Aren
60d9a12efd swapped out key-value pairs for multi-line YML (#30277) 2017-09-14 13:06:33 +10:00
John Patrick
fc5b74fad2 fix broken rpm link (#29667) 2017-09-14 12:21:31 +10:00
John R Barker
ac6205b9e8 porting_guide_2.5.rst stub (#30311) 2017-09-13 23:20:51 +01:00
Adrian Likins
633263d535 add htmlsingle target (#30287)
For whatever reason, building the 'singlehtml' version of
the docs is much much faster than building the normal html
version.
2017-09-13 20:45:05 +00:00
Matt Clay
df941df01d Remove references to obsolete PR Mover. (#30298) 2017-09-13 20:43:19 +00:00
Ganesh Nalawade
530988666a Allow delegate_to if transport is not cli (#29945)
Fixes #29060

Allow delegate_to if transport is either nxapi or eapi.

Persistent connection uses `cli` transport and create
a local socket on control node. Hence delegate_to is not allowed
for `cli` transport.

However as `nxapi` and `eapi` transport does not use persistent connection
it is possible to use delegate_to in this case.
2017-09-12 21:34:13 +05:30
Dylan Silva
88aa0b7645 Fix bugs with modules_support.rst 2017-09-11 17:33:16 -07:00
Toshio Kuratomi
ff13d58c14 Remove use of unicode_literals as it is an anti-pattern
from __future__ unicode_literals leads to developer confusion as
developers no longer can tell whether a bare literal string is a byte
string or a unicode string.  Explicit marking as u"" or b"" is the way
to solve the same problem in the Ansbile codebase.
2017-09-11 13:33:51 -07:00
Abhijeet Kasurde
8f6626bd8f Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-09-09 10:25:50 -07:00
Cheng Lian
4c229e566e Fix minor formatting issue in python_3_support.rst (#29161)
Thanks @liancheng!
2017-09-09 06:02:18 +00:00
Luke Short
897f86561f document the required variables for using Windows certificates (#29112)
* document the required variables for using certificates when authenticating to Windows

* clarify that certificates are for local (non-domain) users
2017-09-08 12:52:25 +10:00
Will Thames
c749ecbd94 Add ansible-inventory-grapher to the list of tools (#29068)
* Add ansible-inventory-grapher to the list of tools

* Fixed minor typo.
2017-09-08 00:19:18 +00:00
jhawkesworth
3d5320adad fix typo in new jsonquery filter example that uses backticks (#29082) 2017-09-07 23:51:36 +00:00
Adrian Likins
52f2edf19d change generated playbooks_keywords.rst to use an rst 'glossary' (#28843)
* Use a rst glossary for playbooks_keywords docs
* Add a 'Task' and 'Tasks' to glossary.
* Update keywords desciptions,
* use :term: rst ref, some quoting
* Make it more obvious that 'retries' and 'until' need to be used in combination.
2017-09-07 15:46:53 -04:00
Adrian Likins
89c973445c generate rst doc pages for command line tools (#27530)
* let generate_man also gen rst pages for cli tools
* make template-file, output-dir, output format cli options for generate_man
* update main Makefile to use generate_man.py for docs (man pages and rst)
* update vault docs that use :option:
* Edits based on
6e34ea6242 and
a3afc78535

* add a optparse 'desc' to lib/ansible/cli/config.py 

  The man page needs a short desc for the 'NAME' field
  which it gets from the option parse 'desc' value.

  Fixes building ansible-config man page.

* add trim_docstring from pep257 to generate_man

  use pep258 docstring trim function to fix up any indention
  weirdness inherit to doc strings (ie, lines other than
  first line being indented.

* Add refs to cli command actions

To reference ansible-vaults --vault-id option, use:

:option:`The link text here <ansible-vault --vault-id>`

or:

:option:`--vault-id <ansible-vault --vault-id>`

To reference ansible-vault's 'encrypt' action, use:

:ref:`The link text here <ansible_vault_encrypt>`

or most of the time:

:ref:`ansible-vault encrypt <ansible_vault_encrypt>`
2017-09-07 15:44:20 -04:00
Brian Coca
f4fff54f68 clarify import_ docs (#28395)
* clarify import_ docs

* fixed izpellz

* Copy edits.
2017-09-06 23:50:50 -04:00
Will Thames
0d69b63c01 Additional simpler json_query documentation (#24041)
Since json_query treats backticks as delimiters for literals,
some of the examples in the json_query docs can be made a little
simpler. Rather than replacing such examples, demonstrate the
alternative
2017-09-06 20:48:12 -07:00
Brian Coca
c3550b58ed introducing ALSO YAML inventory (#28596)
* introducing ALSO YAML inventory

* Copy edits
2017-09-06 23:47:27 -04:00
Brian Coca
48da0597c0 document ansible_group_priority (#28777)
* document ansible_group_priority

* Copy edit pass
2017-09-06 23:36:01 -04:00
Matt Clay
fe90866819 Fix rst syntax issue in docs. 2017-09-06 19:39:07 -07:00
Dylan Silva
ecc1fbcc1d updated modules support page with new information (#29071)
* updated modules support page with new information

* Minor wording tweaks.
2017-09-06 16:48:26 -07:00
Sam Doran
02a362e7de Replace rst extension with html in message (#29022) 2017-09-05 16:59:25 -04:00
Eddie Peters
ea74176a28 Fix small typos and extra whitespace in the docs (#24559) 2017-09-05 13:43:11 -07:00
Sam Doran
f0a0b630f6 Properly format inline code. 2017-09-05 11:54:48 -04:00
Ian Wienand
35d02b28c9 Minor syntax error in block versionadded
The syntax for versionadded is to have the string as a second
argument.
2017-09-05 11:54:48 -04:00
Nicklas Laine Overgaard
859b5df1d4 Fix exported SSL_CERT_FILE variable (#28968)
The variable was pointing to a file with a `.cer` extension but the curl command downloads a `.pem` file which makes executions of the bash script fail
2017-09-05 10:29:11 -04:00
Pilou
d67d202227 Fix typo: s/certfied/certified/ (#28951) 2017-09-02 13:46:46 -07:00
Toshio Kuratomi
13b2bedae6 Make python3 testing doc clearer for distro packaging users (#28948)
https://bugzilla.redhat.com/show_bug.cgi?id=1486612
2017-09-01 20:49:01 -07:00
Fran Fitzpatrick
c51f2f835e Adds documentation for all the regex filters (#28944) 2017-09-01 17:12:15 -07:00
Matt Davis
59787a3dbc minor fixes to docsite root URLs (#28945)
* fix hardcoded http schemes to use relative URLs
* add doc fragment to version selector link to scroll target directly to the selector
2017-09-01 16:48:53 -07:00
Scott Butler
a9f82f8a8a Fixed incorrect version numbers. 2017-09-01 15:42:02 -07:00
Scott Butler
c479d37777 Changed header to say 'devel' instead of 2.4 2017-09-01 15:37:07 -07:00
Lars Kellogg-Stedman
7093622571 docs: add fact caching directives to intro_configuration (#27040)
the fact_caching* configuration directives were not listed in
intro_configuration.rst.
2017-09-01 14:57:58 -07:00
Ron V
8999b98a09 Update playbooks_best_practices.rst (#26714)
fix point of confusion for newer users
2017-09-01 14:56:51 -07:00
Sam Doran
cc7e38890c Clarify how tag inheritance works (#28942)
Fixes #20119

Another crack at PR #27147
2017-09-01 14:55:51 -07:00
Adrian Likins
596dc8c442 Add ANSIBLE_CONFIG envvar to config/envvars tmpl (#28886) 2017-09-01 14:53:42 -07:00
Adrian Likins
933298505a Update places we mention env vars to use :envvar: (#28887) 2017-09-01 14:52:18 -07:00
Peter Sprygada
ae2e84146e update network section for completed items (#28927) 2017-09-01 10:26:33 -04:00
Adrian Likins
28b9dc4bed Vault docs (#26979)
* start rst docs for ansible-vault encrypt_string

* wip, vault format docs

(sorta markdown ish atm)

* wip - formatting

* wip, vault docs

* Fix refs to other docs for now

fixing default_role in conf.py will remove need
for this

* add 'ref' to cli names

* more vault docs

* wip, misc fixes

* add some encrypt_string examples

* Fix up rstcheck warnings

The code blocks in question included the output that would
be echo'ed from running the command, which isnt valid bash.

* fix formatting and rstcheck warnings about code-block

* Add envvar ref for ANSIBLE_VAULT_PASSWORD_FILE

* fix doc title

* Fixed title underline
2017-08-31 12:18:38 -07:00
scottb
b146e17733 Edit pass for relocated community documentation. (#28368)
* Edit pass for relocated community documentation.

* Updated info on Ansibullbot

Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags

* Update communication.rst

Add Contents
Use correct headings

* Update communication.rst

* Topics, remove whitespace, codeofconduct

* Formatting

* Correct heading

* Update maintainers.rst

* Minor edits and a request for more info

* Removed some hard-to-localize wording.

* Removed incomplete sentence

* Minor edits per review
2017-08-31 12:14:35 -07:00
Scott Butler
c7c30c6760 Fixed wording. 2017-08-31 11:20:28 -07:00
Giovanni Sciortino
d733f5af06 Add note in documentation and add warning related to retries parameter used without until (#28078) 2017-08-31 11:25:36 -04:00
Adrian Likins
8035e68d44 Generate a rst for config and env options from base.yml (#28739)
* wip, gen docs from config/base.yml

* wip

* dont change conf.py here

* cleanup, add dump_config --template-file cli opt

* some desc are string, some are lists...

TODO: fix base.yml so it is consistent

* Filter out TODO and empty descriptions
2017-08-31 10:11:05 -04:00
Sam Doran
80c00d3238 Create urlsplit filter (#28537)
* Improve tests for uri filter

* Create URL Split docs

* Add urlsplit filter

* Py3 compatibility

* Use helper method and eliminate query options

* Add options, cleanup output, fix tests

* Update docs

* Add parenthesis to boilerplate import

* Add debug task to tests

* Use exclude option to filter returned values

* Filter out additional option for Python 3
2017-08-29 17:58:44 -04:00
Matt Davis
b3f2d1befe expose cloud_environment override in azure_rm modules (#28743)
* Can be set via env, credential profile, or module arg
* Valid values defined by Azure Python SDK, currently `AzureCloud`,`AzureChinaCloud`,`AzureUSGovernment`,`AzureGermanCloud` or any Azure Stack metadata discovery URL.
2017-08-29 13:35:24 -04:00
Chris Houseknecht
d513c430de Updates community code of conduct email 2017-08-29 12:36:45 -04:00
Jason McKerr
9a2065fcf3 Update ROADMAP_2_4.rst 2017-08-29 12:15:55 -04:00
René Moser
c97f4653be fix typos in various modules and docsite (#28747) 2017-08-29 17:59:41 +02:00
Jordan Borean
9b48c377b4 updated windows roadmap (#28740) 2017-08-28 19:19:17 -04:00
Reid Wahl
ca91b361ce Fixes #28290: Added missing colon for paramiko host_key_auto_add line in network_debug_troubleshooting.rst (#28695) 2017-08-28 11:00:05 -07:00
Reid Wahl
3ca415f58c Fixes #21041: Add note to intro_inventory.rst that the Docker example is a playbook and not an inventory file (#28697) 2017-08-28 10:59:28 -07:00
Dag Wieers
ccb6b39f45 Corrected RETURNS -> RETURN 2017-08-28 10:09:21 +02:00
Brian Coca
203d8d2e6e added diff keyword to changelog/docs 2017-08-24 08:55:39 -04:00
René Moser
6397e68bfd doc: replace play_hosts with ansible_play_batch (#28526) 2017-08-23 07:49:32 +02:00
Matt Clay
871bd24358 Fix documentation references. 2017-08-22 17:09:28 -04:00
Shane McDonald
f108057f61 Bump version in docs layout (#28523) 2017-08-22 20:16:19 +01:00
Toshio Kuratomi
40ea448c7b Misc docs fixes
* Revise and link inline to the lists of modules

* Fix jinja2 objects.inv fallback path

* Fix bolding of deprecation marker

* Change module_support to link to lists via :doc:
  That links to the top of the page instead of a section.

* Add a short text for each list of maintained modules
* Change maintenance info to only display on core and network modules
2017-08-22 11:52:30 -07:00
Toshio Kuratomi
84ea2af4b6 Remove nonexistent special_interest-groups doc 2017-08-22 11:52:30 -07:00
Toshio Kuratomi
212499a489 On clean, remove the *_maintained.rst generated files 2017-08-22 11:52:30 -07:00
Jiri Tyr
5660b18b6a Adding missing period into the module doc template 2017-08-21 14:20:08 -04:00
David Kretch
beed59f303 Fix trailing space in ec2_vol example, fix 'the the' typos (#28440)
* Fix 'the the' typos, fix 'pahting' filename typo

* Change 'the the' typos to a single 'the'.
* Change `playbook_pahting.rst` to `playbook_pathing.rst`.

* Delete trailing space in ec2_vol example

Delete the trailing space in `instance: "{{ item.id }} "`, which makes the
example fail when run because it looks for instance "i-xxxx ".
2017-08-19 23:00:51 +02:00
David Moreau Simard
022ce7efee Docs for multiple asynchronous tasks (#24457)
* Add docs on the behavior of with_items flattening and nested lists

* Add docs on limiting the amount of concurrent async tasks
2017-08-18 13:02:35 -07:00
Andreas Maier
b900f4a3be Fixed return table in module docs generated by plugin_formatter.py (#25329) (#25330)
This change fixes two issues with the generated return table:

1. When specifying a list of strings in the 'description' field of a
   return value, it shows them in Python list syntax on the resulting
   web page, e.g. `['a', 'b', 'c']`.
2. When specifying more than one line for the 'sample' field, the
   result table gets damaged in the HTML output.

In addition, this change re-arranges the HTML tags produced in the
generated RST file such that they line up nicely and can better be
checked by humans for completeness.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
2017-08-18 15:38:55 -04:00
Adrian Likins
2941e86671 Fix plugin_formatter.py -l / MODULES=none make webdocs
Fix the get_module_info check against the limit_to_modules
list so building a subset/none of the module docs works again.
2017-08-18 10:58:16 -04:00
David Moreau-Simard
e9d6d37589 Update release status for 2.3 to 2.3.2 2017-08-17 13:25:56 -04:00
Peter Sprygada
2e44d8913b update parse_cli documentation with more examples (#28258)
* update parse_cli documentation with more examples
2017-08-16 21:41:42 -07:00
Tom Paine
50d744c217 Update playbooks_filters.rst (#28271)
See #17266, password_hash has been updated to support passlib. The available hashes are listed on http://docs.ansible.com/ansible/latest/playbooks_prompts.html, but not here.
2017-08-17 11:34:35 +10:00
Sam Doran
b7aa38c0d8 Minor fixes to Developer Docs (#28302)
* Grammar and formatting corrections

Indent JSON code example.
Double backticks for inline code examples.

* Remove trailing spaces

* CI fixes
2017-08-16 17:56:53 -07:00
Matt Clay
b52aeeabfa Roadmap updates and docs fix. (#28287)
* Update on 2.4 roadmap progress.
* Fix docs syntax for Python 2.
2017-08-16 10:55:19 -07:00
Toshio Kuratomi
546187a8af Revamp the plugin_formatter doc generator
* Use a template to generate the category lists
* Refactor so that we first extract all of the data that we need to
  build the docs and then give that data to the templates to build with
* Add docs page listing modules ordered by support level
2017-08-15 23:12:08 -07:00
Toshio Kuratomi
af2073d057 metadata 1.1
* Add network value to support_by field.
* New support_by value, certified
* Deprecate curated in favor of certified
* Add conversion from 1.0 to 1.1 to metadata-tool
* Add supported by Red Hat field to ansible-doc output
2017-08-15 23:12:08 -07:00
CyberArk BizDev
d50d65d448 Added cyberarkpassword lookup plugin (#21857)
* Added cyberarkpassword lookup plugin

Added cyberarkpassword lookup plugin: It allows to retrieve credentials
(password, sshkey) from CyberArk Digital Vault
2017-08-15 23:06:46 -07:00
Jason McKerr
cc36153928 Update ROADMAP_2_4.rst 2017-08-15 14:58:26 -04:00
hsmtkk
3f9d6aa0f1 doc: fix a typo (#28215) 2017-08-15 15:37:41 +02:00
Aleks Daranutsa
f668f41822 Spelling and Grammar for playbooks_reuse.rst (#28174)
* Spelling and Grammar for playbooks_reuse.rst

* Minor edits.
2017-08-15 00:30:06 -07:00
scottb
b5179f9d46 CSS and HTML updates to enable versioned core documentation (#28097)
* Updated header for versioned docs.

* A tree in a golden forest.

* Fixed spacing.

* Fixed CSS and text for previous version header.
2017-08-14 11:21:33 -07:00
Toshio Kuratomi
fe2e17f7cd Update the intersphinx cached indexes
In case we build docs offline, we want to have a cached copy of the
documentation refs that are in the intersphinx docs we reference.
Update those to the lattest versions from their respective upstreams
2017-08-14 08:15:28 -07:00
René Moser
eec4434b9b doc: cloudstack: fix formating issue in guide (#28162) 2017-08-14 17:14:22 +02:00
Greg DeKoenigsberg
d78c199972 Update triage_process.rst to link to ansibullbot (#28137)
* Update triage_process.rst to link to ansibullbot

* fix typo
2017-08-14 00:03:40 -04:00
Greg DeKoenigsberg
75c0c545fd Create other_tools_and_programs (#28138)
* Create other_tools_and_programs

From https://github.com/ansible/community/issues/5.

* Fix typo
2017-08-13 22:32:28 -04:00
Greg DeKoenigsberg
b3ed699132 Copying code of conduct from community.rst (#28136) 2017-08-13 21:01:07 -04:00
Greg DeKoenigsberg
608c69279c Moving "communication" info from main community page (#28135) 2017-08-13 20:28:20 -04:00
Duncan Lock
9a2ae022f5 Format the versionadded block correctly (#28085)
Currently broken on the live docs site: http://docs.ansible.com/ansible/latest/playbooks_blocks.html
2017-08-14 02:14:03 +02:00
Prasad Katti
2c85ca3729 Formatting changes (#28133) 2017-08-14 02:09:19 +02:00
Greg DeKoenigsberg
5f6bfd81f8 Copying content from MODULE_GUIDELINES.md (#28131) 2017-08-13 17:13:54 -04:00
Adrian Likins
a2c8b03b46 fix rst format errors making rstcheck fail (#28129) 2017-08-13 15:59:13 -04:00
Greg DeKoenigsberg
3ec7e030bf Completed draft of How Can I Help 2017-08-13 14:35:40 -04:00
Greg DeKoenigsberg
f8f17c0c27 Add basic info on pull requests 2017-08-13 14:19:30 -04:00
Greg DeKoenigsberg
418dd0cd4a Iterating on How Can I Help
A little more content
2017-08-13 13:43:02 -04:00
Greg DeKoenigsberg
ba065637ff Add roadmap to development process doc 2017-08-13 13:08:33 -04:00
Greg DeKoenigsberg
792bfa657c formatting tweak 2017-08-13 12:39:03 -04:00
Greg DeKoenigsberg
e43d1da938 formatting tweak 2017-08-13 12:37:46 -04:00
Greg DeKoenigsberg
d6028c5de4 Slight changes to reporting bugs and features
as recommended by @gundalow in review for #27911
2017-08-13 12:36:03 -04:00
Greg DeKoenigsberg
ebfdbfb819 New content for bugs and features (#27911)
1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.)

2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 12:31:57 -04:00
Stefan Midjich
6e4c0143b4 Typo in module example code (#28064)
In the DOCUMENTATION constant there is a typo on line 85 of this rst file.
2017-08-11 23:35:14 +02:00
Thomas Stringer
e4cd899363 Add support for Azure 2.0.0 (#27920)
* Adapt azure_rm_resource_group to azure 2.0.0 + azure Cli support

* Fix exceptions in Azure ARM plugins

* update azure_rm_networkinterface documention to reflect required params

* change state param to not required for docs in azure_rm_subnet

* fix import to reflect azure==2.0.0 changes

* add aliases and fix docs for azure_rm_storageblob

* add resource_group_name alias to azure_rm_storageaccount_facts

* fix import bug due to change in azure==2.0.0

* fix args bug and enum modules issue

* update docs to reflect azure==2.0.0

* pin management clients to a specific api_version

* update docs to reflect the new azure-ansible-base python package

* add fallback for older api resource group listing

* rework azure dependencies installation

* refactor path joining to a cross-plat solution
2017-08-11 08:22:02 -07:00
Jordan Borean
7c59b66802 updated changelog for windows (#28040) 2017-08-11 08:55:51 +10:00
Brian Coca
914ae2fb26 added docs for undocumented play object entries 2017-08-10 16:22:34 -04:00
David Newswanger
ebb1d75ee0 fixed a syntax problem that was preventing a warning box from being displayed 2017-08-10 12:37:28 -07:00
Prasad Katti
2a63693580 Minor fix in docs 2017-08-10 14:18:59 -04:00
Brian Coca
940a74a93a fixed include_role doc example (#27986)
fixes #27985
2017-08-10 12:44:56 +10:00
Dag Wieers
49aa64a5b8 Various small changes and adding myself
Unfortunately, the Github interface does no longer allow me to edit a file in the GUI and then branch it in my personal clone for making a PR. It now only offers to make a PR using a branch on the ansible repository :-(

So committing this directly instead against my will, but per the guidelines this appears to be safe. Fingers crossed...
2017-08-09 23:29:11 +02:00
Jordan Borean
362f032449 Changed docs requires to new format (#27918) 2017-08-09 06:05:46 +10:00
Joseph Miguel
f88f4394c8 Update developing_api.rst (#25922)
* Update developing_api.rst

* Update developing_api.rst

Edited.
2017-08-07 14:40:29 -04:00
Arthur Kepler
d828449611 Corrects default arg format used by datetime filter (#27612)
This ensures the default datetime format matches that of
datetime.datetime. Docs updated to match as well.
2017-08-07 11:33:25 -07:00
Toshio Kuratomi
44935a5db6 Add a (disabled) code-smell test for detecting _ variables
We are reserving the _ identifier for i18n work.  Code should use the
identifier dummy for dummy variables instead.

This test is currently skipped as someone needs to generate the list of
files which are currently out of compliance before this can be turned
on.
2017-08-07 11:11:31 -07:00
Peter Sprygada
2d5908255a add parse_cli and parse_cli_textfsm to documentation (#27755)
* add parse_cli and parse_cli_textfsm to documentation

* Minor edits.
2017-08-07 07:19:31 -04:00
Scott Butler
c43a10bd69 Another clarifying note on Python supported versions. 2017-08-04 14:02:12 -07:00
Scott Butler
7d553aad29 Added note clarifying which version of Python 3 we support. 2017-08-04 13:59:38 -07:00
Scott Butler
699e0ccc32 Added note clarifying Python 3 supported versions. 2017-08-04 13:57:09 -07:00
Branko Majic
f78baa1300 Implement ability to limit module documentation building (#24576)
* Implement ability to limit module documentation building:

- Added new option to plugin_formatter.py to support passing-in a list of
  modules for which the documentation should be built.
- Updated docuemtnation Makefile to allow specifying list of modules via
  environment variables (defaulting to all modules).
- Update instructions for building documentation and module development to
  include commands and description of limiting module documentation builds.

* Updated implementation for limiting module documentation building:

- Pass list of modules (or None) to list_modules function instead of string.
- Move conversion of module list to argument parsing code.
- No special keywords. Default ("") means build all modules. For no modules just
  specify non-existing module name.
- Updated documentation to reflect the changes.

* Updated implementation for limiting module documentation building:

- Use better default value, and don't treat "" as special case.
- Conditionally invoke different variants of command in Makefile instead of
  using special value "".

* Minor edits

Wording tweak
2017-08-04 13:10:36 -07:00
Scott Butler
bfe470d391 Minor edit 2017-08-04 10:10:03 -07:00
Scott Butler
6d59ac1bb4 Updated per tech review feedback. 2017-08-04 00:05:16 -07:00
Scott Butler
b2ec984130 Updating packaging locations - incorporating review feedback. 2017-08-03 21:33:13 -07:00
Toshio Kuratomi
f4d7b9a596 code-smell test changes
* Create get_exception and wildcard import code-smell tests
* Add more detail to boilerplate and no-basestring descriptions
* Remove the no-list-cmp test as the pylint undefined-variable test covers it
2017-08-03 13:15:12 -07:00
Yaacov Zamir
48922660fe New model manageiq manageiq user (#26641)
* ManageIQ: manageiq_user module, module utils and doc_fragment

ManageIQ is an open source management platform for Hybrid IT.

This change is adding:
- manageiq_user module, responsible for user management in ManageIQ
- manageiq utils
- manageiq doc_fragment

* Handle import error

* Use formatting options

* group parameter is required

* changed doesn't need to be an attribute

* resource dictionary should contain values which isn't None

* move from monitoring to remote-management

* Use ManageIQ nameing convention

* Do not set defauts in arguments

* Use idempotent state parameter instead of action

* Check import error in the manageiq util class

* Update the miq documentation

* rename the connection configuration from miq to manageiq_connection

* All messeges start with non cap, fix typos, add examples, rename vars

* more typos fixes

* Make sure we insert only strings to logs by using % formating

* use suboptions keyword for the manageiq connection

* do not log the managiq connection struct (it include sensitive information like username and password)

* add missing from __future__

* ahh, wrong no-log line

* Use sub options
2017-08-03 10:49:47 -04:00
John R Barker
7f8aaf97de rst validation fix (#27698) 2017-08-03 15:07:46 +01:00
Greg DeKoenigsberg
aca4504e96 Simple "good enought" index page (#27667)
Removing the FIXME, just a peppy little starter page.
2017-08-02 21:51:58 +01:00
John R Barker
df58d943d3 Docs porting guides 2.0 & 2.3 (#27632)
* Create new "Porting Guide" section

Create new landing page
Add porting_guide_2.3

* correct CHANGELOG

* Document blocks

* Document named blocks

* OpenBSD & async action plugins

* OpenBSD & async action plugins

* versioadded for name

* review comments
2017-08-02 21:36:17 +01:00
scottb
3476b005b9 Initial pass at consolidating community content [work in progress] (#27661)
* Added placeholder topics for community info

* Setup community section index.

* Initial move of triage process docs.

* Typo/test

* Removed triage topic from index.
2017-08-02 12:38:29 -07:00
Adrian Likins
ac37be9761 update roadmap (multiple vault secrets merged) (#27644) 2017-08-02 11:15:12 -04:00
Abhijit Menon-Sen
20b0716948 Allow variables to be passed in to template lookup plugin (#18662)
This allows a single template to be evaluated with different values in
the same task. For example, with a template like 'x:{{a}}', one could do
something like this:

    - foo:
        a: "{{ lookup('template', 'x.j2', template_vars=dict(a=foo[item])) }}"
        b: "{{ lookup('template', 'x.j2', template_vars=dict(a=bar[item])) }}"
      with_items:
        - x
        - y

…and "a" and "b" would expand to different strings based on what we
passed in to the template lookup.
2017-08-02 09:29:27 +05:30
Ganesh Nalawade
70ce394840 Persistent connection timer changes (#27272)
*  Add command_timeout timer that defines the amount
   of time to wait for a command or RPC call before
   timing out.
*  Remove connect_retries and connect_interval configuration
   varaible and replace it with connect_retry_timeout to control
   the timeout value of connection to local scoket.
*  Make required changes to netowrk action plugins and relevant
   network files in module_utils.
*  Required documentation changes.
2017-08-01 11:45:45 -06:00
Brian Coca
842951f00d added note about not all tasks being 'delegatable' 2017-08-01 08:24:37 -04:00
Scott Butler
12e349fe48 Updated package locations. 2017-07-31 21:10:43 -07:00
Matt Davis
e4d153bd5d update WSL installation docs for current builds (#25237)
* supersedes #25224
2017-07-31 18:07:07 -07:00
Jordan Borean
ad5fa60a2b Added initial developing module doc for Windows (#27308)
* Added initial developing module doc for Windows

* Added to dev index, made formatting changes and moved obsolete docs

* changes based on PR feedback

* some typos and extra information

* Minor updates

* minor wording clarifications
* remove references to "remote" Windows hosts
* update template/text to remove legacy `#WANT_JSON`/`#POWERSHELL_COMMON`
* use per-execution envvars for ANSIBLE_KEEP_REMOTE_FILES instead of stateful

* fix up minor sanity check issue
2017-08-01 08:02:56 +10:00
Matt Clay
51bd07204b Revert "Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)"
This reverts commit 520696fb39.
2017-07-27 18:15:56 -07:00
Toshio Kuratomi
520696fb39 Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)
* Revert "Update conventions in azure modules"

This reverts commit 30a688d8d3.

* Revert "Allow specific __future__ imports in modules"

This reverts commit 3a2670e0fd.

* Revert "Fix wildcard import in galaxy/token.py"

This reverts commit 6456891053.

* Revert "Fix one name in module error due to rewritten VariableManager"

This reverts commit 87a192fe66.

* Revert "Disable pylint check for names existing in modules for test data"

This reverts commit 6ac683ca19.

* Revert "Allow ini plugin to load file using other encoding than utf8."

This reverts commit 6a57ad34c0.
2017-07-27 17:08:31 -07:00
Toshio Kuratomi
3a2670e0fd Allow specific __future__ imports in modules
We do want to allow certain from __future__ imports in modules that make
it easier to code compatible python2 and python3.  Note that
unicode_literals is specifically left out and should never be allowed.
Now that python-3.4+ allows u"" there's no good reason to use
unicode_literals.

Also switch tables in the validate_modules documentation to simple table format
2017-07-27 15:37:26 -07:00
Yannig Perré
6a57ad34c0 Allow ini plugin to load file using other encoding than utf8.
- New option for ini plugins: encoding
  - Add a new option encoding to _get_file_contents
  - Use replace option in test/runner/lib/util.py when calling decode on stdout/err
    output when diff have non-utf8 sequences
2017-07-27 14:20:18 -07:00
Toshio Kuratomi
bf42f94021 Fixes to pip with git install instructions
* use git+https:// in the example url because not everyone will have ssh
  keys registered on github
* Remove the link to the github tarballs as they do not work.  users can
  use releases.ansible.com instead.
2017-07-26 16:28:42 -07:00
scottb
058e67dcbe Minor edits. 2017-07-26 10:50:01 -04:00
Brian Coca
74e9e4bcbd updated --diff docs 2017-07-26 10:50:01 -04:00
David Moreau-Simard
e2d874c744 Improve release and development cycle documentation
This commit:
- Adds a table highlighting the status of each version and provides
  a link to each major release's changelog
- Re-inforces how stable versions are maintained and for how long
- Moves this documentation out of the developer tree (this is
  interesting for users too!) while keeping a link there.
2017-07-25 23:38:08 -07:00
jokurz
732912b641 Add local_action example in case of multiple arguments (#26427)
* Add local_action example in case of multiple arguments

Add an example to show how local_action can be used in case of multiple arguments.

* Update playbooks_delegation.rst
2017-07-25 19:06:59 -07:00
Andrea Tartaglia
341cf290d3 Added become_exe and become_flags docs (#19554)
* Added become_exe and become_flags docs

* Minor edits
2017-07-25 18:59:57 -07:00
Martin Krizek
9c50933a80 docs: fix community meetings link (#27264) 2017-07-25 09:23:01 -04:00
Matt Davis
9986639681 various Windows/Azure roadmap updates 2017-07-24 08:32:54 -07:00
Abhijeet Kasurde
4fd7ab11ff Minor fix for typo - ismount to is_mount
Fix adds correction from ismount to is_mount filter in
playbooks_tests documentation.

Fixes: 27128

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-07-24 08:56:46 -04:00
Sam Doran
dac519135d Change docs to reference BOTMETA.yml instead of MAINTAINERS.txt (#26912) 2017-07-21 17:51:02 -04:00
Sloane Hertel
7a8054812c updated roadmap (AWS) (#27011)
* update AWS roadmap

* Update ROADMAP_2_4.rst
2017-07-21 13:56:06 -07:00
Toshio Kuratomi
f4bb71c0df Update roadmap with python3 status (#27171) 2017-07-21 12:17:49 -07:00
Matt Clay
a53dabf664 Update testing progress on 2.4 roadmap. 2017-07-20 22:02:59 -07:00
Chris Alfonso
c19d25cf67 Updating network roadmap segment to reflect any changes we decided (#27057)
upon during our 2.4 dev cycle.
2017-07-20 08:22:19 -06:00
rgm
13e7e00706 Fix double-quote chars in passwordstore examples (#27084)
Also add link to passwordstore.org and correct a typo.
2017-07-20 12:29:29 +10:00
Serge Bishyr
7694fd6f9f #27045 fix installation guide via apt (ubuntu) (#27049)
* #27045 fix installation guide via apt (ubuntu)

* Update intro_installation.rst

Re-added apt-get update as it is needed to get the latest package index from ppa:ansible/ansible
2017-07-20 11:52:21 +10:00
Adrian Likins
33a2d72290 Update facts/vault roadmap items (#27082)
* Update facts/vault roadmap items
2017-07-19 18:44:51 -04:00
James Mighion
b8337ee9d3 New module aireos_command (#26769)
* Adding ciscowlc_command module and unit tests.

* Adding __init__.py for unit test.

* Fixing PEP8 W503.

* Renaming module from ciscowlc_command to aire_command.

* Renaming aire_command to aireos_command.
2017-07-19 23:14:52 +05:30
acrewdson
0a4c570153 Fix typo (#26988) 2017-07-19 08:33:04 -04:00
Ryan Brown
beca565c79 [Docs] Add note on module development about the copyrights (#26812)
* Add note on module development about the copyrights

This matches what's in CODING_GUIDELINES.md as of July 2017

* Add recommendation for standardizing on `Copyright (c) 2017 Ansible Project`

* s/with/should have/

* Fix more unicode
2017-07-19 06:58:52 -04:00
James Mighion
f682d9bf49 Adding aruba_command module along with unit tests. (#26625)
* Adding aruba_command module along with unit tests.

* Fixing PEP8 E303 too many blank lines.

* Adding default for timeout.

* Removing unused arguments. Moving default for timeout argument. Fixing cliconf to find hostname.

* Fixing PEP8 E302.
2017-07-19 09:49:12 +05:30
Toshio Kuratomi
37e757286d Add module_utils example next to library examples (#25390) 2017-07-18 17:09:32 -07:00
Dylan Silva
913a8f864a changed freeze date for modules (#27009) 2017-07-18 14:11:15 -07:00
Matt Clay
16f796460f Fix rstcheck issue. 2017-07-18 11:42:56 -07:00
Brian Coca
3477825fc9 updated roadmap 2017-07-18 14:22:52 -04:00
Matt Clay
8e66015564 Fix rst syntax in roadmap. 2017-07-18 10:47:59 -07:00
Adrian Likins
06e49dfbbd fix roadmap, strikethough does not quite work 2017-07-18 12:58:51 -04:00
Adrian Likins
e6de059048 updating roadmap with facts status 2017-07-18 12:45:17 -04:00
Matt Clay
e63f69464f Add ansible-test options and docs. (#26823)
* All integration commands support --continue-on-error
* The network-integration command supports --inventory
* Add landing page for compile test docs.
* Add bot documentation links.
2017-07-14 16:52:11 -07:00
Dylan Silva
ba000abe1c Added in dates for freeze (#26814)
* Added in dates for freeze

* Update ROADMAP_2_4.rst
2017-07-14 09:30:09 -07:00
Matt Clay
789218c215 Initial ansible-test sanity docs. (#26775)
* Rename no-iterkeys test for consistency.

* Require docs for all ansible-test sanity tests.

* Initial ansible-test sanity docs.

* Fix capitalization of Python.

* Fix sanity code smell test false positives.

* Fix another code-smell false positive.
2017-07-14 14:24:45 +01:00
Lujeni
640131c464 Missing documentation about the include directive for requirements files (#20090)
* Missing documentation about the include directive for requirements files

* Code block needs blank line

* Correct casing
2017-07-14 10:48:51 +01:00
scottb
4f01a323a0 Replace 'simple module development' topic (#26267)
* WIP: Initial bulk move of quick start content into rst docs. Needs rewrite.

* Swapping out old quick start for new material (thanks @tstringer!). Still work in progress.

* Fixed formatting; removed extraneous file.

* Fixed some formatting errors.

* Once more, with feeling.

* Fixed formatting error
2017-07-13 19:06:01 -07:00
Pilou
2a92120ffa INI inventory plugin: add documentation about variable types (#25798)
* INI inventory: check variable types
* INI inventory: add doc about variable types

Fixes #25784
2017-07-13 12:04:20 -07:00
Pilou
4b3d6dfa8a Use pycodestyle instead of pep8 (#25947) 2017-07-13 11:46:31 -07:00
Dag Wieers
cda6f602f1 Fix missing index (#26678) 2017-07-12 13:48:52 +01:00
Dag Wieers
292f109ad6 Restructure roadmap so that we can link to sub-parts (#26637)
* Restructure roadmap so that we can link to sub-parts

So we want to point to specific subsections in the roadmap from the Working Group pages.
This requires the use of subtitles rather than a long list of items and sub-items.

* RST syntax is hard...

* Fixes as requested

* Another fix

* Converted all ROADMAPs to new format
2017-07-11 20:57:01 +01:00
Dag Wieers
318f369969 filetree: Add documentation for lookup plugin (#26157)
* filetree: Add documentation for lookup plugin

This is the missing documentation for the filetree lookup plugin.

* Fix typo

* Edits for grammar and clarity
2017-07-04 15:20:46 -07:00
Chiyu Zhong
505dd9fe44 Update playbooks_loops.rst 2017-07-03 22:43:31 -04:00
John R Barker
ed0aabe02d Tell people to look for an existing module PR (#26287)
* Tell people to look for an existing module PR

There are a number of different ways to find existing PRs that add new
modules. Tell people about them to potentially avoid duplicates.

* Light edits
2017-06-30 20:16:26 +01:00
Helio Campos Mello de Andrade
54c64deaab Remove unnecessary 'our"word. (#26221)
Remove unnecessary 'our"word.
2017-06-29 11:22:46 -07:00
Scott Butler
ed17d7a0a5 Editing to fix wording from PR #26161. 2017-06-28 23:12:52 -07:00
Chainarong Tangsurakit
ff30682740 [cloud][gce] Add necessary key for secrets.py (#25997)
Add necessary key for secrets.py
2017-06-28 16:04:24 -04:00
Sam Doran
6f73ab84c6 Correct note syntax so Docker on non-Linux note shows up (#26161)
The note only had one colon instead of two, which allowed it to pass rstcheck but failed to actually generate the note in the HTML.

Also remove an unnecessary trailing colon.
2017-06-28 10:06:56 +01:00
Sam Doran
67eae347cd Fix roles language in docs (#25811)
* Correct tag behavior with regards to roles

* Remove trailing spaces

* Furthe clarify include vs. import tag behavior
2017-06-26 23:10:07 -07:00
Brian Coca
8bcfb85918 display v added 2017-06-23 16:44:48 -04:00
Laurens Vanderhoven
6922a18c80 Update playbook_best_practices.rst, range notation (#25959)
Update --limit range notation.

Current notation triggers "[WARNING]: Use [x:y] inclusive subscripts instead of [x-y] which has been removed"
2017-06-21 23:01:41 -07:00
John R Barker
4ab4a6766e ansible-windows IRC (#25872) 2017-06-19 16:45:47 +01:00
John R Barker
5551e87755 RETURNS can include version_added (#25810) 2017-06-16 20:17:38 +01:00
Simon Dodsley
937d7993cc Initial commit for Pure Storage Ansible module (#25386)
* Initial commit for Pure Storage Ansible module

* Initial commit for Pure Storage Ansible module

* Initial commit for Pure Storage Ansible module

* Fix import issues as required by post-2.2

* Move last import to top

* Follow suggestions and only implement one module per PR
Fix documentation changes requested

* Documentation and formatting changes
2017-06-16 11:28:50 +01:00
Matt Martz
89c3151167 Give example of empty _meta in dyanmic inventory (#24085) 2017-06-15 09:51:34 -05:00
Sanket Jagtap
dbb3fd0e5e Formatted Dynamic Inventory link for Openstack (#25351)
* Formatted Dynamic Inventory link for Openstack

* Create intro_dynamic_inventory.rst
2017-06-15 03:00:00 -07:00
Abhijeet Kasurde
b89cb95609 Fix spelling mistakes (comments only) (#25564)
Original Author : klemens <ka7@github.com>

Taking over previous PR as per
https://github.com/ansible/ansible/pull/23644#issuecomment-307334525

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-06-12 07:55:19 +01:00
Brian Coca
9d23dcac29 fixed version added tag 2017-06-09 14:09:14 -04:00
John R Barker
4e6fee212a Correct link to plugins (#25530) 2017-06-09 13:06:08 +01:00
Pilou
bf0d0274cf doc: PEP 8 compliance is required (#25524) 2017-06-09 12:20:56 +01:00
Dag Wieers
357069afcb Add missing modules (#25483) 2017-06-08 17:31:10 +01:00
George Nikolopoulos
a00089c341 New module: manage Citrix Netscaler service configuration (network/netscaler/netscaler_service) (#25129)
* netscaler_service initial implementation

* Changes as requested by reviewers

* Skip some tests if under python2.6 and importing requests library

* Change option "operation" to "state"

* Remove print statements from netscaler module utils

* Catch all exceptions during login

* Fix fail message

* Add common option save_config
2017-06-08 08:33:32 -06:00
John R Barker
217c80ba7e New IRC groups + Formatting (#25441)
* New IRC groups + Formatting

* Edits for conciseness and clarity.
2017-06-08 10:59:30 +01:00
Matt Martz
004e99316c Allow template files to be vaulted (#22951)
* Allow template files to be vaulted

* Make sure to import exceptions we need

* get_real_file can't take bytes, since it looks specifically for string_types

* Now that we aren't using open() we don't need b_source

* Expand playbooks_vault docs to include modules that support vaulted src files

* Add vaulted template test
2017-06-07 14:16:03 -04:00
James Cammarata
45378e71d1 Removing auto-generated doc from previous import/include commit 2017-06-06 16:54:43 -05:00
James Cammarata
483df9c5f8 Imports and includes (#25399)
Initial commit to split includes into static imports/dynamic includes

This implements the new include/import syntax for Ansible 2.4:
* include_{tasks,role,variables} = dynamic
* import_{playbook,tasks,role} = static

The old bare `include` will be considered deprecated, as will any use of the `static: {yes|no}` option.

This also adds docs for import/include and reorganizing the "Playbook Reuse" section of the documentation.
2017-06-06 16:39:48 -05:00
Matt Davis
365d06c538 add Makefile target for single HTML page (#25313) 2017-06-02 11:11:28 -07:00
Brian Coca
c7eaccb7b5 added delegate_to warning 2017-06-02 10:38:42 -04:00
Timo Sand
aa9ea3d43a Adds documentation of implicit regex match removal (#24934)
regex_replace has a implicit parameter for `replacement` and thus can remove the matched string
2017-06-01 12:49:35 +01:00
Tyler Lubeck
d6bfc11e6d Fix formatting for rst code block (#25185) 2017-05-31 15:04:57 +01:00
Dag Wieers
47738eb1dd docs: PEP8 compliance (#24681)
- Make PEP8 compliant
2017-05-30 18:08:25 +01:00
scottb
54bdcd734e Some cleanup of the intro and getting started sections. (#25083) 2017-05-28 01:42:50 -07:00
Iain Foulds
a1709bf0f9 Correcting YAML identation (#25049) 2017-05-26 16:11:01 +02:00
Brian Coca
61060b66c2 make rst linter happy 2017-05-24 14:29:05 -04:00
scottb
f315d4260f Update playbooks_intro.rst
Edits
2017-05-24 14:29:05 -04:00
Brian Coca
70b2ceebe5 document new 'order' keyword for plays 2017-05-24 14:29:05 -04:00
Brian Coca
8f97aef1a3 Transition inventory into plugins (#23001)
* draft new inventory plugin arch, yaml sample

 - split classes, moved out of init
 - extra debug statements
 - allow mulitple invenotry files
 - dont add hosts more than once
 - simplified host vars
 - since now we can have multiple, inventory_dir/file needs to be per host
 - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager'
 - centralized localhost handling
 - added plugin docs
 - leaner meaner inventory (split to data + manager)
 - moved noop vars plugin
 - added 'postprocessing' inventory plugins
 - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them
 - grouphost_vars loading as inventory plugin (postprocessing)
 - playbook_dir allways full path
 - use bytes for file operations
 - better handling of empty/null sources
 - added test target that skips networking modules
 - now var manager loads play group/host_vars independant from inventory
 - centralized play setup repeat code
 - updated changelog with inv features
 - asperioribus verbis spatium album
 - fixed dataloader to new sig
 - made yaml plugin more resistant to bad data
 - nicer error msgs
 - fixed undeclared group detection
 - fixed 'ungrouping'
 - docs updated s/INI/file/ as its not only format
 - made behaviour of var merge a toggle
 - made 'source over group' path follow existing rule for var precedence
 - updated add_host/group from strategy
 - made host_list a plugin and added it to defaults
 - added advanced_host_list as example variation
 - refactored 'display' to be availbe by default in class inheritance
 - optimized implicit handling as per @pilou's feedback
 - removed unused code and tests
 - added inventory cache and vbox plugin now uses it
 - added _compose method for variable expressions in plugins
 - vbox plugin now uses 'compose'
 - require yaml extension for yaml
 - fix for plugin loader to always add original_path, even when not using all()
 - fix py3 issues
 - added --inventory as clearer option
 - return name when stringifying host objects
 - ajdust checks to code moving

* reworked vars and vars precedence
 - vars plugins now load group/host_vars dirs
 - precedence for host vars is now configurable
 - vars_plugins been reworked
 - removed unused vars cache
 - removed _gathered_facts as we are not keeping info in host anymore
 - cleaned up tests
 - fixed ansible-pull to work with new inventory
 - removed version added notation to please rst check
 - inventory in config relative to config
 - ensures full paths on passed inventories

* implicit localhost connection local
2017-05-23 17:16:49 -04:00
Dag Wieers
cce133b14f WinRM: Add operation and read timeout variables to docs (#24922)
* Add operation and read timeout variables to docs

Since WinRM is not the most reliable protocol, it may be necessary to increase its timeout values to get a better experience.

* Update intro_windows.rst

Great idea to add this.
I changed 'experienced' -> 'experience' (present continuous rather than past tense).  Added some . to be consistent with other lines.
2017-05-23 11:10:25 +01:00
Michael De La Rue
e9e661ebbb aws integration tests - provide an IAM policy for running (#24725)
* aws integration tests - provide an IAM policy that can be used for running them

* move documentation of aws policies into main integration testing documentation + some updates there

* Update testing_integration.rst

Edits
2017-05-19 14:37:39 -07:00
John R Barker
f338dd2fc3 Render returned dictionaries Fixes #24775 (#24777)
plugin.rst.j2 was out of sync with syntax validator
2017-05-18 15:13:33 +01:00
John R Barker
c9e05956b7 Update testing_units.rst (#24772) 2017-05-18 10:26:45 +01:00
Brian Coca
7bb0a8d4fc added order doc for inventory keyword 2017-05-16 15:54:19 -04:00
Brian Coca
c7b9f2a6de added docs about url 2017-05-16 15:52:30 -04:00
Matt Clay
9178e176b5 Limit sphinx version on python 2.6. (#24678)
* Limit sphinx version on python 2.6.
* Fix issues identified by rstcheck.
2017-05-17 01:00:15 +08:00
Abhijeet Kasurde
9f3a405706 Fix URLs in dev_guide documentation (#24533)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-05-15 13:23:46 +01:00
Matt Martz
eb5e906014 Support py3 in plugin_formatter.py (#24384)
* Support py3 in plugin_formatter.py

* Do everything in bytes
2017-05-13 10:04:30 -05:00
Matt Davis
0f4026d626 add Windows docs for winrm automatic kerb ticket mgmt (#24456) 2017-05-10 16:22:54 -07:00
Brian Coca
91449ea231 removed autogenerated file and added to ignore 2017-05-09 11:08:01 -04:00
James Cammarata
ed56f51f18 Fixing security issue with lookup returns not tainting the jinja2 environment
CVE-2017-7481

Lookup returns wrap the result in unsafe, however when used through the
standard templar engine, this does not result in the jinja2 environment being
marked as unsafe as a whole. This means the lookup result looses the unsafe
protection and may become simple unicode strings, which can result in bad
things being re-templated.

This also adds a global lookup param and cfg options for lookups to allow
unsafe returns, so users can force the previous (insecure) behavior.
2017-05-08 12:43:46 -05:00
Dylan Silva
6f4f7011f1 Updates to docs for developers (#24034)
- Added items to index for TOC
- Changed some formatting on overview_architecture
- removed some out of date items from developing_modules_general
2017-05-08 09:08:55 -07:00
Adrian Likins
5618f494a8 Fix docs/api sphinx-build err on 'make rpm' (#24334)
The makefile in docs/api/ had a top level check for the
'sphinx-build' tool, but the check was getting triggered
on 'make clean' when it is not needed and causing 'make rpm'
and similar builds to fail.

So this commit removes the check.

Fixes #24163
2017-05-05 17:09:38 -04:00
Matt Clay
cec2b960f8 Fixes for pep8 and rstcheck issues. 2017-05-05 10:47:05 +08:00
scottb
02057f481b Added style guide (#24310)
* Added style guide

* Fixed index
2017-05-04 13:25:13 -07:00
Andrea Tartaglia
4e4fc9cb4c Added test for 'RETURN' field in validate-modules (#23322)
* Added test for 'RETURN' field in validate-modules

* print the field being tested.

Useful when the RETURN structure is complex.

* Fixed schema after CI traceback fail

* Fixed list_string_types

* Fixed line in 319 code for RETURN
2017-05-02 09:01:53 +01:00
Brian Coca
033fe5548b added epub entry for makefile 2017-05-01 13:41:04 -04:00
Dan Kolb
914f8e4596 Fixes minor type in docs (#24117)
Removes an extra `e` from the word `batch` in the the
`playbooks_delegation` documentation seen at:
http://docs.ansible.com/ansible/playbooks_delegation.html
2017-04-28 16:47:35 -04:00
John R Barker
8733253a76 Minor testing docs improvements (#24103)
Fix a few formatting issues spotted post review.
Also reapply missing commit
2017-04-28 11:58:38 +01:00
John R Barker
ecbf8e933a Docs how to test (2nd) (#24094)
* Big testing doc refactor
* Combine all the testing documentation in to one place to make it easier to find
* Convert everything to RST
* Create testing_network guide
* Create testing landing page
* For each section detail "how to run" and "how to extend testing"
* More examples
* Lots more detail
2017-04-28 09:08:26 +01:00
Strahinja Kustudic
66a41f59fd Add a missing leading zero in a mode parameter
600 is an incorrect mode, because mode needs to be octal.
2017-04-27 09:35:27 -07:00
Strahinja Kustudic
6dddd5b167 Remove action keyword from do-until example
`action:` is old and not needed any more.
2017-04-27 09:34:46 -07:00
Toshio Kuratomi
51e3390333 Document deprecation of fetch module validate_md5 and update --tags merging deprecation (#24022)
* Document deprecation of fetch module validate_md5 and update --tags merging deprecation

Update the default of --tags merging config option to merge by default

* Update CHANGELOG.md

Minor edit
2017-04-26 19:57:21 -07:00
scottb
946658cd24 Update playbooks_python_version.rst
Minor edits
2017-04-25 12:26:40 -07:00
Toshio Kuratomi
78dd3496e2 Update version and change remove files from pep8 blacklist 2017-04-25 12:26:40 -07:00
Toshio Kuratomi
82ad8ff081 Add documentation of Jinja2 templating idioms that differ when run under Python3
Fixes #19514
2017-04-25 12:26:40 -07:00
Toshio Kuratomi
4c7a2e2622 Enable intersphinx for python stdlib and jinja2
This setting allows us to reference jinja2 and python stdlib docs
via docutils refs instead of hardcoding urls.

Fixes #18039

Remove extraneous sphinx config
2017-04-25 12:26:40 -07:00
Strahinja Kustudic
74e385e43a Move include_vars to host scope (#23868)
* Move include_vars to host scope

Module include_vars actually sets variables on a host level, and not the play level.

* Expand vars entires
2017-04-24 09:14:47 -07:00
David Mahler
09b247dd34 Minor grammatical corrections and improvements (#23886) 2017-04-23 00:47:03 -07:00
Brian Coca
3358abcf49 Add a new filter: strftime. Use the well known function to format a date output. (#23832)
(cherry picked from commit 3f5b304fc28b6c34df9ea6a4c3531dc422ce198b)
rebased for @yannig
2017-04-21 11:48:45 -07:00
Eric Anderson
6aab341248 changed code block formatting to match format (#23615) 2017-04-20 10:12:58 -07:00
Adam Johnson
f1c4b434cd Tidy example inventories in "Developing Dynamic Inventory Sources" (#18758)
Thanks @adamchainz!
2017-04-20 09:36:16 -07:00
Tomáš Karásek
0b585ec4fd Add guide for Packet host (#21346)
* Add guide for Packet host

* incorporate feedback from Packet

* Format headings according to Python doc guide

* fixed rstcheck issues in packet guide
2017-04-20 14:57:34 +01:00
Alexander Gubin
d04a5246de Fix example fact(ansible_default_ipv4.address) for delegated_facts 2017-04-19 10:59:59 -07:00
John R Barker
33d7c12a97 Improve network debug wording (#23735) 2017-04-19 12:20:07 +01:00
Ian Levesque
acd1dd8df1 Add ssh_connection / retries option documentation (#23463)
No docs were included when https://github.com/ansible/ansible/pull/9927 was merged.
2017-04-18 17:06:51 -07:00
Dag Wieers
d188f56535 Add example task succeeding when RC is non-zero (#23698)
* Add example task succeeding when RC is non-zero

I added an example on how to use the return code to decide yourself
what is considered a failure.

This might have helped for #23679.

* Use diff as example command, instead of robocopy
2017-04-18 14:17:52 +00:00
Scott Butler
087159c4cd Switch Adobe tracking off staging. 2017-04-17 13:36:31 -07:00
Dag Wieers
b6c00f722b Windows: Add Windows Subsystem for Linux documentation (#23515)
* Windows: Add Windows Subsystem for Linux documentation

As discussed during the Windows Working Group meeting we do want
documentation on running Ansible on Windows as it may help grow
the Windows/Ansible community and does work out-of-the-box.

However we do take care to emphasize that WSL is not fit for
production use.

* Update intro_windows.rst

Edits for mechanics and clarity.
2017-04-13 11:22:40 -07:00
Matt Clay
cb1f57d4e5 Add rstcheck to ansible-test and correct issues. (#23550)
* Add rstcheck to ansible-test.
* Fix rst code-block languages and syntax errors.
* Fix rst inline literals.
* Update python 2 code block to pass tests on py 3.
2017-04-13 10:28:52 -07:00
John R Barker
729b0e3bee Use exports (#23542) 2017-04-12 16:03:31 -04:00
Brett Cannon
ece2aa2d5f Fix reST markup (#23536) 2017-04-12 13:49:26 -04:00
John R Barker
e575eae2ec Document how to debug network issues (#23503) 2017-04-11 20:35:21 +01:00
Brian Coca
eaaf46a50d Revert "made example not fail"
This reverts commit 2c9543e0b7.

example won't fail but will prevent correct PATH from being set
using actual fix to deal with this corner case
2017-04-10 12:17:19 -04:00
cclauss
6314169afd Update the comments around Python 3
[Enterprise Linux 5 is at the end of "End of Production 3 phase"](https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux#Product_life_cycle) so that is no longer a reasonable reason to wait.  Also removed the comments about [Python 3 not being mainstream](http://python3wos.mybluemix.net/201).  Perhaps a link to https://docs.ansible.com/ansible/python_3_support.html would also be a useful addition to this question.
2017-04-07 15:20:04 -07:00
John R Barker
01e27b1083 Typo 2017-04-04 19:40:41 +01:00
Toshio Kuratomi
3180b4757e The Python3 dev doc is more general than just modules (#22950)
The Python3 dev doc is more general than just modules

* Rename it to make that obvious.
* Move generally applicable Python3 information to the Controller section
* Add a Py3/Py2 section on formatting strings
* Fix code-blocks to highlight as python
* Enhance python3 support page
* Add Python3/Python2 compat note
2017-04-04 11:18:19 -07:00
Matt Davis
d85f4a443f mark runas become method experimental (#23235)
Due to the number of "real world" caveats in the current runas become method, it was agreed that we'd warn that it's experimental on use. A potential future version based on LogonUser/CreateProcessAsUser will have very different requirements and limitations.
2017-04-03 13:46:51 -07:00
Brian Coca
2c9543e0b7 made example not fail
fixes #23180
2017-03-31 15:44:15 -04:00
Scott Butler
5591d639f5 Fixed broken link. 2017-03-31 11:17:53 -07:00
Brian Coca
06e0b00035 fixed notation on entries, meant literal not italic 2017-03-31 13:23:30 -04:00
Brian Coca
42383656e7 using prefered format
(cherry picked from commit a78a0caf10e08200ef3dc82c4b78feeecef0d063)
2017-03-31 00:53:53 -04:00
John R Barker
22fe148ca5 Formatting of bullet points 2017-03-30 18:50:29 +01:00
Brian Coca
a0a26700c9 remove author as it dupes 2017-03-30 12:36:52 -04:00
Brian Coca
da045a9c1f more info for asciidoc to correctly build manpages 2017-03-30 12:34:46 -04:00
Toshio Kuratomi
0249918c7b When outputting text to a file, convert to bytes first.
Fixes #23137
2017-03-30 12:34:38 -04:00
Jerry Wardlow
8f4652ab2f Corrects typo in inventory_ignore_extensions (#23099)
Corrects a typo from 'Coma-separated' to 'Comma-separated'
2017-03-29 20:16:14 -07:00
John Nelson
99a160f9c7 Update playbooks_prompts.rst (#22910)
* Update playbooks_prompts.rst

Clarify prompting only occurs when not in extra_vars

* Update playbooks_prompts.rst

* Update playbooks_prompts.rst

Added non-interactive session clarification.

* Update playbooks_prompts.rst
2017-03-29 20:14:43 -07:00
Konstantin Suvorov
c1b3d6a51f Fix 'sequence' lookup shortcut syntax and documentation (#22989)
* fix 'sequence' lookup shortcut syntax and documentation

* Update playbooks_loops.rst

Minor edits for grammar and clarity.

* Update playbooks_loops.rst

Another tweak for clarity.
2017-03-29 19:11:19 -04:00
John R Barker
6c101087ac RST Code should be `--tags` fixes 22717 (#23074) 2017-03-29 14:21:15 +01:00
Dylan Silva
24e7a77a32 Updated 2.4 roadmap for final publish (#23049)
* Updated 2.4 roadmap for final publish

* Update ROADMAP_2_4.rst

* Remove "code refactor and unit tests"

This is just technical debt work, and not note-worthy for the roadmap

* Update ROADMAP_2_4.rst

* Update ROADMAP_2_4.rst
2017-03-28 15:53:43 -07:00
Chris Houseknecht
d2ea851d09 Adds k8s_common.py (#22899) 2017-03-28 02:27:28 +02:00
Toshio Kuratomi
d8f86fa4d2 A couple more places where compat.six was used converted to module_utils.six (#22976) 2017-03-27 14:41:31 -04:00
Brian Coca
2a2e02aea4 .--. . .--. ---.. / .. ... / .- -. -. --- -.-- .. -. --. 2017-03-24 15:52:36 -04:00
Brian Coca
18a7a1ec31 added docs to CLI docstringsadded
removed 'now intermediate build files' from repo
adjusted gitignore
2017-03-24 15:52:36 -04:00
Brian Coca
424e1946f4 moved docs generation and templates to docs/ 2017-03-24 15:52:36 -04:00
Brian Coca
b4c47ebf68 draft to generate man pages 2017-03-24 15:52:36 -04:00
Toshio Kuratomi
2fff690caa Update module_utils.six to latest (#22855)
* Update module_utils.six to latest

We've been held back on the version of six we could use on the module
side to 1.4.x because of python-2.4 compatibility.  Now that our minimum
is Python-2.6, we can update to the latest version of six in
module_utils and get rid of the second copy in lib/ansible/compat.
2017-03-23 13:35:05 -07:00
Brian Coca
6b8347ec60 updated doc man page 2017-03-23 01:27:19 -04:00
scottb
fb48c45adf Added Adobe DTM tracking. (#22889) 2017-03-22 19:37:01 -07:00
Brian Coca
a04dd375eb adjusted home examples to actual value 2017-03-22 15:33:12 -04:00
Brian Coca
a36c66023f updated remote_tmp example 2017-03-22 15:33:12 -04:00
Brian Coca
a1a5a2b1de fixed passwordstore lookup examples
plugin was renamed before acceptance, but examples kept original name
fixes #22735
2017-03-21 15:26:55 -04:00
Dag Wieers
c254618d4f Improve test docs a bit more 2017-03-20 16:54:34 -07:00
Brian Coca
94b269b2ec documented some more keywords 2017-03-20 16:07:27 -04:00
Benjamin
dc68503ef2 Update link URL to OpenStack documentation (#22776) 2017-03-19 19:38:27 -07:00
Bradford Dabbs
2472a4587e Flip setenforce boolean (#22752)
* Flip setenforce boolean

* Update example task name
2017-03-17 22:18:48 -07:00
René Moser
b90517caf9 cloudstack: implement config overloading and ENV vars for API auth (#22724)
* cloudstack: fix connection by ENV vars and configs overloading

* cloudstack: pep8 cloudstack module_utils

* cloudstack: allow api_url to be set in ini config

* docsite: explain ENV vars support as written in python-cs for ansible
2017-03-17 11:01:43 +01:00
Toshio Kuratomi
8de05d3752 [WIP] Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5 (#22721)
* Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5
* Switched to bullet points to enhance readability.
2017-03-16 18:49:29 -07:00
jwg4
17b8bfc7a2 Change the example of playbook include. (#22697)
This (taken from https://github.com/ansible/ansible-examples/blob/master/language_features/nested_playbooks.yml) is a better example. It makes it clear that the full file name is used, and a single filename, as opposed to a YAML list. The old version, it was not clear if 'list_of_plays' was an *example* or a *variable*.
2017-03-16 11:54:27 -07:00
Brian Coca
001be55ef0 corrected with_dict example
fixes #17636
2017-03-16 10:13:51 -04:00
Brian Coca
dd8d699981 namespace facts (#18445)
* namespace facts

always namespace facts, make the polluting of 'main' conditional on config

* updated to 2.4

* Update intro_configuration.rst
2017-03-15 17:12:16 -07:00
Dylan Silva
9dae697997 Updates to docs for metadata. (#22667)
* Updates to docs for metadata.

* Update developing_modules_documenting.rst
2017-03-15 15:34:00 -07:00
Brian Coca
0c44959800 added new tests any and all (#22665)
* added new tests any and all

* updated code names
2017-03-15 18:09:25 -04:00
Brian Coca
b059a95714 2nd draft 2017-03-15 15:32:30 -04:00
Brian Coca
7cf16588e8 draft playbook path docs 2017-03-15 15:32:30 -04:00
Brian Coca
b606bcec04 Doc directives (#22524)
* draft docs for directives

* updated to document directives
2017-03-15 11:29:58 -04:00
Toshio Kuratomi
eb1214baad New metadata 1.0 (#22587)
Changes to the metadata format were approved here:
https://github.com/ansible/proposals/issues/54
* Update documentation to the new metadata format
* Changes to metadata-tool to account for new metadata
  * Add GPL license header
  * Add upgrade subcommand to upgrade metadata version
  * Change default metadata to the new format
  * Fix exclusion of non-modules from the metadata report
* Fix ansible-doc for new module metadata
* Exclude metadata version from ansible-doc output
* Fix website docs generation for the new metadata
* Update metadata schema in valiate-modules test
* Update the metadata in all modules to the new version
2017-03-14 09:07:22 -07:00
John R Barker
04e816e13b Stricter module documentation validation (#22353)
Raise the bar for module `DOCUMENTAION`
This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files

**Validation**
* Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files)
* Use `suboptions` to document complex options 
* Validate module name
* Validate deprecated modules have correct ANSIBLE_METADATA

**Module Documentation Generation**
* Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718
* Tidy up HTML generation (valid HTML, no empty lists, etc)
 
**Documentation**
* Clarify the steps for deprecating a module
* Use correct RST headings
* Document `suboptions:` (options)
* Document `contains:` (returns)


**Details**
The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules

Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718

The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to:
* Raise the bar for new modules in 2.4
* Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward.
2017-03-13 19:49:27 +00:00
Jason McKerr
1132f17d2c Update ROADMAP_2_3.rst 2017-03-13 14:01:14 -04:00
Artem Zinenko
990aa73ed8 Fix bug in 'Building A Simple Module' doc (#22447) 2017-03-10 08:43:45 -05:00
Ryan Brown
000ca2a2bc Update roadmap for Amazon Modules 2017-03-09 10:37:55 -05:00
fhiyo
0f82674c0e Add document about connecting to localhost (#20534)
* Add document about connecting to localhost

* Update intro_getting_started.rst

* Update intro_getting_started.rst

Edited.

* Added description about ansible_python_interpreter
2017-03-08 19:45:23 -08:00
Harlan Lieberman-Berg
e24ddb4980 Add manpage for ansible-console. (Closes: #16244) (#16245)
* Add manpage for ansible-console. (Closes: #16244)

* Mark host as an optional field in ansible-console.1
2017-03-08 11:04:35 -05:00
John R Barker
3fa5c55182 Fix docs type (#22405)
Fix docs typo
2017-03-08 13:42:42 +00:00
Brian Coca
71c7220e45 fixed ungrouped definition 2017-03-07 12:50:35 -05:00
Aric Renzo
96538ec158 Standardizing syntax for 'Playbook Loops' documentation (#20863) 2017-03-06 14:39:07 -08:00
John R Barker
3afb67e9b2 Fix Docs build issues (#22295)
* restore network docs fragments

* Fix RST errors

* code-block formatting
2017-03-05 11:41:29 +00:00
Chris Tooley
6c2585f0c8 Add some additional value quoting examples (#20464)
The existing examples in the "Gotchas" section were rather simple. Expanded upon those to add some additional clarity around how the quoting in YAML works.
2017-03-05 01:27:54 -08:00
Joona Somerkivi
df07866e8f Added example of referring to AWS-credentials (#21560)
* Added example of referring to AWS-credentials

.. when they're stored in variables. Spent few hours trying to figure out why credentials from vault/variables were not used.

* Update guide_aws.rst

Edited for grammar.
2017-03-05 01:25:39 -08:00
Pilou
addedb12cf Inventory default groups 'all' and 'ungrouped': add tests and documentation (#21728)
* inventory: test 'all' & 'ungrouped' groups created by default

* Mention default groups 'all' & 'ungrouped'

* Update intro_inventory.rst

Minor grammatical edit.
2017-03-05 01:24:41 -08:00
Adam Johnson
d01ac3a019 doc: Document --syntax-check flag for ansible-playbook (#22256)
It wasn't previously documented outside of the help / manpage, which made it less discoverable.
2017-03-04 11:11:41 -08:00
Marko Stanković
10125d520d Improve YAMLSyntax/Gotchas (#21575)
* Improve YAMLSyntax/Gotchas

Colons don't need to be quoted unless when followed by a space or the end of the line

* Update YAMLSyntax.rst

Minor edit.
2017-03-03 12:49:03 -08:00
Jeff Gibson
5cccb7a5d7 ansible_winrm_kerberos_delegation (#22113)
Add a note of how to turn on delegation when using kerberos.
2017-03-03 09:51:40 +00:00
Alan Rominger
d542f069ef Update dead support link (#22212)
* Update dead support link

Visit https://www.ansible.com/, and you'll find the support link points to this URL, https://access.redhat.com/products/ansible-tower-red-hat/.

The current link is a dead link.

* update github code blocks link
2017-03-02 23:29:19 -08:00
Mark Janssen
73a7483803 Update documentation for passwordstore lookup (#21448)
* Update documentation for passwordstore lookup

* Style fixes

* Style fixes

* Reword introduction text

* Update playbooks_lookups.rst

Minor tweaks.
2017-03-02 22:23:49 -08:00
Andrea Tartaglia
10a260c622 Clarified when control_path is ignored (#20968) 2017-03-02 22:22:33 -08:00
Chris Alfonso
b2a10e6e4b Bumping docs footer copyright year (#22210) 2017-03-02 22:15:19 -08:00
James Cammarata
a2599cab79 Fix variable precedence of INI/script vars to be in-line with docs.
This commit also adds a new test script (ansible-var-precedence-check.py in code-smell/)
to provide us with another line of defense against precedence bugs going forward.

The precedence docs state that the INI vars have a lower precedence than group/host
vars files for inventory and playbooks, however that has not been the case since 2.0
was released. This change fixes that in one way, though not exactly as the docs say.
The rules are:

1) INI/script < inventory dir < playbook dir
2) "all" group vars < other group_vars < host_vars

So the new order will be (from the test script mentioned above):

8. pb_host_vars_file - var in playbook/host_vars/host
9. ini_host_vars_file - var in inventory/host_vars/host
10. ini_host - host var inside the ini
11. pb_group_vars_file_child - var in playbook/group_vars/child
12. ini_group_vars_file_child - var in inventory/group_vars/child
13. pb_group_vars_file_parent - var in playbook/group_vars/parent
14. ini_group_vars_file_parent - var in inventory/group_vars/parent
15. pb_group_vars_file_all - var in playbook/group_vars/all
16. ini_group_vars_file_all - var in inventory/group_vars/all
17. ini_child - child group var inside the ini
18. ini_parent - parent group var inside the ini
19. ini_all - all group var inside the ini

Fixes #21845
2017-03-02 17:07:00 -06:00
Chris Houseknecht
d20d528dbd Adds --role-skeleton to ansible-galaxy man page (#22199) 2017-03-02 12:10:38 -05:00
Dag Wieers
98b978d1d1 Clarify what modules are available for Windows (#21888)
Remove repeated mentions of an incorrect list.

This fixes #20696
2017-03-01 22:09:10 -08:00
Matt Davis
c98647ccf8 initial commit of win_domain module (#22179) 2017-03-01 17:49:15 -08:00
azenk
bdf0ab451e Add role skeleton support (#17079)
* Add role skeleton support

The default role skeleton used by ansible-galaxy is good, but it doesn't
allow organizations to customize it to suit their needs.  This patch
addresses that by adding the option to point ansible-galaxy at a
role skeleton directory.  The contents of this directory are then
copied (or rendered) into the output role directory.  Appropriate
command line options and configuration entries are added to allow for
further customization from the role skeleton.

* Remove dependency on platforms list from test

Platforms are no longer provided to the template by galaxy init.
Removing the code in our test meta/main.yml template that relied on it.

* Fix whitespace issue
2017-03-01 20:23:18 -05:00
scottb
0bd2714122 Update playbooks_variables.rst
Minor edits
2017-03-01 13:18:12 -05:00
Brian Coca
cf3edf0989 more examples and clearer override docs for conn
fixes #21866
2017-03-01 13:18:12 -05:00
Micah Abbott
6ea4e9f17f docks: add missing colon character
Without the missing colon character, the code block that followed
wasn't rendering properly.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
2017-03-01 08:26:30 -08:00
Brian Coca
bfb3467d52 more set/list stuff 2017-02-28 10:44:20 -05:00
Patrick Gagnon-Renaud
d6b40c935f Fix Passlib example in FAQ (#21997)
* Fixes passlib example in FAQ to reduce the number of rounds to 5000

As stated in issue #15326, the default number for glibc is 5000, where
the default for passlib is 656000.

I actually found out when I spend few hours trying to understand why
ansible was taking almost x3 the time to run a playbook when using a
user with sudo and password (comparared to sudo with NOPASSWD set).
Well, it was because the user was created using ansible and the passlib
example found in the docs' FAQ.

Reducing the numbers of rounds to 5000 will ensure a better experience
with ansible for newcomers when using sudo with a password.

* Fixes passlib example in FAQ to reflect the API changes in passlib 1.7

Method encrypt() was deprecated in 1.7 and renamed to hash(), which
happened almost a year ago.

https://passlib.readthedocs.io/en/stable/lib/passlib.ifc.html#passlib.ifc.PasswordHash.encrypt
2017-02-27 10:14:02 -05:00
Toshio Kuratomi
9d85d81ed0 Make the metadata docs agree with what's currently implemented 2017-02-27 09:27:00 -05:00
Wouter
5d39056379 Correct link in documentation (#21894)
Fixes #20692
2017-02-24 22:37:13 +00:00
John R Barker
fdd03916a3 Document ANSIBLE_METADATA (#21250)
* Document ANSIBLE_METADATA

* Formatting

* Reive feedback - WIP

* notes about Declarative

* fix headings

* Use field lists

* typo

* review feedback

* Imports

* typo

* Toshio's feedback
2017-02-24 20:31:58 +00:00
jhawkesworth
d0278d1d1e [WIP] documentation: Remove assemble from list of windows modules, plus tweaks (#21859)
* Remove assemble from list of windows modules, but advise you can delegate appropriate modules to localhost.  Try to fix list of usable on windows modules to appear as a list instead of on one line.

* Update intro_windows.rst

Minor edit
2017-02-24 13:30:12 +00:00
Daniel
d18bb96e88 Make pull-request sentence less ambiguous (#21802) 2017-02-22 17:52:41 -08:00
John R Barker
48c6dd2689 Point to cloud/amazon/GUIDELINES.md in main repo (#21780) 2017-02-22 15:31:06 +00:00
Matt Davis
67f74bbc81 CHANGELOG/roadmap updates for Windows 2017-02-17 00:10:17 -08:00
Robin Schneider
3700bcb6dd Use HTTPS instead of legacy HTTP for ansible.com (#16870)
Mechanical edit done by this "one-liner":

```Shell
git ls-files -z "$(git rev-parse --show-toplevel)" | xargs --null -I '{}' find '{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#http://(www\.|galaxy\.|)ansible\.com#https://\1ansible.com#g;'
```

Related to: https://github.com/ansible/ansible/issues/16869
2017-02-15 16:09:33 -08:00
Michael Scherer
6fae1d2bbf Make password lookup treat /dev/null as a special case
I have from time to time a need of random password without
wanting to write them down (one example is mailman list creation,
that requires a password to be given to be sent to the list owner).

But using /dev/null do not return null, but the empty string, which
doesn't generate a password at all and so do not achieve my use case.
2017-02-15 12:15:09 -08:00
Toshio Kuratomi
d7b7cbac1a Move to using a requirements.txt to install the python packages. (#21430)
Move to using a requirements.txt to install the python packages.

This makes it easy to keep the documentation and actual package
dependencies in sync.

Fixes #18453
2017-02-15 06:58:09 -08:00
John R Barker
53ac312382 validate-modules --arg-spec (#21331)
* validate-modules --arg-spec

* Update developing_modules_documenting.rst

* Never mock out ansible or ansible.module_utils

* No more false positives
2017-02-15 08:09:08 +00:00
Vlad Dm
32b92b53b0 service state typo 2017-02-14 10:47:37 -05:00
Pilou
f2c22109fb Don't mix deprecations messages with warnings messages (#21337)
* Remove unused attribute '_passthrough'

* Don't mix deprecations with warnings

* Return values: add 'deprecations' key used internally

* 'deprecations' and 'warnings' return values: add tests
2017-02-13 23:49:39 -05:00
Peter Sprygada
58fa0bc1ea 2.3 roadmap updates for networking 2017-02-13 20:50:15 -05:00
John R Barker
0edda106f1 Delete link to test-network-modules (#21347) 2017-02-13 18:25:15 +00:00
Dylan Silva
8bf69411d9 Updated wording around support for different modules 2017-02-13 09:40:22 -05:00
927589452
a6cb377420 removed empty shell block (#21309) 2017-02-12 11:52:05 -08:00
Jeffrey Cafferata
4d0b62ede7 Update playbooks_best_practices.rst (#21288)
Updated the GitHub examples directory URL.
2017-02-12 00:01:43 -08:00
John R Barker
cd6792a058 Docs partner checklist (bulk modules) (#20794)
* WIP Partners guide for adding multiple modules

* WIP

* WIP

* WIP

* WIP

* WIP

* HACK

* Revert hack

* Brian's feedback

* Remove squash notes

* Minor tidyups

* Unit & Integration tests (& minor tweaks)

* Details about Unit tests
* As we are about to feature freeze on Ansible 2.3 remove the notes about Ansible 2.4 and py2.4.
* Module names should be in the singular

* Scot & Dylan's feedback

* 5 PRs at once. Remove FIXMEs

* Formatting

* How to use Git & GitHub

* directories are in category & topic

* Expectations of Module authors

* Better wording for module author's responsibilities
2017-02-10 14:02:24 -08:00
John R Barker
959637ff59 How to document your module (#21021)
* How to document your module

* Remove blank lines

* note:: Versions should be strings

* requirements on the host that executes the module.

* option names & option values

* Feedback

* formatting

* Scott's final feedback
2017-02-10 12:15:55 +00:00
Craig Francis
2ccedc2ed9 Correct links to modules source code (#20650)
As per issue #20647, the modules are now in the main Ansible repository.
2017-02-10 00:37:25 -08:00
Pavlo Shchelokovskyy
6e875e81aa Fix docs re inventory_ignore_extensions config (#21132)
The list of ignored by default extensions is outdated in doc for dynamic
inventories, and this option is completely missing from configuration
file overview.
2017-02-10 00:32:22 -08:00
927589452
19df0e0bf5 removed a typo (#21153)
* removed a type

doubled half sentence at the end removed

* Update intro_configuration.rst

Minor wording tweak.
2017-02-10 00:25:50 -08:00
Damien
b71a62283c New Module : aos_ip_pool as part of network/aos (#21044)
* Initial version of aos_ip_pool module

* Add examples for IP Pool

* Break down ip_pool into smaller function

* Refactor do_load_resource

* Add get_display_name_from_file

* Add ‘src’ as an option to load ip pool from JSON file

* Rename directory network/apstra to network/aos

* Remove exception handling temporary

* Remove all ‘Exception as XX’ to be python 2.4 compatible

* Replace ‘== False’ with ‘is False’ for PEP8 Test

* Update documentation to be Yaml compatible

* Lisg all method imported from module_utils.aos

* Refactor to align with collection.find() changes

* Update examples by @gundalow’s  recommendations

* Update Documentation per @gundalow’s recommendations

* Change the license per @gundalow recommendation

* Add exception handling for get_aos_session

* Change Auth format and add check_aos_version() to check minimum version

* Add a check for minimum version

* Refactor ‘src’ into ‘content’ to allow more options
Remove get_display_name_from_file in aos.py
Add content_to_dict in aos.py

* Fix variable name in do_load_resource

* Add mention of aos.py in module_utilities doc

* Add try/except for import yaml

* Add try/Except around main block of code and function

* Refactor to auto detect content_format, update doc accordingly

* Change create_new_ip_pool inputs

* Remove unused import

* Remove in_use as it’s never used

* Fix doc format

* Add version number in requirement doc
2017-02-09 22:22:56 +00:00
Dylan Silva
719b1fecfc [WIP] Added in bullet of Python 2.4+2.5 support discontinuation (#19264)
* Added in bullet of Python 2.4+ support discontinuation

* Update ROADMAP_2_4.rst

* Update ROADMAP_2_4.rst
2017-02-09 15:57:00 +00:00
Jordan Borean
719e1840da Added info on ntlm and credssp, updated configure script for credssp (#21175) 2017-02-08 17:00:58 -08:00
Brian Coca
5f29117e59 become options dont qualify as new anymore 2017-02-08 11:51:15 -05:00
Toshio Kuratomi
a3eab4fc48 Add 2.3.0 entries for module_utils via pluginloader, selectors, and py3 (#21019)
* Add 2.3.0 entries for module_utils via pluginloader, selectors, and py3

* Add roadmap-2.3 updates and an item for roadmap-2.4
2017-02-07 15:27:14 -08:00
bverschueren
3b64bff7a5 fix missing ident in provider dict assignment (#21089)
Thanks @bverschueren!
2017-02-07 10:54:49 -08:00
John R Barker
9ddc94d0e9 Update ROADMAP_2_3.rst 2017-02-07 18:47:36 +00:00
Matt Davis
764e1cc630 update azure roadmap items 2017-02-07 10:09:12 -08:00
John R Barker
54a2be9e2e formatting 2017-02-07 16:35:32 +00:00
Adrian Likins
a5d3b186ba update ansible-ssh in roadmap 2017-02-07 11:27:45 -05:00
John R Barker
965fe80f1a formatting 2017-02-07 16:27:01 +00:00
Jason McKerr
6a6f13a5bd Update ROADMAP_2_3.rst 2017-02-07 11:20:14 -05:00
Jason McKerr
64a3c8f9de Update ROADMAP_2_3.rst 2017-02-07 11:19:26 -05:00
Jason McKerr
31fbc6e203 Update ROADMAP_2_3.rst 2017-02-07 11:18:27 -05:00
Ryan Brown
0de96d68f6 Update roadmap for cloud work 2017-02-07 10:44:29 -05:00
John R Barker
b773b99136 developing_module status 2017-02-07 15:12:19 +00:00
Jiri Tyr
5d9dd5934a Making the decoration more clear (#20931) 2017-02-07 11:07:41 +00:00
Matt Clay
22db51f15c Update Testing and CI section of 2.3 roadmap. 2017-02-06 16:28:56 -08:00
Brian Coca
a2c38c47aa added docs for vault and made trigger shorter: !vault (#20985)
* added docs for vault and made trigger shorter: !vault

* added single var valuting

* Update playbooks_vault.rst

Edit pass for spelling and grammar. Ship it!

* Update playbooks_vault.rst

Typo fixes.
2017-02-03 15:28:50 -05:00
Adrian Likins
9703b0ff39 Add 'Improve testing of setup.py/facts.py' to 2.4 roadmap 2017-02-03 15:20:35 -05:00
John R Barker
b038aad173 make webdocs speedup is done 2017-02-03 19:13:04 +00:00
Toshio Kuratomi
1df7d95cec Module utils default path (#20913)
* Make the module_utils path configurable
* Add a config value to define the path site module_utils files
* Handle module_utils that do not have source as an error
* Make an integration test for module_utils envvar working
* Add documentation for the ANSIBLE_MODULE_UTILS config option/envvar
* Add it to the sample ansible.cfg
* Add it to intro_configuration.
* Also modify intro_configuration to place envvars on equal footing with
  the config options (will need to document the envvar names in the
  future)
* Also add the ANSIBLE_LIBRARY use case from
  https://github.com/ansible/ansible/issues/15432 so we can close out
  that bug.
2017-02-02 17:48:53 -08:00
rektide
1df14ed121 Update loop docs to also describe register:'s value when inside loop. (#20991) 2017-02-02 15:02:28 -08:00
John R Barker
8d5f4dda06 Roadmap is draft (#20970)
The keyword is "draft",  not "final".
2017-02-02 12:00:39 +01:00
Brian Coca
114ef96572 added example keyring looukp 2017-01-31 17:50:09 -05:00
Scott Butler
a002dca42d Edited for grammar, punctuation and spelling 2017-01-31 12:44:23 -08:00
Sebastian
a8c038383e Update intro_installation.rst (#20854)
Added command to install the repository key to prevent errors
2017-01-31 11:58:23 -08:00
Albert Mikaelyan
b89f222028 Some better explanation to release cycle 2017-01-31 12:36:42 -05:00
John R Barker
9bc4a12ae5 No more split repos (#20804)
* All bugs go to into `ansible/ansible`
* Issue template is automatically added when raising a new issue, so no manual steps needed
2017-01-29 13:04:10 -08:00
Matt Clay
10d9318de7 PEP 8 indent cleanup. (#20800)
* PEP 8 E121 cleanup.

* PEP 8 E126 cleanup.

* PEP 8 E122 cleanup.
2017-01-29 07:28:53 +00:00
Matt Clay
d913f69ba1 PEP 8 W291 whitespace cleanup. 2017-01-27 17:08:02 -08:00
scottb
13fc909058 Refurbish developing modules content - stage 1 (#20673)
* Revamping module development docs - work in progress

* Refurb of developing modules content continues.

* Developing modules refurb work continues

* Continued refurb of developing modules content. Work-in-progress.

* Ibid

* Dev guide content refurb continues - WIP

* Ibid.

* Removed reference to old extras module repo

* Tweaks

* Removed some non-intro material; added link to github module PRs.

* Incorporated review feedback from @gundalow and @tkuratomi; fixed some links; renamed '*contributing' to '*checklist'
2017-01-27 14:03:26 -08:00
pietro
8c3b915721 Fix versionadded on math filters section (#20674)
Extra character was breaking the rendering of the file.
2017-01-26 13:41:30 -05:00
Brian Coca
af59781b56 removed core/extras ref from module pages
fixes #20647
2017-01-25 11:45:23 -05:00
Brian Coca
e5f7a22215 clarified tag usage 2017-01-25 10:52:07 -05:00
Sumit Kumar
9283772e54 Add doc_fragment and module util for NetApp platforms (#19607)
* Add doc_fragment and module util for NetApp platforms

* Make requested changes

* Fix links and change formatting.

* Fix description sections.
2017-01-25 09:51:57 +00:00
Matt Davis
06353c055a winrm managed kinit (#20416) 2017-01-24 15:04:11 -08:00
Brian Coca
9db1cfebbc docs fixes
fixed version number
updated C year
2017-01-24 15:11:11 -05:00
Jonathan Sabo
6a6fb28af5 Updating credstash link to the new link (#20598)
We changed the name of the github repo awhile back and I noticed it was out of date in the docs.
2017-01-24 12:30:22 -05:00
Adrian Likins
d7615f68c4 Docs cleanup (#20517)
* build-site.py is no longer used, remove

Replacement is using the standard sphinx-build script.
Makefiles already use that, but standalone use of
build-site.py is no longer needed.

* build.sh no longer used in docs build
2017-01-20 13:12:19 -05:00
Brian Coca
216e2c8813 leaving os immediate 2017-01-19 23:11:53 -05:00
Brian Coca
0803c638bb set cpus only if not set already 2017-01-19 23:09:55 -05:00
Brian Coca
c95bd7d9b0 fixed escape again 2017-01-19 23:08:01 -05:00
Toshio Kuratomi
e7505220d4 Need to define the OS variable at this level too 2017-01-19 19:53:29 -08:00
Brian Coca
2a5d949c52 corrected path to edit docs on devel to new loc
fixes #20474
2017-01-19 14:01:18 -05:00
Will Thames
75a7ebe900 Deprecate ec2_vpc module (#20344)
* Deprecate ec2_vpc module

The deprecation of ec2_vpc module has been discussed for
2 years and is causing duplication of effort as changes
are implemented for ec2_vpc rather than for the newer
alternatives

* Improve module deprecation documentation

Update the developing modules documentation with the latest
instructions on how to deprecate a module.
2017-01-19 11:25:28 +00:00
Brian Coca
339312a6b4 added missing file to cleanup 2017-01-18 14:34:01 -05:00
Brian Coca
e2a871b49e corrected which app adds plugins 2017-01-18 14:14:28 -05:00
Brian Coca
712be24a74 Doc fixes (#20353)
* cleanup to reflect current builds

* consolidate templating docs and minor rewording

* new templating intro page

* fixed warnings as per feedback

* Update playbooks_filters.rst

Edited for clarity.

* Update playbooks_templating.rst

Light edits
2017-01-17 18:55:03 -08:00
Sascha Vogt
abe46dd75f Fix double colon which fixes block rendering
the 'EXPORT ANSIBLE_NOCOWS=1' rendering is broken due to a double colon in the paragraph above
2017-01-17 10:25:15 -05:00
Klaus Ethgen
ae57b95313 Documentation fix (#20198) 2017-01-17 01:25:53 -08:00
Brian Coca
c129fd7c81 added clarification on directives/blocks 2017-01-16 11:01:55 -05:00
Brian Coca
497347d600 fixed phrasing on 0 being non error 2017-01-13 20:55:45 -05:00
Adrian Likins
960be799fd Use correct path for docsite src (rst/) 2017-01-13 18:14:33 -05:00
Adrian Likins
3645893a5b update path to _themes 2017-01-13 18:14:33 -05:00
Scott Butler
1c8b85a6f1 Added support statement for older releases. 2017-01-13 11:59:16 -08:00
Adrian Likins
a560a2d512 Use portable CPUS detect for docsite make default.
Some folks run 'make webdocs' from docs/docsite, so
use the portable CPUS detections as the default here as
well.
2017-01-13 14:41:14 -05:00
Adrian Likins
b3e7794c08 Fix docs/api paths so api docs build (#20240)
Add a 'webdocs' target to docs/api to be consistent
with docsite/
2017-01-13 14:35:37 -05:00
Adrian Likins
0381bc170c Docsite sphinx rm buildsite (and speed up docs build) (#20237)
Replace docs build-site.py with default-ish sphinx build

This seems to speed up docsite build _alot_. 

The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes.

The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j'
2017-01-13 14:32:27 -05:00
Bernie Schelberg
2b4afd23eb Update docker example on Inventory page (#20209)
The docker module has been deprecated, so the example should be
updated to use the newer docker_container module.
2017-01-12 18:57:27 -08:00
Brian Coca
4b3977d5af added note about custom modules/plugins in roles 2017-01-12 20:15:09 -05:00
Brian Coca
2538383cf4 updated docs to make clear new option scope
this does not affect user tasks with `setup`
2017-01-12 10:53:24 -05:00
Alvaro Aleman
1b2ad94496 Configurable fact path (#18147)
* Make fact_path configurable

* Add docs for fact_path

* Add tests for localfacts

* Default fact gathering settings in PlayContext
2017-01-12 10:49:04 -05:00
Toshio Kuratomi
eeebd51f21 Rename the type filter to type_debug
Because we add the names of all filters to the callable whitelist used
by safe_eval, adding a filter named type makes it so code calling "type()"
gets eval'd.  We can't think of a way to exploit this but it's
sufficiently sketchy that we're renaming it in case someone smarter than
us can think of a problem.
2017-01-11 14:48:21 -08:00
Dag Wieers
de21038feb Enable -Verbose and log to EventLog (#19909)
Instead of asking the user to type something prior to running the script, why not allow -Verbose on the command line directly.
Also log important events to EventLog, so that it can be traced e.g. when running via RunOnce mechanism.

The documentation is updated as well.
2017-01-10 23:52:41 -08:00
scottb
745219d200 Update playbooks_lookups.rst
Edited.
2017-01-10 16:19:22 -05:00
Brian Coca
f9f99ddfbc updated docs to suggest quote filter for shells
Also changed comments into -name in examples where appropriate.
2017-01-10 16:19:22 -05:00
Brian Coca
3c4afd0470 Doc module meta (#20093)
* updated module docs to reflect unification/meta

* new doc page

* also remove module refs to old core/extra

* Update modules_support.rst

Light edit.
2017-01-10 12:58:22 -08:00
Jasper Lievisse Adriaanse
073c4df790 Update references to Passlib as homepage/docsite moved (#20082) 2017-01-10 13:17:32 +00:00
Brian Coca
54800ea47c better sections for module return docs 2017-01-09 20:18:30 -05:00
Brian Coca
0aad46c85b corrected common headers 2017-01-09 15:54:45 -05:00
Ryan Brown
a2b4ad9da0 (docs) Remove/update mentions of git submodule in docs and error me… (#19941)
* (docs) Remove/update mentions of `git submodule` in docs and error messages.

* Remove parenthetical per @dharmabumstead
2017-01-09 12:11:39 -05:00
Toshio Kuratomi
08d6990e67 Fix code-blocks to use correct syntax highlighting 2017-01-08 09:18:45 -08:00
Toshio Kuratomi
adb7426c0c Some more code-block fixes 2017-01-07 11:47:35 -08:00
John R Barker
7df31aaca1 Fix all RST errors for docs/docsite/rst (#20005)
* developing_modules.rst is now in dev_guide, sync changes and delete the old version
* Cleaner RST & formatted code
* Tidyup roadmaps
* Link to repomerge
* Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1
* Clean docsite/rst (apart from ROADMAP
2017-01-07 11:38:52 -08:00
Brian Coca
3b2a4c1955 fixed porting guide headers 2017-01-06 15:50:32 -05:00
Toshio Kuratomi
1be3ac36df Fix block highlighting
Found out that we change the default highlighting to yaml.
So explicitly mark python code blocks as such.
2017-01-06 12:37:51 -08:00
John R Barker
ebc8b927ce Fix RST Errors 2017-01-06 19:45:47 +00:00
Rodolfo Carvalho
8f3c435b27 Fix path to test plugin examples 2017-01-06 11:41:15 -05:00
Brian Coca
d108a6f0fc fixed webdoc generation 2017-01-06 11:23:29 -05:00
Brian Coca
57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
2017-01-06 09:16:59 -05:00
Carlos E. Garcia
0b8011436d minor spelling changes 2016-12-13 13:51:13 -05:00
Samuel Boucher
b17149f3bf Update ansible.1.asciidoc.in (#18464)
* Update ansible.1.asciidoc.in

fix typo to match ansible --help
--su-user and not --se-user

* Update ansible.1.asciidoc.in
2016-11-11 08:58:19 -05:00
Chris Houseknecht
dceb2a0393 Remove extra display statements and add docs (#18229)
* Add docs for ansible-galaxy import --role-name option.

* Add docs for ansible-galaxy init --container-enabled option.
2016-10-28 00:38:39 -04:00
Brian Coca
db8c952ee3 added new ksu method to man page
removed runas refrences, because it was never implemented
2016-09-13 14:40:41 -04:00
Adrian Likins
6fdd8c4a98 Fix the doctype attribute in man page asciidocs (#16696)
The asciidoc.in sources had an attribute like:

:doctype:manpage

That attribute was not being correctly rendered in a2x
resulting in the 'doctype:manpage' showing up in a spurious
additional AUTHOR section at the end of the generated man pages like:

AUTHOR
       :doctype:manpage

Fix with correct formatting of 'doctype' attribute.
2016-07-29 15:59:35 -04:00
Andrew Gaffney
4fd87f2dc6 Fix typo on -K/--ask-become-pass option in 'ansible' man page (#16667) 2016-07-11 00:15:05 +02:00
Shota
47f715fb37 Fix some typos (#16498) 2016-06-29 14:31:25 -04:00
Brian Coca
dae0b833f5 updated man page with new pull options 2016-06-23 09:14:55 -04:00
Scott Radvan
72ca3b2b5b add very minor punctuation fixes (#15763) 2016-05-09 10:12:24 -04:00
Brian Coca
e0573d3099 make vi the default editor if no EDITOR
fixes #15577
2016-05-03 09:39:19 -04:00