Commit graph

1113 commits

Author SHA1 Message Date
Adam Miller
9e2c02455a add note about named tasks in blocks (#46984)
* add note about named tasks in blocks

Signed-off-by: Adam Miller <admiller@redhat.com>

* adds names to tasks within example block, removes 2nd example

* removes traces of bad rebase
2018-10-18 16:24:52 -04:00
Bianca Henderson
e52761fbd3 Making minor changes (#47311)
<!--- Your description here -->

+label: docsite_pr
2018-10-18 16:18:29 -04:00
John R Barker
4991ef30c2 ROADMAP_2_8.rst link to GH project (#47265) 2018-10-18 05:49:17 -04:00
Luke Short
9cf407f683 Gentoo installation no longer requires a workaround. (#47151)
The default Python version has been 3.6
since June 2018 and was 3.5 before then.
Ansible supports Python 3.5 and above.
2018-10-17 10:23:23 -05:00
Jon Stevens
0272fd4b37 docs: Fix restructuredtext link format (#47199)
Fix two links on guide_online.rst
2018-10-17 09:28:48 -05:00
Petr Ruzicka
53217a3dbd with_items is obsolete - using loop instead (#46806) 2018-10-16 15:54:09 -05:00
Petr Ruzicka
559c92f9b6 with_items is obsolete - using loop instead (#46805) 2018-10-16 15:53:22 -05:00
Petr Ruzicka
b17f02a89a with_items is obsolete - loop should be used instead (#46524) 2018-10-16 15:52:32 -05:00
Matt Martz
abe64775cf Add porting guide note about inline vars on import/include_tasks (#47121)
* Add porting guide note about inline vars. Fixes #47102
2018-10-16 10:33:40 -05:00
Page Bowers
1ec71e503e Update the document to link to the script itself (#46986)
Added a link to the dynamic inventory script to make it easier for a user to find.
2018-10-16 09:12:11 -05:00
Alicia Cozine
b26aa66a41
fixes local toc, updates language (#47054) 2018-10-15 08:39:06 -05:00
Sandra McCann
db3d920cfd WIP: fix build errors due to missing certified_supported label (#46835)
* fix build errors due to missing certified_supported label

* fixed references and toc
2018-10-14 19:08:06 -05:00
Bianca Henderson
ffc46e1648 Making minor grammatical changes (#46844)
fixes to dev_guide page
2018-10-12 09:59:08 -05:00
Sloane Hertel
f3d5ebb355 add more consistent extension matching for inventory plugins (#46786)
* Add consistent extension matching for inventory plugins that support YAML configuration files

* Document extension matching expectations
2018-10-11 11:06:52 -05:00
Alicia Cozine
9764f32513 adds stub API docs in a single file (#46663)
* adds stub API docs in a single file
2018-10-11 10:15:24 -04:00
Risto Oikarinen
e1cfc2500c Clean playbook filters doc by adding whitespaces (#46569) 2018-10-11 09:02:12 -05:00
Dag Wieers
1771874ac8 Indentation 2018-10-10 01:52:44 +02:00
Dag Wieers
d0f3aaff62 Update wording as requested by review
Also improve wording.
2018-10-10 01:52:44 +02:00
Hayden
a2ac3482b6 Update windows_faq.rst
<!--- Your description here -->

+label: docsite_pr

Windows Subsystem for Linux is now officially supported by Microsoft. It is out of beta and will be shipping on Windows Sever 2019.
2018-10-10 01:52:44 +02:00
Mike Klebolt
5c93068223 incorrect ref (#46492) 2018-10-08 16:33:50 -04:00
Robert Herhold
850355b314 Update links to module sources (#46553)
The documentation still points to the old links for the [core](https://github.com/ansible/ansible-modules-core/tree/devel) and [extras](https://github.com/ansible/ansible-modules-extras/tree/devel) modules. This PR updates the links to the main ansible repository.

+label: docsite_pr
2018-10-08 14:24:19 -05:00
Sloane Hertel
43d12c11be Add 'auto' to documented default enabled inventory plugins (#46621)
* Correct default inventory plugins enabled in docs and example/ansible.cfg

* Fix headers
2018-10-08 14:07:46 -05:00
Sloane Hertel
c4d1f0d416 Add docs for inventory caching (#46402)
* Add docs for inventory caching

* Fix subsection headers

* Fix top header
2018-10-08 13:34:24 -04:00
Jordan Borean
b570af020c added porting guide for PowerShell EAP changes (#46451) 2018-10-04 15:32:17 -04:00
Alicia Cozine
e97391b7ab updates language about documentation versions and releases on index page (#46465) 2018-10-04 15:26:37 -04:00
Dag Wieers
92037679c4 Fix subelements example correctly (#46482) 2018-10-04 14:18:00 -05:00
Matt Clay
e2b6047514
Add symlinks sanity test. (#46467)
* Add symlinks sanity test.
* Replace legacy test symlinks with actual content.
* Remove dir symlink from template_jinja2_latest.
* Update import test to use generated library dir.
* Fix copy test symlink setup.
2018-10-04 07:02:42 -07:00
Alicia Cozine
ba9348883b
updates latest in docs conf.py (#46400) 2018-10-03 21:56:11 -05:00
Andrew Paradi
641c569a20 Fix spelling error in subelements Filter example (#46446)
<!--- Your description here -->

+label: docsite_pr
2018-10-03 21:54:36 -05:00
Haidara Mohamed El Mouctar
cd4415d4ec Docsite: Add a new tool: Ansible Playbook Grapher (#46435)
Add Ansible Playbook Grapher: a tool create a graph representing your Ansible playbook tasks and roles.

https://github.com/haidaraM/ansible-playbook-grapher

+label: docsite_pr
2018-10-03 10:19:19 -05:00
Sandra McCann
a1fae193c7 disable gather facts and update playbook output (#46409)
* disable facts gather and update playbook output

* fix output
2018-10-02 13:59:10 -05:00
Alicia Cozine
04b726dc14 Updates release & maintenance version docs for 2.7 2018-10-02 11:27:31 -05:00
Artur Juraszek
c0de93310f Mention YAML as a AWS CloudFormation template language (#46345) 2018-10-01 12:23:56 -04:00
Enno Gröper
1ff331e66a Update playbooks_delegation.rst (#46254)
Fix example variable lookup.

+label: docsite_pr
2018-09-28 13:38:52 -05:00
Alicia Cozine
66eb5681f4 yes, we do run validate_modules in Shippable (#46280) 2018-09-28 14:09:14 -04:00
Andrii Trykush
90126f37cd Corrected typo
Corrected typo
ansible_serach_path --> ansible_search_path
+label: docsite_pr
2018-09-28 12:41:05 -04:00
Brendan Jurd
ab96bbdef9 Clean up Vault docs in User Guide. (#46188)
* Fix spelling of 'separate' throughout.

* Various cleanups in the User Guide for Vault.

- Fix spelling of 'algorithm'
- Fix indentation of nested list in payload format
- Fix mysterious refernce to 'b_pkey1'.
- Fix reference to newline as '\n': the backslash is lost when rendered
to the docs website. Specify the hex value for newline instead of the
backslash escape.

* Fix formatting

* Update vault.rst
2018-09-28 10:16:58 -04:00
Kevin Breit
a690917b5f Meraki scenario guide - Changed section markup types (#46158)
* Changed section markup types, small fixes for style
- Add dashes per style guide
- Add TOC in case this grows
2018-09-28 08:58:41 -05:00
Sam Doran
4c929d3a7a Correct loop syntax in example (#46178) 2018-09-27 11:55:11 -04:00
Deric Crago
065b7ac300 moved 'strftime' filter into 'Other Useful Filters' section (#45801) 2018-09-27 11:52:50 -04:00
John R Barker
f1038a5c05
ROADMAP_2_8 stub (#46120)
* ROADMAP_2_8 stub

* Update ROADMAP_2_8.rst
2018-09-25 17:47:50 +01:00
Rémy Léone
1d4d49369e Add a guide for Scaleway (#44810) 2018-09-25 11:40:33 -04:00
Alicia Cozine
d1beb8436b restores legacy testing file (#46095)
* restores legacy testing file

* corrects links to legacy testing page

* oops, copy-pasta fix
2018-09-25 08:52:47 -04:00
Peter Sprygada
1e68881c40 adds support for null values to the ternary filter (#45303)
* adds support for null values to the ternary filter

This change adds a third optional argument to the ternary filter to
handle a null value.  If the third option is specified null and false
are treated differently.

For instance, take the following example:

{{ enabled | ternary('no shutdown', 'shutdown') }}

If enabled == True, then 'no shutdown' is used.
If enabled in (False, None), then 'shutdown' is used.

With this change the following is possible:

{{ enabled | ternary('no shutdown', 'shutdown', omit) }}

If enabled == True, then 'no shutdown'
If enabled == False, then 'shutdown'
If enabled == None, then omit

* update documentation with example of filter

* update filter documentation example per comments

* fix logic error in user_guide example
2018-09-24 18:57:19 -04:00
Mark Phillips
76a0323918 Changed hash_merge to link for ANSIBLE_HASH_BEHAVIOUR (#45996)
* Changed hash_merge, which goes nowhere, to link for ANSIBLE_HASH_BEHAVIOUR
* Changed link as per bcoca suggestion
2018-09-24 15:03:55 -05:00
Sandra McCann
df3655968f Infoblox scenario guide (#45664)
* creates infoblox scenario guide
* adds link to infoblox guide from modules
* adds WAPI to prerequisites
2018-09-24 14:25:01 -05:00
Simon Metzger
fc7e5f16e8 Update developing_modules_general_aci.rst
<!--- Your description here -->

+label: docsite_pr
2018-09-21 23:52:51 +02:00
Brian Coca
03d8b68549 added note about cli execution of include_x (#45227) 2018-09-21 14:08:57 -05:00
Rémy Léone
d3d1ff7990 Add a guide for using Online with Ansible (#45277) 2018-09-21 11:43:56 -05:00
Omar Osman
623f803e0b update example to YAML style in documentation (#45968)
The example is in a key=value format which is deprecated.

+label: docsite_pr
2018-09-21 08:42:31 -05:00
Jordan Borean
27c10fa502
add skip/docker alias to skip tests when running on Docker (#45955)
* add skip/docker alias to skip tests when running on Docker

* changed warning message wording
2018-09-21 16:09:54 +10:00
Jordan Borean
5c73d4f4bd
async: use async_dir for the async results file directory (#45461)
* win async: use async_dir for the async results file directory

* tried to unify POSIX and PowerShell async implementations of async_dir

* fix sanity issue
2018-09-20 19:37:54 +10:00
Eric Helms
74b94e119e Deprecate foreman and katello modules (#42043)
* Deprecate foreman and katello modules in 2.8, remove in 2.12
2018-09-19 11:41:54 -05:00
Pilou
60160c1e90 doc: exercising module code locally: update cmd (#45697)
The documented way to execute module code locally wasn't always working:

    $ python ./lib/ansible/modules/files/file.py <<< '{"ANSIBLE_MODULE_ARGS": {}}'
    Traceback (most recent call last):
      File "./lib/ansible/modules/files/file.py", line 177, in <module>
        from ansible.module_utils.basic import AnsibleModule
      File "~/ansible/lib/ansible/module_utils/basic.py", line 78, in <module>
        import tempfile
      File "~/ansible/lib/ansible/modules/files/tempfile.py", line 69, in <module>
        from tempfile import mkstemp, mkdtemp
    ImportError: cannot import name 'mkstemp'
2018-09-19 10:10:55 -04:00
Alicia Cozine
f430f60541
Restore license agreement (#45809)
* adds page for CLA in community docs with links from dev and community docs
2018-09-18 14:47:22 -05:00
Owen Kuemerle
4e532e0ad9 Add workaround for non-standard kerberos environments (#41465)
* Add workaround for non-standard MIT kerberos environments

* Generalize platform specific troubleshooting steps for Kerberos
2018-09-18 09:33:09 -05:00
Veaceslav Mindru
84a4257774 adding git+ssh uri scheme (#36025)
* incorporates git+ssh into existing example
2018-09-17 17:33:56 -05:00
Raymond Wanyoike
c41632fad2 Add the key_name/value_name options to the dict2items filter (#45550)
* Add the key_name/value_name options to dict2items - as with items2dict, allow users to configure the key/value name for dict2items, add "version added" and examples
2018-09-17 15:53:52 -05:00
Kamil Wilczek
78e9f452a5 Simplify PPA installation for Ubuntu (#45690)
Adds the `--update` flag to automatically update the cache and the `--yes` flag to disable the Ansible repo description and skips confirmation dialog. +label: docsite_pr
2018-09-17 08:59:20 -05:00
skylerbunny
a892a6ef03 Add undocumented configuration parameter and explain in porting guide (#36059)
* Add undocumented configuration parameter and explain in porting guide
2018-09-17 12:08:25 +01:00
Anil Kumar Muraleedharan
4ec317ceca Lenovo doc update (#45483)
* Merge issue

* Update cnos_rollback.py

* Updating license for the refactored method

* Update cnos_rollback.py

* Removing the BSD License as suggested by Legal

* To add Documentation for ENOS as well as CNOS

* Merge issue

* Revert "To add Documentation for ENOS as well as CNOS"

This reverts commit 80e6e39054be0c3a8f95d16dc39ca9d93baf8c4b.

* Adding Docs for ENOS and CNOS

* Update cnos.py

* Update cnos_rollback.py

* Update cnos.py

* Update platform_cnos.rst

* Update platform_enos.rst

* Removed version 2.7

* Removing 2.7
2018-09-14 15:23:57 -04:00
Matt Martz
829f48e3f5
Flip default for AGNOSTIC_BECOME_PROMPT (#45563)
* Flip default for AGNOSTIC_BECOME_PROMPT

* simplify AGNOSTIC_BECOME_PROMPT porting guide entry

* clarify AGNOSTIC_BECOME_PROMPT changelog entry

* fixes version typo

* uses alternate wording (rather than escaping *)
2018-09-14 11:16:13 -05:00
John R Barker
822236810e
BOTMETA Validator + Bulk tidyup, support:(core,community,network) (#44903)
plugins/ is COMMUNITY
Set sensible defaults for directories
support:network for the platforms that we Networking SUPPORTS,
everything else is COMMUNITY
Mark other support:network (ansible-connection, etc)
Infoblox is support:core
contrib/ by definition should be support:community
Remove duplicated labels
Make yamllint happy(ier)
Adds sanity test to ensure BOTMETA.yml is valid
2018-09-14 12:33:23 +01:00
Dag Wieers
e038338e9f Improvements to structure 2018-09-14 09:24:08 +02:00
Jacob McGill
78d7769bd9 ACI: Move dev_guide from Wiki to Ansible docs 2018-09-14 09:24:08 +02:00
Kevin Breit
3b38bf377e meraki - Remove YAML formatting on JSON code block (#45526)
* Remove YAML formatting on JSON code block
2018-09-13 13:16:32 -05:00
Dag Wieers
afea00fa9f Improve the local toctree (and title) (#45590)
Make toctree for Windows dev guide local, remove 'Ansible' from the title, since
this documentation is about Ansible.
2018-09-13 13:12:43 -05:00
Dag Wieers
6999bf318f Fix link and toctree (#45595) 2018-09-13 12:38:49 -05:00
Pilou
95649dc793 FAQ: fix a typo, add link to 'vars' lookup (#42412)
* FAQ: add link to vars plugin doc

* Typo (s/Techinically/Technically/)
2018-09-12 17:33:07 -04:00
Alicia Cozine
6e68d77f6d adds license details to dev guide pages (#45574)
* adds license details to dev guide pages

* fixes capitalization error
2018-09-12 16:10:38 -04:00
FloMiau
e35c4be1c1 Change "Defaulting Undefined Variables" (#41379)
Rewording the text for the second parameter of default because the original text was misunderstandable. +label: docsite_pr
2018-09-12 14:52:22 -05:00
Alicia Cozine
228fee4f3a lineinfile note belongs in changelog for 2.6, not 2.7 (#45517) 2018-09-11 22:00:40 +01:00
Brian Coca
e9c2695ce7 updated fbsd install instructions (#45309) 2018-09-11 15:55:21 -05:00
tterranigma
f68cd1acc6 Update implicit_localhost.rst (#45455)
Adds a clarification about `inventory_dir/file` magic variables when using implicit localhost as per #45385 . +label: docsite_pr
2018-09-11 15:17:50 -05:00
Artem Goncharov
8ae14bebda update porting guides (#40784)
* update porting guides

With PR #40532 `shade` library was retired and replaced with direct use
of `openstacksdk`. Porting guides and doc about dynamic inventory were
not updated.
2018-09-11 18:14:26 +01:00
Alicia Cozine
4264be2b18 Remove more docs build errors (#45364)
* orphans testing pages to avoid not-in-toctree errors

* orphans various pages pending reorg

* adds module_utils and special_vars to main TOC

* uses a glob for scenario_guide TOC

* normalize and Sentence-case headings on community pages, typos

* re-orgs community TOC, adds all pages to toctree

* removes scenario guides index page

* adds style guide to community index

* basic update to style guide

* fix typo that created a new error

* removes not-in-toctree from ignore errors list

* leave removing files for future cleanup task
2018-09-11 17:51:47 +01:00
Sam Doran
5d6f844eba Add docs on how to write changelog fragments (#42428)
* Add docs on how to write changelog fragments

* Make recommended changes

* Restore lines and make recommended changes

* Add link to new style changelog

Remove redundant mention of old style changelog
2018-09-11 12:23:22 -04:00
Jordan Borean
01398f61d5
Win deprecate 2.8 (#45473)
* Remove deprecated/expired functionality

* win:_msi: Remove the win_msi module

* removed some missed deprecated return options and added porting guide reference

Co-authored-by: dagwieers <dagwieers@users.noreply.github.com>
2018-09-11 14:23:48 +10:00
Jordan Borean
ec6d82435f
win_scheduled_task: add deprecation warning for repetition format (#45468)
* win_scheduled_task: add deprecation warning for repetition format

* fixed up sanity issues
2018-09-11 14:22:57 +10:00
Kevin Breit
ec3ce1f39c Meraki scenario guide (#41827)
* Initial commit for the Meraki scenario guide

* Added Meraki guide to indexes, fixed an error

* Added common parameters to scenario guide

* Add additional information for first draft
- Added very common parameters everyone uses.
- Documented common format for returned data from Meraki.
- High level explanation of error handling.

* Fix .rst formatting error

* Added section about handling returned data. More to come.

* Small formatting changes
2018-09-10 14:59:23 +02:00
Meecr0b
2f6b8591b1 tower_credential: expect ssh_key_data to be a string instead of path (#45158)
* expect ssh_key_data to be a string instead of path

ssh_key_data should be a string filled with the private key
the old behavior can be archived with a lookup

Fixes #45119

* clarifies ssh_key_data description, adds newline
2018-09-07 13:41:09 -04:00
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 (#45179)
* rewrite of the developer guide, part 1
2018-09-07 08:57:36 -05:00
Brian Coca
44510448b0 prefer ansible_facts namespace and dict notation (#44980)
* prefer ansible_facts namespace and dict notation

* fixed mistranslation
2018-09-06 10:26:58 -05:00
Markus Suonto
0d81386144 Add single quotes around package name (#45152)
<!--- Your description here -->
`pip install ansible[azure]` results in `zsh: no matches found: ansible[azure]` at least in my computer (zsh on Ubuntu). I don't know if it is the case with all shells, but at least for me it is. Since square brackets `[]` are special characters in bash, I propose adding single quotes to make sure that package name is always interpreted as literal. The same error is also resolvable by setting noglob.
2018-09-06 10:09:40 -05:00
Ian Wienand
6be42a2a0e docs: Clarify include_task v import_tasks with conditionals (#43856)
Correct and clarify "set_fact" example, expanding on what is happening
in the easy-to-get-wrong import mode. Add some additional links to "group_by" documentation and the main import/include discussion.

Closes: #31596
2018-09-05 14:06:02 -05:00
Brian Coca
70f3f084ac fixed chlog path 2018-09-05 10:41:49 -04:00
Sandra McCann
fe119c18ef fixed formatting (#45164)
(cherry picked from commit 58ca82fa1c59d3a62509db99c4bbff6eb08829ab)
2018-09-04 09:33:01 -05:00
Matt Martz
f89d873698
Stub out modules scheduled for 2.8 removal (#44985)
* Remove modules scheduled for 2.8

* Add changelog and porting guide

* Skip docs test on removed modules

* Don't link to removed modules
2018-08-31 16:27:32 -05:00
Sam Doran
d257095976 Change Mac OSX to macOS in installation docs (#44971)
* Change Mac OSX to macOS in docs

* Lowercase via
2018-08-31 11:12:12 -05:00
Yanis Guenane
857a553fa1 Vultr: Create the Vultr Guide (#44515) 2018-08-31 10:42:07 -04:00
Brian Coca
cbd54a4b2c added more reasons to avoid dot notation (#43724) 2018-08-31 09:32:36 -05:00
James Polley
7988266bb7 Improve clarity of precedence when command-line parameters are used. (#39059)
* Improve clarity of precedence when command-line parameters are used.

* Add command-line values into the precedence list.
* Several sample config snippets were included without any explanation
  of how those snippets would be processed. Added descriptions so that
  the reader can understand what each snippet will (or won't) accomplish.

* Don't focus on inventory as much

Expand on the fact that it's the fact that a variable is set that
matters, not the source of the variable.
2018-08-31 09:56:58 -04:00
Sandra McCann
cccf5e6e77 fixed grammar and spelling issues (#44931)
* fixed grammar and spelling issues

* fixed autocorrect mistake and sanity test errors
2018-08-31 08:44:31 -05:00
Brian Coca
3f657ca28f clarify priority setting (#44865)
* clarify priority setting

* updated as per fb
2018-08-31 09:20:26 -04:00
Dag Wieers
ac3781d40b Fix broken CI (#44937)
* Fix document structure

* Fix broken CI
2018-08-30 16:46:29 -07:00
Dag Wieers
32fc6746d8
Fix document structure (#44935) 2018-08-31 00:16:36 +02:00
Christopher Torgalson
2dfff57f57 Extends 'which notation should I use' section in FAQ (#43729)
* Extends 'which notation should I use' section in FAQ
2018-08-30 15:47:39 -05:00
Ritesh Puj
ff654ccfe8 replaced 'ansible_os_platform' to 'ansible_os_family' (#44676)
replaced 'ansible_os_platform' to 'ansible_os_family' as 'ansible_os_platform' variable is no longer available.
2018-08-30 15:02:39 -05:00
Felix Fontein
376dcb9f84 docker scenario guide: docker-py -> docker (#44856)
* Don't install docker-py by default, but the more modern docker library.

* Addressing the review comments.
2018-08-30 14:38:03 -05:00
Abhijeet Kasurde
6059da245b VMware: Concept documentation (#43927)
* VMware: Concept documentation

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

* update docs

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-08-30 12:49:37 -04:00