Commit Graph

2778 Commits (b6566d26dfe768857d75041552885fcdbd7dbd2a)

Author SHA1 Message Date
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
8 years ago
Brian Coca 033fe5548b added epub entry for makefile 8 years ago
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
8 years ago
John R Barker 8733253a76 Minor testing docs improvements (#24103)
Fix a few formatting issues spotted post review.
Also reapply missing commit
8 years ago
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
8 years ago
Strahinja Kustudic 66a41f59fd Add a missing leading zero in a mode parameter
600 is an incorrect mode, because mode needs to be octal.
8 years ago
Strahinja Kustudic 6dddd5b167 Remove action keyword from do-until example
`action:` is old and not needed any more.
8 years ago
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
8 years ago
scottb 946658cd24 Update playbooks_python_version.rst
Minor edits
8 years ago
Toshio Kuratomi 78dd3496e2 Update version and change remove files from pep8 blacklist 8 years ago
Toshio Kuratomi 82ad8ff081 Add documentation of Jinja2 templating idioms that differ when run under Python3
Fixes #19514
8 years ago
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
8 years ago
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
8 years ago
David Mahler 09b247dd34 Minor grammatical corrections and improvements (#23886) 8 years ago
Brian Coca 3358abcf49 Add a new filter: strftime. Use the well known function to format a date output. (#23832)
(cherry picked from commit 3f5b304fc2)
rebased for @yannig
8 years ago
Eric Anderson 6aab341248 changed code block formatting to match format (#23615) 8 years ago
Adam Johnson f1c4b434cd Tidy example inventories in "Developing Dynamic Inventory Sources" (#18758)
Thanks @adamchainz!
8 years ago
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
8 years ago
Alexander Gubin d04a5246de Fix example fact(ansible_default_ipv4.address) for delegated_facts 8 years ago
John R Barker 33d7c12a97 Improve network debug wording (#23735) 8 years ago
Ian Levesque acd1dd8df1 Add ssh_connection / retries option documentation (#23463)
No docs were included when https://github.com/ansible/ansible/pull/9927 was merged.
8 years ago
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
8 years ago
Scott Butler 087159c4cd Switch Adobe tracking off staging. 8 years ago
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.
8 years ago
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.
8 years ago
John R Barker 729b0e3bee Use exports (#23542) 8 years ago
Brett Cannon ece2aa2d5f Fix reST markup (#23536) 8 years ago
John R Barker e575eae2ec Document how to debug network issues (#23503) 8 years ago
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
8 years ago
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.
8 years ago
John R Barker 01e27b1083 Typo 8 years ago
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
8 years ago
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.
8 years ago
Brian Coca 2c9543e0b7 made example not fail
fixes #23180
8 years ago
Scott Butler 5591d639f5 Fixed broken link. 8 years ago
Brian Coca 06e0b00035 fixed notation on entries, meant literal not italic 8 years ago
Brian Coca 42383656e7 using prefered format
(cherry picked from commit a78a0caf10e08200ef3dc82c4b78feeecef0d063)
8 years ago
John R Barker 22fe148ca5 Formatting of bullet points 8 years ago
Brian Coca a0a26700c9 remove author as it dupes 8 years ago
Brian Coca da045a9c1f more info for asciidoc to correctly build manpages 8 years ago
Toshio Kuratomi 0249918c7b When outputting text to a file, convert to bytes first.
Fixes #23137
8 years ago
Jerry Wardlow 8f4652ab2f Corrects typo in `inventory_ignore_extensions` (#23099)
Corrects a typo from 'Coma-separated' to 'Comma-separated'
8 years ago
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
8 years ago
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.
8 years ago
John R Barker 6c101087ac RST Code should be ``--tags`` fixes 22717 (#23074) 8 years ago
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
8 years ago
Chris Houseknecht d2ea851d09 Adds k8s_common.py (#22899) 8 years ago
Toshio Kuratomi d8f86fa4d2 A couple more places where compat.six was used converted to module_utils.six (#22976) 8 years ago
Brian Coca 2a2e02aea4 .--. . .--. ---.. / .. ... / .- -. -. --- -.-- .. -. --. 8 years ago
Brian Coca 18a7a1ec31 added docs to CLI docstringsadded
removed 'now intermediate build files' from repo
adjusted gitignore
8 years ago
Brian Coca 424e1946f4 moved docs generation and templates to docs/ 8 years ago
Brian Coca b4c47ebf68 draft to generate man pages 8 years ago
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.
8 years ago
Brian Coca 6b8347ec60 updated doc man page 8 years ago
scottb fb48c45adf Added Adobe DTM tracking. (#22889) 8 years ago
Brian Coca a04dd375eb adjusted home examples to actual value 8 years ago
Brian Coca a36c66023f updated remote_tmp example 8 years ago
Brian Coca a1a5a2b1de fixed passwordstore lookup examples
plugin was renamed before acceptance, but examples kept original name
fixes #22735
8 years ago
Dag Wieers c254618d4f Improve test docs a bit more 8 years ago
Brian Coca 94b269b2ec documented some more keywords 8 years ago
Benjamin dc68503ef2 Update link URL to OpenStack documentation (#22776) 8 years ago
Bradford Dabbs 2472a4587e Flip setenforce boolean (#22752)
* Flip setenforce boolean

* Update example task name
8 years ago
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
8 years ago
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.
8 years ago
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*.
8 years ago
Brian Coca 001be55ef0 corrected with_dict example
fixes #17636
8 years ago
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
8 years ago
Dylan Silva 9dae697997 Updates to docs for metadata. (#22667)
* Updates to docs for metadata.

* Update developing_modules_documenting.rst
8 years ago
Brian Coca 0c44959800 added new tests any and all (#22665)
* added new tests any and all

* updated code names
8 years ago
Brian Coca b059a95714 2nd draft 8 years ago
Brian Coca 7cf16588e8 draft playbook path docs 8 years ago
Brian Coca b606bcec04 Doc directives (#22524)
* draft docs for directives

* updated to document directives
8 years ago
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
8 years ago
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.
8 years ago
Jason McKerr 1132f17d2c Update ROADMAP_2_3.rst 8 years ago
Artem Zinenko 990aa73ed8 Fix bug in 'Building A Simple Module' doc (#22447) 8 years ago
Ryan Brown 000ca2a2bc Update roadmap for Amazon Modules 8 years ago
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
8 years ago
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
8 years ago
John R Barker 3fa5c55182 Fix docs type (#22405)
Fix docs typo
8 years ago
Brian Coca 71c7220e45 fixed ungrouped definition 8 years ago
Aric Renzo 96538ec158 Standardizing syntax for 'Playbook Loops' documentation (#20863) 8 years ago
John R Barker 3afb67e9b2 Fix Docs build issues (#22295)
* restore network docs fragments

* Fix RST errors

* code-block formatting
8 years ago
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.
8 years ago
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.
8 years ago
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.
8 years ago
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.
8 years ago
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.
8 years ago
Jeff Gibson 5cccb7a5d7 ansible_winrm_kerberos_delegation (#22113)
Add a note of how to turn on delegation when using kerberos.
8 years ago
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
8 years ago
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.
8 years ago
Andrea Tartaglia 10a260c622 Clarified when control_path is ignored (#20968) 8 years ago
Chris Alfonso b2a10e6e4b Bumping docs footer copyright year (#22210) 8 years ago
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
8 years ago
Chris Houseknecht d20d528dbd Adds --role-skeleton to ansible-galaxy man page (#22199) 8 years ago
Dag Wieers 98b978d1d1 Clarify what modules are available for Windows (#21888)
Remove repeated mentions of an incorrect list.

This fixes #20696
8 years ago
Matt Davis c98647ccf8 initial commit of win_domain module (#22179) 8 years ago
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
8 years ago
scottb 0bd2714122 Update playbooks_variables.rst
Minor edits
8 years ago
Brian Coca cf3edf0989 more examples and clearer override docs for conn
fixes #21866
8 years ago
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>
8 years ago
Brian Coca bfb3467d52 more set/list stuff 8 years ago
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
8 years ago
Toshio Kuratomi 9d85d81ed0 Make the metadata docs agree with what's currently implemented 8 years ago
Wouter 5d39056379 Correct link in documentation (#21894)
Fixes #20692
8 years ago
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
8 years ago
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
8 years ago
Daniel d18bb96e88 Make pull-request sentence less ambiguous (#21802) 8 years ago
John R Barker 48c6dd2689 Point to cloud/amazon/GUIDELINES.md in main repo (#21780) 8 years ago
Matt Davis 67f74bbc81 CHANGELOG/roadmap updates for Windows 8 years ago
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
8 years ago
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.
8 years ago
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
8 years ago
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
8 years ago
Vlad Dm 32b92b53b0 service state typo 8 years ago
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
8 years ago
Peter Sprygada 58fa0bc1ea 2.3 roadmap updates for networking 8 years ago
John R Barker 0edda106f1 Delete link to test-network-modules (#21347) 8 years ago
Dylan Silva 8bf69411d9 Updated wording around support for different modules 8 years ago
927589452 a6cb377420 removed empty shell block (#21309) 8 years ago
Jeffrey Cafferata 4d0b62ede7 Update playbooks_best_practices.rst (#21288)
Updated the GitHub examples directory URL.
8 years ago
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
8 years ago
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
8 years ago
Craig Francis 2ccedc2ed9 Correct links to modules source code (#20650)
As per issue #20647, the modules are now in the main Ansible repository.
8 years ago
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.
8 years ago
927589452 19df0e0bf5 removed a typo (#21153)
* removed a type

doubled half sentence at the end removed

* Update intro_configuration.rst

Minor wording tweak.
8 years ago
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
8 years ago
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
8 years ago
Jordan Borean 719e1840da Added info on ntlm and credssp, updated configure script for credssp (#21175) 8 years ago
Brian Coca 5f29117e59 become options dont qualify as new anymore 8 years ago
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
8 years ago
bverschueren 3b64bff7a5 fix missing ident in provider dict assignment (#21089)
Thanks @bverschueren!
8 years ago
John R Barker 9ddc94d0e9 Update ROADMAP_2_3.rst 8 years ago
Matt Davis 764e1cc630 update azure roadmap items 8 years ago
John R Barker 54a2be9e2e formatting 8 years ago
Adrian Likins a5d3b186ba update ansible-ssh in roadmap 8 years ago
John R Barker 965fe80f1a formatting 8 years ago
Jason McKerr 6a6f13a5bd Update ROADMAP_2_3.rst 8 years ago
Jason McKerr 64a3c8f9de Update ROADMAP_2_3.rst 8 years ago
Jason McKerr 31fbc6e203 Update ROADMAP_2_3.rst 8 years ago
Ryan Brown 0de96d68f6 Update roadmap for cloud work 8 years ago
John R Barker b773b99136 developing_module status 8 years ago
Jiri Tyr 5d9dd5934a Making the decoration more clear (#20931) 8 years ago
Matt Clay 22db51f15c Update Testing and CI section of 2.3 roadmap. 8 years ago
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.
8 years ago
Adrian Likins 9703b0ff39 Add 'Improve testing of setup.py/facts.py' to 2.4 roadmap 8 years ago
John R Barker b038aad173 make webdocs speedup is done 8 years ago
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.
8 years ago
rektide 1df14ed121 Update loop docs to also describe register:'s value when inside loop. (#20991) 8 years ago
John R Barker 8d5f4dda06 Roadmap is draft (#20970)
The keyword is "draft",  not "final".
8 years ago
Brian Coca 114ef96572 added example keyring looukp 8 years ago
Scott Butler a002dca42d Edited for grammar, punctuation and spelling 8 years ago
Sebastian a8c038383e Update intro_installation.rst (#20854)
Added command to install the repository key to prevent errors
8 years ago
Albert Mikaelyan b89f222028 Some better explanation to release cycle 8 years ago
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
8 years ago
Matt Clay 10d9318de7 PEP 8 indent cleanup. (#20800)
* PEP 8 E121 cleanup.

* PEP 8 E126 cleanup.

* PEP 8 E122 cleanup.
8 years ago
Matt Clay d913f69ba1 PEP 8 W291 whitespace cleanup. 8 years ago
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'
8 years ago
pietro 8c3b915721 Fix versionadded on math filters section (#20674)
Extra character was breaking the rendering of the file.
8 years ago
Brian Coca af59781b56 removed core/extras ref from module pages
fixes #20647
8 years ago
Brian Coca e5f7a22215 clarified tag usage 8 years ago
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.
8 years ago
Matt Davis 06353c055a winrm managed kinit (#20416) 8 years ago
Brian Coca 9db1cfebbc docs fixes
fixed version number
updated C year
8 years ago
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.
8 years ago
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
8 years ago
Brian Coca 216e2c8813 leaving os immediate 8 years ago
Brian Coca 0803c638bb set cpus only if not set already 8 years ago
Brian Coca c95bd7d9b0 fixed escape again 8 years ago
Toshio Kuratomi e7505220d4 Need to define the OS variable at this level too 8 years ago
Brian Coca 2a5d949c52 corrected path to edit docs on devel to new loc
fixes #20474
8 years ago
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.
8 years ago
Brian Coca 339312a6b4 added missing file to cleanup 8 years ago
Brian Coca e2a871b49e corrected which app adds plugins 8 years ago
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
8 years ago
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
8 years ago
Klaus Ethgen ae57b95313 Documentation fix (#20198) 8 years ago
Brian Coca c129fd7c81 added clarification on directives/blocks 8 years ago
Brian Coca 497347d600 fixed phrasing on 0 being non error 8 years ago
Adrian Likins 960be799fd Use correct path for docsite src (rst/) 8 years ago
Adrian Likins 3645893a5b update path to _themes 8 years ago
Scott Butler 1c8b85a6f1 Added support statement for older releases. 8 years ago
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.
8 years ago
Adrian Likins b3e7794c08 Fix docs/api paths so api docs build (#20240)
Add a 'webdocs' target to docs/api to be consistent
with docsite/
8 years ago
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'
8 years ago
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.
8 years ago
Brian Coca 4b3977d5af added note about custom modules/plugins in roles 8 years ago
Brian Coca 2538383cf4 updated docs to make clear new option scope
this does not affect user tasks with `setup`
8 years ago
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
8 years ago
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.
8 years ago
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.
8 years ago
scottb 745219d200 Update playbooks_lookups.rst
Edited.
8 years ago
Brian Coca f9f99ddfbc updated docs to suggest quote filter for shells
Also changed comments into -name in examples where appropriate.
8 years ago
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.
8 years ago
Jasper Lievisse Adriaanse 073c4df790 Update references to Passlib as homepage/docsite moved (#20082) 8 years ago
Brian Coca 54800ea47c better sections for module return docs 8 years ago
Brian Coca 0aad46c85b corrected common headers 8 years ago
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
8 years ago
Toshio Kuratomi 08d6990e67 Fix code-blocks to use correct syntax highlighting 8 years ago
Toshio Kuratomi adb7426c0c Some more code-block fixes 8 years ago
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
8 years ago
Brian Coca 3b2a4c1955 fixed porting guide headers 8 years ago
Toshio Kuratomi 1be3ac36df Fix block highlighting
Found out that we change the default highlighting to yaml.
So explicitly mark python code blocks as such.
8 years ago
John R Barker ebc8b927ce Fix RST Errors 8 years ago
Rodolfo Carvalho 8f3c435b27 Fix path to test plugin examples 8 years ago
Brian Coca d108a6f0fc fixed webdoc generation 8 years ago
Brian Coca 57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
8 years ago
Carlos E. Garcia 0b8011436d minor spelling changes 8 years ago
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
8 years ago
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.
8 years ago
Brian Coca db8c952ee3 added new ksu method to man page
removed runas refrences, because it was never implemented
8 years ago
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.
8 years ago
Andrew Gaffney 4fd87f2dc6 Fix typo on -K/--ask-become-pass option in 'ansible' man page (#16667) 8 years ago
Shota 47f715fb37 Fix some typos (#16498) 8 years ago
Brian Coca dae0b833f5 updated man page with new pull options 9 years ago
Scott Radvan 72ca3b2b5b add very minor punctuation fixes (#15763) 9 years ago
Brian Coca e0573d3099 make vi the default editor if no EDITOR
fixes #15577
9 years ago
Tegan Snyder bf0da4aa3c add centrify dzdo escalation (#15219)
add dzdo context, and test
9 years ago
Brian Coca 0c92ec5e8f proposals were moved to ansible/proposals 9 years ago
Brian Coca 0cabef19ad updated man pages with imssing become option
also moved -K to become password to align with current code
fixes #15123
9 years ago
Brian Coca 92c887d1ed Merge pull request #14730 from chouseknecht/docker_image_proposal
Upated docker_image_module proposal
9 years ago
Brian Coca 4a01a5fbce Merge pull request #14733 from chouseknecht/docker_files_proposal
Adding docker_files module proposal.
9 years ago
Abhijit Menon-Sen f82639e4a2 Fix the other typo from #15036 9 years ago
Brian Coca 95495a6b38 fixed typo
fixes #15036
9 years ago
Greg DeKoenigsberg 03300e99ac Merge pull request #14929 from robynbergeron/devel
update proposals proposal
9 years ago
Robyn Bergeron 250b6c0f35 update proposals proposal
update proposals proposal with updates discussed in last week's meeting. will move this and other related materials to the new repo after this merges.
9 years ago
Brian Coca a302ba0ab4 Merge pull request #14810 from chouseknecht/docker_network_proposal
Updating docker_network module proposal
9 years ago
Brian Coca 7c18dfbd5a Merge pull request #14799 from chouseknecht/auto_role_install_prop
14604 - Adding suggested comments related to securing Galaxy role ver…
9 years ago
Brian Coca d23c7949eb Merge pull request #14842 from resmo/patch-4
proposal: publish/subscribe for handlers
9 years ago
René Moser 66cb77107b proposal: publish/subscribe for handlers 9 years ago
René Moser d361f3b44e proposal: re-run handlers 9 years ago
chouseknecht efd02020a2 Updating docker_container module proposal 9 years ago
Brian Coca 1b96454d8e Merge pull request #14796 from resmo/patch-3
prop: ignore_checkmode is a better name
9 years ago
René Moser 130c995208 proposal: ignore_checkmode is a better name
as suggested by @bcoca
9 years ago
chouseknecht f389709558 Updating docker_network module proposal 9 years ago
chouseknecht 3d0637292c Update to docker_container module proposal 9 years ago
Robyn Bergeron 69a144bfbe Update proposals proposal with PR link 9 years ago
Robyn Bergeron 08777fdecd Create proposals_process_proposal.MD
Created proposals process proposal. Inception!
9 years ago
chouseknecht 11c1814146 14604 - Adding suggested comments related to securing Galaxy role versions 9 years ago
Brian Coca 171c925966 Merge pull request #14756 from chouseknecht/docker_network_proposal
Updating docker_network module proposal.
9 years ago
Brian Coca e438a26ada Merge pull request #14760 from yyoshiki41/docs-tag
Fixed docs typo
9 years ago
chouseknecht 6edf1443db Adding docker_files module proposal 9 years ago
yyoshiki41 64f445f3a1 Fixed docs typo 9 years ago
chouseknecht 485bd4acc3 Fix docker_volume module proposal file name. 9 years ago
chouseknecht d85589121e Updating docker_network module proposal. 9 years ago
Brian Coca ab182b2bdb Merge pull request #14726 from chouseknecht/docker_one
Updating docker_container_module proposal
9 years ago
Brian Coca ea71352bea Merge pull request #14731 from chouseknecht/docker_image_facts_proposal
Updated docker_image_facts module proposal.
9 years ago
Brian Coca 15c938f2a2 Merge pull request #14740 from chouseknecht/docker_volume_facts_proposal
Adding docker_volume_facts module proposal
9 years ago
Brian Coca 4b5bb5dd89 Merge pull request #14739 from chouseknecht/docker_network_facts_proposal
Adding docker_network_facts module proposal.
9 years ago
Brian Coca 2a1f955ea5 Merge pull request #14737 from chouseknecht/docker_network_proposal
Adding docker_network module proposal.
9 years ago
Brian Coca cc6adf44b6 Merge pull request #14738 from chouseknecht/docker_volume_proposal
Adding docker_volume module proposal
9 years ago
René Moser 26005dfa5b proposal: deprecate always_run in favor of checkmode_run 9 years ago
chouseknecht e0f41c7726 Updated docker_image_facts module proposal. 9 years ago
chouseknecht f10807eb42 Adding docker_network_facts module proposal. 9 years ago
chouseknecht d0137abf98 Adding docker_volume_facts module proposal 9 years ago
chouseknecht 3e1332495b Upated docker_image_module proposal 9 years ago
chouseknecht 76766aac8b Adding docker_network module proposal. 9 years ago
chouseknecht 804c6f9c09 Adding docker_volume module proposal 9 years ago
chouseknecht b2dd22e9f2 Updating docker_container_module proposal 9 years ago
chouseknecht 78f4d33c94 Add docker_container module proposal. 9 years ago
chouseknecht 66756078f3 Updated auto-install-roles proposal. 9 years ago
Will Thames 80ec66f64a Proposal for auto updating roles
Reflects discussion on ansible-devel.
9 years ago
Maxim Burgerhout 275bd1b121 Fix a typo in man1/ansible 9 years ago
Aleksi Aalto aea8900abe document exit status for ansible-playbook 9 years ago
Denis 4e95c9f1eb Fix typos. 9 years ago
James Cammarata 76b4b9ed2c Merge pull request #13501 from chouseknecht/galaxy-2.0-update
Galaxy 2.0 update
9 years ago
Robin Roth 0c954bd142 add --full flag to ansible-pull man page
add --full flag that was added in #13502
9 years ago
chouseknecht 06dde0d332 Fixed documentation typos and bits that needed clarification. Fixed missing spaces in VALID_ACTIONS. 9 years ago
chouseknecht bc73920090 Updated ansible-galaxy man page. Removed -b option for import. 9 years ago
Brian Coca 9f148fc046 removed requirement of destination and set documented default 9 years ago
Brian Coca 2e05304f66 typo fix 9 years ago
Brian Coca 8eda94c591 normalized descriptions for most man pages
also removed the intermediate man page
added intermidieate manpages to gitignore
9 years ago
Abhijit Menon-Sen 3ad9b4cba6 Rework additional ssh argument handling
Now we have the following ways to set additional arguments:

1. [ssh_connection]ssh_args in ansible.cfg: global setting, prepended to
   every command line for ssh/scp/sftp. Overrides default ControlPersist
   settings.
2. ansible_ssh_common_args inventory variable. Appended to every command
   line for ssh/scp/sftp. Used in addition to ssh_args, if set above, or
   the default settings.
3. ansible_{sftp,scp,ssh}_extra_args inventory variables. Appended to
   every command line for the relevant binary only. Used in addition to
   #1 and #2, if set above, or the default settings.
3. Using the --ssh-common-args or --{sftp,scp,ssh}-extra-args command
   line options (which are overriden by #2 and #3 above).

This preserves backwards compatibility (for ssh_args in ansible.cfg),
but also permits global settings (e.g. ProxyCommand via _common_args) or
ssh-specific options (e.g. -R via ssh_extra_args).

Fixes #12576
9 years ago
James Cammarata 6650ba7654 Squashed commit of the following:
commit 9921bb9d20
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:19:44 2015 +0530

    Document --ssh-extra-args command-line option

commit 8b25595e7b
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Thu Aug 13 13:24:57 2015 +0530

    Don't disable GSSAPI/Pubkey authentication when using --ask-pass

    This commit is based on a bug report and PR by kolbyjack (#6846) which
    was subsequently closed and rebased as #11690. The original problem was:

        «The password on the delegated host is different from the one I
        provided on the command line, so it had to use the pubkey, and the
        main host doesn't have a pubkey on it yet, so it had to use the
        password.»

    (This commit is revised and included here because #11690 would conflict
    with the changes in #11908 otherwise.)

    Closes #11690

commit 119d032389
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Thu Aug 13 11:16:42 2015 +0530

    Be more explicit about why SSH arguments are added

    This adds vvvvv log messages that spell out in detail where each SSH
    command-line argument is obtained from.

    Unfortunately, we can't be sure if, say, self._play_context.remote_user
    is obtained from ANSIBLE_REMOTE_USER in the environment, remote_user in
    ansible.cfg, -u on the command line, or an ansible_ssh_user setting in
    the inventory or on a task or play. In some cases, e.g. timeout, we
    can't even be sure if it was set by the user or just a default.

    Nevertheless, on the theory that at five v's you can use all the hints
    available, I've mentioned the possible sources in the log messages.

    Note that this caveat applies only to the arguments that ssh.py adds by
    itself. In the case of ssh_args and ssh_extra_args, we know where they
    are from, and say so, though we can't say WHERE in the inventory they
    may be set (e.g. in host_vars or group_vars etc.).

commit b605c285ba
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Tue Aug 11 15:19:43 2015 +0530

    Add a FAQ entry about ansible_ssh_extra_args

commit 49f8edd035
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:48:50 2015 +0530

    Allow ansible_ssh_args to be set as an inventory variable

    Before this change, ssh_args could be set only in the [ssh_connection]
    section of ansible.cfg, and was applied to all hosts. Now it's possible
    to set ansible_ssh_args as an inventory variable (directly, or through
    group_vars or host_vars) to selectively override the global setting.

    Note that the default ControlPath settings are applied only if ssh_args
    is not set, and this is true of ansible_ssh_args as well. So if you want
    to override ssh_args but continue to set ControlPath, you'll need to
    repeat the appropriate options when setting ansible_ssh_args.

    (If you only need to add options to the default ssh_args, you may be
    able to use the ansible_ssh_extra_args inventory variable instead.)

commit 37c1a5b679
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 19:42:30 2015 +0530

    Allow overriding ansible_ssh_extra_args on the command-line

    This patch makes it possible to do:

        ansible somehost -m setup \
            --ssh-extra-args '-o ProxyCommand="ssh -W %h:%p -q user@bouncer.example.com"'

    This overrides the inventory setting, if any, of ansible_ssh_extra_args.

    Based on a patch originally by @Richard2ndQuadrant.

commit b023ace8a8
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 19:06:19 2015 +0530

    Add an ansible_ssh_extra_args inventory variable

    This can be used to configure a per-host or per-group ProxyCommand to
    connect to hosts through a jumphost, e.g.:

        inventory:
            [gatewayed]
            foo ansible_ssh_host=192.0.2.1

        group_vars/gatewayed.yml:
            ansible_ssh_extra_args: '-o ProxyCommand="ssh -W %h:%p -q bounceuser@gateway.example.com"'

    Note that this variable is used in addition to any ssh_args configured
    in the [ssh_connection] section of ansible.cfg (so you don't need to
    repeat the ControlPath settings in ansible_ssh_extra_args).
9 years ago
Abhijit Menon-Sen 4afe1cf422 Update ansible-vault manpage to describe new encrypt/decrypt behaviour 9 years ago
Richard Poole 3090a45891 add option to ansible-vault to read new password from file for rekey
The --new-vault-password-file option works the same as
--vault-password-file but applies only to rekeying (when
--vault-password-file sets the old password). Also update the manpage
to document these options more fully.
9 years ago
Damian Gerow 1c5611100e Add become support for OpenBSD doas 9 years ago
snetting 15669d98ca correct ansible-playbook man1 9 years ago
snetting 4693531851 update ansible man1 9 years ago
Till Maas f36a92f729 Re-Generate man pages 10 years ago
Till Maas 8ad2eac7e1 Mention ANSIBLE_INVENTORY
Support for ANSIBLE_HOSTS is faded out, see commit
c73254543a, therefore do not mention it in
the man pages.
10 years ago
Chris AtLee 1bf8f78b18 Add --list-hosts to man pages.
Fixes #9574
10 years ago
Brian Coca f734306c13 Merge pull request #9859 from autotune/devel
Added description for -S flag and --ask-su-pass #9846
10 years ago
Giovanni Tirloni bcbf819a8b Add how to load extra variables directly from a file (using @). 10 years ago
mixpix3ls 8866378e89 Fixing ticket 9845: man pages contain duplicate AUTHOR section 10 years ago
autotune d052bf8276 Added description for -S flag and --ask-su-pass 10 years ago
Toshio Kuratomi fa51e8f36d Document the --offline parameter to galaxy init
Fixes #9758
10 years ago
Michael Scherer 9c10a11aea Fix the synopsis in ansible-pull man page. 10 years ago
Michael DeHaan e43ae3c0f7 Update test strategies guide. 11 years ago
Cristian Ciupitu 7cb4b7ab89 Fix typos in ansible-playbook man page source
Note: the man page needs to be rebuilt.
11 years ago
James Tanner 33eec0dc55 Fixes #6398 Add missing parameters to ansible-playbook manpage 11 years ago
James Cammarata 12c812f030 Adding a man page for ansible-vault
Fixes #6471
11 years ago
James Cammarata ba4fbd2b66 Adding man page for ansible-galaxy
Partially resolves #6471
11 years ago
James Cammarata 6f405c8970 Updated footer date and adding in misc. file generated by earlier doc update 11 years ago
Maykel Moya 0b1320e48c Update doc, irc and mailing list information in manpages input 11 years ago
Maykel Moya 06beddfe68 Fix documentation url 11 years ago
Maykel Moya 0b44a3e54f Minor grammar fix in manpages 11 years ago
Michael DeHaan 388365b90a Add reference to Guru to sidebar. 11 years ago
Matthew Phipps d78951e767 Add skip_tags to ansible-playbook man page 11 years ago
Michael DeHaan 0882eefdff Merge conflict 11 years ago
Michael DeHaan 2f811c40d7 Basic docsite formatting fixups 11 years ago
Michael DeHaan fdb8505a5e Add ansible-pull's -o to the manpage. 11 years ago
Michael DeHaan 52b2cfedfc Add release history for 1.4.1 into 1.5 branch. 11 years ago
Michael DeHaan f7c3975f21 Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
11 years ago
jctanner 2d9087b806 Merge pull request #4484 from mscherer/add_short_hostname
ansible-pull by default will look for local.yml and $fqdn.yml.
11 years ago
jctanner 127efdf3ef Merge pull request #4576 from mscherer/pull_temporary_dir_2
add a default value for the -d option of ansible-pull
11 years ago
Ray b5266a562d minor correction
Same doc-typo (confirmed) as https://github.com/ansible/ansible/pull/4759

--remote-user  *should be*  --user
11 years ago
Ray a66f0462cd minor correction
--remote-user= does not work:
 ansible: error: no such option: --remote-user

--user= does. Updating docs
11 years ago
Michael DeHaan ad5731b4a8 Add module utils path to setup.py 11 years ago
Michael Scherer f8b23e5721 add a default value for the -d option of ansible-pull
Thi permit to simplify the command line to use by using
a sensible default, and so reduce the number of incorrect
possible choices and setup needed. Among potential
incorrect choices is using a fixed directory in /tmp, which
could be problematic with a setup whose access is not
properly restricted.
11 years ago
Michael Scherer 92147aff0f also fix the doc, forgot in last commit 11 years ago
James Cammarata 97e3e967a7 Merge branch 'devel' of https://github.com/jflorian/ansible into jflorian-devel 11 years ago
James Cammarata 8283183023 Adding sshpass as packaging requirement and fixing VERSION 11 years ago
John Florian c8a5aabf39 Added -f/--force option to ansible-pull 11 years ago
Stephen Fromm 77b8ee1f84 Update ansible-pull man page doc (issue #3372) 11 years ago
Michael DeHaan f0d7324e25 Merge pull request #3094 from sfromm/issue2464-redux
Updates to ansible-pull and ansible-pull docs
12 years ago
Michael DeHaan 4ae3ef8af9 Disable inventory test 12 years ago
Stephen Fromm a611027329 Update ansible-pull documentation 12 years ago
Michael DeHaan b19609b98b Slight docs tweak 12 years ago
Michael DeHaan 0837c9785f Merge pull request #3040 from bfabio/devel
Support JSON in --extra-vars.
12 years ago
Michael DeHaan 267b29cec7 Manpage tweaks, docs rebuild 12 years ago
Fabio Bonelli 6bef150695 Support JSON in --extra-vars.
If --extra-vars starts with either a '{' or a '[', it will be assumed
we are dealing with JSON and parse the data as such.
12 years ago
Michael Vogt d7b5b47efe improve wording, thanks to Michael DeHaan 12 years ago
Michael Vogt 22b0cf9275 use the same text for -M in ansible.1 and ansible-playbook.1 12 years ago
Michael Vogt 8338e75463 document in the man-page that {ansible,ansible-playbook} -M can also be overriden with the ANSIBLE_LIBRARY environment 12 years ago
Michael DeHaan aa4ad80bda Update release version. 12 years ago
Yves Dorfsman 8b10cc5946 Mention of ansible-doc and man pages for modules. 12 years ago
r-p-e 1f1eb4125f align manpages with actual code for --syntax-check 12 years ago
Michael DeHaan 2a66185920 update manpage for new options. 12 years ago
Oscar Korz ba807ed5a8 Correct -u description in ansible man page 12 years ago
Michael DeHaan 318e3302fb Fix up some version related things on the devel branch. 12 years ago
Michael DeHaan 70bb7d1e54 Merge pull request #1696 from gregorg/enhance_limit
Allow regex to be used to select hosts in addition to fnmatch pattern
12 years ago
Gregory Duchatelet ba4f71db27 Moved docs about "--limit=~REGEX" from man page to asciidoc. 12 years ago
Gregory Duchatelet 8bc1b69c58 Add a unit test to subset limiting via a regex, and some doc in man
page.
12 years ago
Jan-Piet Mens 17f31a2a79 CLI: ansible-doc shows lists of modules & module docs on command-line
check path is directory
added manpage & setup
small cleanup
shut up module_formatter in utils to avoid trace print on crud files in library
12 years ago
Michael DeHaan 6a5df97393 Manpage documentation ALSO should be sorted 12 years ago
Fabian Arrotin 96770a3057 - Fixed some typos for the ansible config file
- added the ANSIBLE_CONFIG environment variable
12 years ago
Michael DeHaan 5bdc16338e Release version bump for 0.9 (development branch) 12 years ago
Michael DeHaan aa98c84a62 HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core. 12 years ago
Michael DeHaan 70ed560fb3 Add FILES to manpage 12 years ago
Michael DeHaan 6d2f003ceb Update formatter to not include orange blocks all over docsite page 12 years ago
Michael DeHaan dbeb26ad6d Don't check in modules.js either 12 years ago
Michael DeHaan fc9a6bb07c Docs/json should not be checked in 12 years ago
Marco Vito Moscaritolo ee679c0190 Unified document generator and make to generate JSON and JS files 12 years ago
Tim Bielawa 9541b47b52 Keep the man3 directory. 'make docs' breaks without it. 12 years ago
Michael DeHaan 343e07a31a chapter 3 manpage source does not belong in git because it includes datestamps that constantly change. Willing to re-add if datestamps
are removable.
12 years ago
Michael DeHaan 4a95194424 Docs rebuild in new project structure. 12 years ago
Jan-Piet Mens a9dad7f3bd remove duplicate private-key option from manpage 12 years ago
Michael DeHaan 761330b125 Fix module formatter indexing 12 years ago
Tim Bielawa 85fb7c6d4b Library functions and modules should be in the 3 man page section. Also the files should end in '.3' 12 years ago
Michael DeHaan 53d24ef002 Check in generated manpage documentation from modules 12 years ago
Michael DeHaan 31a4fe412f Complain when modules do not have documentation. 12 years ago
Jan-Piet Mens d47e15a1f2 module_formatter in hacking/ 12 years ago
Michael DeHaan 975c323e39 Release version bump 12 years ago
Michael DeHaan 4920533c05 Add --limit to manpage 12 years ago
Tim Bielawa 698bcaa581 Fully document the -v option. 12 years ago
Tim Bielawa 6d9e873724 Add some docs/examples
Add a basic ansible-pull man page.

Add the example playbooks/scripts to the RPM package.

Closes #841
12 years ago
Tim Bielawa bf7e83bea6 Update man pages and the message for an exception. 12 years ago
Michael DeHaan 6ea022de01 docs build 12 years ago
Michael DeHaan 8fa4dc3920 Small change to previous patch, make ranges of hosts inclusive. 12 years ago
Chin Fang e3b2521f01 Added a host expansion feature to ansible's inventory parsing 12 years ago
Michael DeHaan a490213d45 Release bump to start development on 0.6 13 years ago
Michael DeHaan efac68b636 Remove the -D module debug flag, which no longer is functional due to sudo pty requirements, and replace with -v/--verbose.
This flag will show playbook output from non-failing commands.  -v is also added to /usr/bin/ansible, but not  yet used.

I also gutted some internals code dealing with 'invocations' which allowed the callback to know what module invoked
it.  This is not something 0.5 does or needed, so callbacks have been simplified.
13 years ago
Michael DeHaan da3816d370 Move version files to 0.5 for devel branch 13 years ago
Michael DeHaan 8e8cde3a2c override hosts gone 13 years ago
Michael DeHaan eda2333b24 Update manpage to mention -U (--sudo-user). 13 years ago
Michael DeHaan 36e454c52f Because paramiko using a pty can't distinguish stderr and stdout, remove handling that
treated -D as a way to show stderr, and make sure modules don't include things on stderr.
Update docs and test module script to come into line.
13 years ago
Michael DeHaan b9982fc17b Reinstate --extra-vars, which can do things in playbooks like:
ansible-playbook release-my-app.yml --extra-vars="version=123"

And make $version available in the playbook without re-editing the file
13 years ago
Tim Bielawa 621dc83ac2 Fix man page option description indentation. 13 years ago
Tim Bielawa d43cf592eb Renaming asciidoc sources to .in.
Change manpages to build from *.in and add comments about how the make
targets work.
13 years ago
Tim Bielawa 2d26d1fd71 Update %description and auto-add version to manpages
Conflicts:

	docs/man/man1/ansible-playbook.1
	docs/man/man1/ansible.1

Update %description
13 years ago
Michael DeHaan 9ce27be878 Remove extra_vars tests 13 years ago
Michael DeHaan b24ec71ca3 Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook 13 years ago
Michael DeHaan 579bd1d417 manpage updates 13 years ago
Michael DeHaan c3cad50075 Update manpages, fix missing variable assignment 13 years ago
Stephen Fromm b506567c37 Update ansible.1 manpage for option -c, --connection 13 years ago
John Eckersberg 5aad4bacc7 Bump release to 0.0.2 13 years ago
Tim Bielawa 446ba1795a Show when options require arguments in the man pages. 13 years ago
Michael DeHaan f1c8fc63cb host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago
Michael DeHaan 9049b0e7ca Because folks on RHEL 6 (not CentOS 6) have some issues with asciidoc, do not build the asciidoc from
the rpm or make install targets.  Also modify the make install (only) to copy over files into the library
directory since the setup.py does not do this (due to a distutils bug, more or less).
13 years ago
Michael DeHaan ee69bd18cc Add -T to playbook manpage 13 years ago
Michael DeHaan 6660a5efbd add polling info to manpage 13 years ago
Tim Bielawa 3f245498c4 Fixup RPM building: Makefile, Spec File, .gitignore
Fixup distutils: setup.py

Clean old cruft: section 5 man pages
13 years ago
Michael DeHaan 209760f8f6 Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 13 years ago
Michael DeHaan 742258a078 Drop other man(5) pages so we can have only one source of docs -- ansible.github.com for those operations.
Easier to maintain and much more verbose.
13 years ago
Michael DeHaan fb3bfa1c51 Tweak the matrix 13 years ago
Michael DeHaan 9c5341116b Update to comparison matrix 13 years ago
Michael DeHaan ee6db0531b Attempt at adding more comparison info 13 years ago
Michael DeHaan 937de08794 HTML test 13 years ago
Michael DeHaan 06d3cc930d This was supposed to be markdown with embedded HTML 13 years ago
Michael DeHaan 077e4f2381 Added start of comparison table so it's easy to explain at a glance what this project is. 13 years ago
Tim Bielawa f2c2786a14 Update constants.py to pull module path and the hosts file from the
environment (ANSIBLE_{LIBRARY,HOSTS}) if defined.

Update manpages to represent this.

Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
13 years ago
Tim Bielawa 6343aa6214 Add environment updating script 'env-setup' to facilitate running ansible from a git checkout. 13 years ago
Tim Bielawa e9ae5eb9d5 Correct see-also in playbook manpage 13 years ago
Michael DeHaan 269a6d46d6 attempt to explain import syntax in ansible-playbook manpage. Can't include
examples inline because github won't display them well, want to move this
file to markdown soon.
13 years ago
Michael DeHaan 847846af0e -p has been replaced by a required option. Various docs changes. 13 years ago
Michael DeHaan 4ce1f1dd5e README/doc/example updates to go with group support and CLI option changes.
Minimizing manpage until CLI options stabilize.
13 years ago
Michael DeHaan 55d256d82a Added solution to avoid checking in manpages. Just run "make" and we'll build
docs before python setup.py.   Seems reasonable to let Makefile drive
13 years ago
Michael DeHaan d8b5e667d8 Doc rebuild 13 years ago
Michael DeHaan 442c2488ba Minor playbook doc updates 13 years ago
Michael DeHaan d0906e187f Correct file location error in example 13 years ago
Michael DeHaan 058fa5bd15 Manpage and doc updates 13 years ago
Michael DeHaan 6fcce9a97e rebuild manpage due to license change 13 years ago
Michael DeHaan be4cb64c92 Relicensing to GPLv3, all previous committers ok'd on mailing list. 13 years ago
Michael DeHaan c0b4c80ba1 Docs rebuild 13 years ago
Michael DeHaan 783d3642a8 ok, giving up, github does not render asciidoc well at all.
Is there something we can use to generate manpages from markdown?
13 years ago
Michael DeHaan 28afd7208e Try once more. 13 years ago
Michael DeHaan 03bf465c3a attempt to fix asciidoc so it shows up on github 13 years ago
Michael DeHaan f3246fb72e Remove 'pending' comment. 13 years ago
Michael DeHaan 4201865bba Add note about facter/ohai integration into module docs. 13 years ago
Michael DeHaan e766bb6a6c update manpage output 13 years ago
Michael DeHaan 155c3ca89e update playbook docs with updated syntax / minor edits 13 years ago
Michael DeHaan 2860c14bc2 module doc updates 13 years ago
Michael DeHaan ba4e36a9a9 Rename 'ensure' to 'state' because I think it's a bit cleaner and doesn't imply
all modules take a common parameter name.  But more or less we still work idempotently
in modules.
13 years ago
Tim Bielawa 6612772711 Update man pages. Fix formatting in playbook example. Also, YAML documents by definition start with '---', so I have added this to the example and the manpage 13 years ago
Tim Bielawa afc7f4d246 This is configuration, not command. Rename to section 5 13 years ago
Tim Bielawa 9680de37c9 Manpages formatting 13 years ago
Tim Bielawa b4fd0042f6 Fix up some wording/formatting in ansible-modyles.5. Also: Section 5 is for configuration, update the see-also to reflect this with respect to ansible-playbook. 13 years ago
Tim Bielawa 86bf871e07 Fixup the naming of the docs. 13 years ago
Michael DeHaan 136d8fa33a add manpage crossreferences 13 years ago
Michael DeHaan 2262705ea3 Added stub for ansible-playbook (format) docs. Docs on ansible-playbook script TBD once
written.
13 years ago
Michael DeHaan 17a6ddb7ee Lining up with the reversion of 70ec508ee0, also
check the ansible-module file back in.  This is basically to make things easier
to build from setup.py.
13 years ago
Michael DeHaan 4e5da11217 Revert "don't check in manpage output file"
This reverts commit 70ec508ee0.
13 years ago
Michael DeHaan 226da501d3 Take notes about other modules that are in plan. 13 years ago
Michael DeHaan e5f62f20b1 make copy & template module take key/value parameters so we're consistent. Only the command
module works differently now

starter manpage for modules

allow template file location to be passed into template & setup modules
13 years ago
Michael DeHaan 77a7ddeebc Add start of documentation for modules 13 years ago
Michael DeHaan 70ec508ee0 don't check in manpage output file 13 years ago
Tim Bielawa f0b0211772 Because everything should have a man page 13 years ago