Commit graph

156 commits

Author SHA1 Message Date
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
Brian Coca
424e1946f4 moved docs generation and templates to docs/ 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
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
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
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