Commit Graph

1673 Commits (17bfc60423404b08cc17f5eb0e1718d61c5fef57)

Author SHA1 Message Date
Chris Archibald 73348ae32d Fixes for na_ontap_cluster_peer (#48329)
* Fixes for na_ontap_cluster_peer, incorporating review comments, version, etc.
6 years ago
Jordan Borean d9ca78c542 update docs on runas become (#48149)
* update docs on runas become
* Added example win_whoami output and removed some 2.5 mentions
6 years ago
Kevin Breit a9d68f3d52 Meraki scenario guide - describe how to merge new data with old data (#48999)
* Described how to merge new data with old data in the Meraki guide
Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
6 years ago
Alicia Cozine 02baae6e99 revises inventory intro page (#49330)
* revises inventory intro page

* changes :doc: to :ref: for links
6 years ago
Alicia Cozine e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
6 years ago
Brian Coca 8461321a6a clarify registered vs facts (#45432)
* clarify registered vs facts

fixes #45411

* wordsmithing
6 years ago
Brian Coca 7f04ee1eb4 corrected action plugin docs (#49321)
fixes #49277
6 years ago
David M Noriega 0922a6566d Adding note on async+check mode incompatibility (#41427)
Fixes ansible/ansible#40991
6 years ago
Xaroth 59e7a9442e -Change: set the 'canonical_url' theme option to enable rendering of canonical urls, promoting the 'latest' docs to search engines. (#49190) 6 years ago
Evgeni Golov 7c61ce153f clarify what `strict` means for the `version` test (#48979)
Reference the fact that we use the `StrictVersion` parser instead of `LooseVersion` from `distutils` in this case.
6 years ago
John R Barker c3d579c52a Docker & Remote Management Working Groups (#49023)
* Adds Docker & Remote Management Working Groups
6 years ago
John R Barker 3433ca286d Docs reorg /community/index & /dev_guide/index (#48734)
* Improved community/index.rst makes it easier to find existing content
6 years ago
Matt Martz 7287d396e2 Prevent metadata changes in a stable branch (#48994) 6 years ago
Christian Rebischke 704d5642f3 VMware: added documentation for missing netplan support (#46685)
Currently there is no `netplan` support in open-vm-tools. Therefore it's
nice to have a quick workaround in our documentation

Signed-off-by: Christian Rebischke <chris@nullday.de>
6 years ago
johnstudarus 679b7dce63 Update guide_packet.rst (#49007)
Properly parses the returned data to get the device data and IP address. 


+label: docsite_pr
6 years ago
Will Thames 960ebd981f k8s append_hash (#48830)
* Add append_hash functionality to k8s module

append_hash adds a hash based on the contents of a ConfigMap
or Secret to the name - this enables immutable ConfigMaps and
Secrets.

* Provide k8s_config_resource_name plugin

The k8s_config_resource_name filter plugin provides a means of determining
the name of ConfigMaps and Secrets created with append_hash

* Add changelog fragment

* fix failing tests

* Update openshift version needed for append_hash
6 years ago
Yunge Zhu d3b52d2a72 fix xxx.com (#48972) 6 years ago
Matt Martz 9773a1f289
Add a Singleton metaclass, use it with Display (#48935)
* Add a Singleton class, use it with Display

* update six import

* Move remaining failes to display singleton

* Fix rebase issues

* Singleton improvements

* Add code-smell for 'from __main__ import display'. ci_complete

* s/self/cls/g

* Add docs for no-main-display

* Address linting issues

* Add changelog fragment. ci_complete

* Implement reentrant lock for class instantiation in Singleton

* Add Display singleton porting guide
6 years ago
Wojciech Sciesinski cebe64ac0c Add a missed command (#48857)
adds command to set the environment for the hacking script
6 years ago
Andreas Krüger e1fbd54ebb Add link to include / import module doc to discussion of include / import. (#48932) 6 years ago
Bianca Henderson 89a9bc0488 Change intro portion of Testing page (#48692)
* Change intro portion of Testing page
6 years ago
Felix Fontein 891687284f docker_* modules: improve diff (#48546)
* Add difference tracking tool

* Improve --diff mode for docker_container.

* Improve diffs of sets by ordering the sets.

* Rewrite imports, get rid of HAS_DOCKER_PY_x variables and use docker_version instead.

* Rename container -> active (more generic).

* Add --diff for docker_volume. Change old diff output.

* Add --diff for docker_network. Change old diff output.

* Add --diff for docker_swarm_service.

* Add changelog.

* Add entry for porting guide on docker_network and docker_volume.
6 years ago
Bojan Vitnik b0cc240665 New module: xenserver_guest - manages XenServer VMs (#41041)
* XenServer related modules - initial commit

 - New module_util: xenserver. Contains common module arguments, functions
   and classes useful for future XenServer related modules.
 - New module_docs_fragment: xenserver. Describes common module arguments.
 - New module: xenserver_guest. Supports VM deployment, reconfiguration,
   removal, detection of changes, state management, fact gathering and
   Ansible check mode. Module is fully documented.
 - Updated: developing_module_utilities.rst.
 - Module params, workflow and some functions are based on or taken from
   vmware_guest module.

* Implemented support for configuring custom VM params in xenserver_guest module

* Compatibility fixes and documentation update

 - xenserver module_util: implemented support for XenAPI.py version older
   than 7.2.
 - xenserver module_util: PEP8 fixes.
 - xenserver module_util: Added missing imports.
 - xenserver module_util: Copyright notice fixes.
 - xenserver_guest module: updated module documentation with notes regarding
   module requirements and compatibility.
 - xenserver_guest module: bumped version_added to 2.7.
 - xenserver_guest module: minor fixes.

* VM power state management refactoring, subargument specs in xenserver_guest module, other fixes

 - VM power state management code moved from xenserver_guest module to xenserver
   module_util (set_vm_power_state function).
 - Code for waiting for VM IP address moved from xenserver_guest module to
   xenserver module_util (wait_for_vm_ip_address function).
 - xenserver module_util: implemented get_object_ref function to clean up
   a lot of repeated code in xenserver_guest module.
 - xenserver module_util: added additional aliases 'host' and 'pool' for
   'hostname' common module argument. They are more in line with what
   XenServer users are familiar with.
 - xenserver module_util: minor fixes.
 - xenserver_guest module: removed VM state management other than 'present',
   'absent' and 'poweredon'. Other states are to be managed by separate module.
 - xenserver_guest module: added subargument specs and cleaned up custom code
   for subargument validation.
 - xenserver_guest module: reorganized code for disk and network reconfiguation
   to minimize code duplication.
 - xenserver_guest module: renamed 'cdrom.iso' module argument to
   'cdrom.iso_name', avoids cryptic error message when parameter is
   missing.
 - xenserver_guest module: documentation update.
 - xenserver_guest module: changes in error messages.
 - xenserver_guest module: minor fixes.

* Implemented guest OS network parameter configuration and other

 - xenserver module_util: moved code for validating MAC addresses from
   xenserver_guest module and implemented a range of functions for validating
   IP addresses and related entities and converting prefixes to netmasks and
   vice versa.
 - xenserver module_util: updated fact gathering code to support guest OS
   network parameters.
 - xenserver module_util: added docstrings.
 - xenserver module_util: minor changes.
 - xenserver_guest module: implemented support for guest OS network parameter
   configuration.
 - xenserver_guest module: changed CD-ROM handling code.
 - xenserver_guest module: changed so that user friendly version of changes
   list is always returned in module result.
 - xenserver_guest module: error message changes.
 - xenserver_guest module: added docstrings.
 - xenserver_guest module: documentation update.
 - xenserver_guest module: minor changes and fixes.

* Various fixes and code cleanup

 - xenserver module_util: implemented get_xenserver_version function.
 - xenserver module_util: moved customization agent detection code to
   gather_vm_params function. customization_agent variable is now part of
   vm_params. An exception in customization agent detection code that prevented
   deployment of new VMs is also fixed.
 - xenserver module_util: added support for alternative VM state names with
   dash and underscore in set_power_state function.
 - xenserver_guest module: removed customization agent detection code
   as it is now implemented in xenserver module_util.
 - xenserver_guest module: fixed a bug in xenserver_data update code that
   occured when "networks.mac" was not specified in module params and
   other fixes.
 - xenserver_guest module: some code cleanup.
 - xenserver_guest module: bumped version_added to 2.8.
6 years ago
Matt Clay 8066acc90c
Support skip of platforms by version in tests. (#48826)
* Support skip of platforms by version in tests.

Previously a remote platform could be skipped completely using the alias:

`skip/{platform}` such as `skip/rhel`

Now a specific platform version can be skipped using the alias:

`skip/{platform}{version}` such as `skip/rhel7.6`

This feature is available for platforms specified with the `--remote` option.

* Add skip by version to the docs.
6 years ago
Alex Ratner 0c7f6e5047 fixes for typos, grammar, and links (#48721)
* fixes for typos, grammar, and links on magic vars page
6 years ago
Dag Wieers fd02ecd290 Code example improvements in Windows documentation (#45055)
This PR includes:
- Using explicit yaml+jinja code-blocks
- Work around pygments lexer issues with colons (in URLs and options)
6 years ago
Xaroth 87d10b9b78 Include dependency role names in `role_names`. (#46483)
* -Change: Include dependency role names in `role_names`.
-Add: `play_role_names` magic variable to include only explicitly named roles (formerly `role_names`).
-Add: `dependent_role_names` magic variable to include all dependency names for all roles.

* -Change: use the ansible_ prefix for new magic variables.
-Change: keep `role_names` as a deprecated variable, using the old functionality.

* -Add: changelog fragment for the role_names rework.

* -Add: Tests for the role_names (and ansible_*role_names) special variables

* -Fix: resolve erroneous documentation snippet that was introduced after rebasing.

* -Fix: explicitly sort to ensure list comparison works in test.
6 years ago
Martin Krizek 9ce9c9698a committer_guidelines.rst: update core committers (#48662)
* committer_guidelines.rst: update core committers

* Another update
6 years ago
Toshio Kuratomi b759862daa Add an example to serial usage (#48669) 6 years ago
Dylan Silva 498bb74717 Updated roadmap to reflect dates for 2.8 (#48626)
* Updated roadmap to reflect dates for 2.8
6 years ago
Matt Clay 1a3bf09f8a
Add test to require docs for action plugins. (#48376) 6 years ago
Adam Miller 2b1ca25e59 docs - adapted abadger's changelog announcement email into dev process (#48172)
* docs - adapted abadger's changelog announcement email into dev process

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

* migrate changelog docs to one place, add ref to old location

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

* add changes based on feedback

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

* Refines changelog docs, minor re-org of page

* moves links and anchors for new content

* Further reorg of page

* fixes header per jamescassell
6 years ago
Michael Scherer 2ca7279cae Correct the variable name in example (#48603)
Changed from 'ansilbe_python_interpreter' to 'ansible_python_interpreter'
6 years ago
Matt Martz 8765d2a8e8
code-smell test that can find deprecated config items (#46273)
* Start of code-smell test that can find deprecated config items

* Strip deprecated.version from config item

* Don't use os.walk, rely on explictly passed list of files

* Properly disable the test

* Add docs

* Make config an orphan
6 years ago
Andreas Krüger 806442b3ec Document the tests that are currently run on documentation pull requests. (#48436) 6 years ago
Brendan Good 475844d1ae Fix man page template typo. (#48585)
changed from 'direcotry' to 'directory'.
6 years ago
Martin Krizek 1465f70eb5 Add ansible_play_name magic var (#48562) 6 years ago
Brian Coca 7ca6af396e added faq entry on ansible_host + delegation (#48438) 6 years ago
Felix Fontein 9a848ca883 Fixing typo in developing_locally.rst (#48535)
`cacheing` → `caching`

+label: docsite_pr
6 years ago
Lars Kellogg-Stedman 220d224433 add note regarding {host,group}_vars directory lookup semantics (#48066)
* add note regarding {host,group}_vars directory lookup semantics

While the 'ansible-playbook' command will look for {host,group}_vars in
both the playbook and inventory directories, the 'ansible' command
will only look in the inventory directory. This follows from a close
reading of the documentation but isn't explicit and leads to the
perhaps unexpected result that you can run both commands with the same
configuration in the same directory and get different results.

This commit adds a note to the documentation making the difference in
behavior explicit.

Closes #48065

* incorporates bcoca feedback
6 years ago
Alicia Cozine d27d956d71 clarifies FAQ answer about env vars (#48432) 6 years ago
Rémy Léone f4fa3314c4 Add support for Scaleway object storage (#46353) 6 years ago
Keith Maxwell 7db2861961 Remove unnecessary --recursive option to git clone (#48379)
From installing / Running from source.
Since the repomerge, Ansible doesn't use submodules. Also, between 2.12.0 and 2.13.0 git dropped '--recursive' in favor of '--recurse-submodules'.
6 years ago
Andreas Krüger e2bba149d6 playbooks_reuse_roles.rst long and shorthand example actually made equivalent. (#48339) 6 years ago
Rushan cc5b9c5fe1 enchance yaml filter documentation (#46629)
* update to_*_yaml filter documentation

* update to*_yaml filter documentation
6 years ago
Abhijeet Kasurde 47aa752df0 VMware: Documentation for SSL installation methods (#43992)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Matt Martz f728f2bff0
Add a new "contains" jinja2 test (#45798)
* Add contains jinja2 test

* backticks
6 years ago
Brian Coca 8ccb44aa63 clarify insane ini typing (#48169)
* clarify how variables are interpreted in the ini inventory plugin
6 years ago
angystardust 09ff2da651 VMware: further improvements to the scenario_clone_template (#48141)
Follow-up to #47889. Fixes the list of required privileges for cloning a vmware template.
6 years ago
majekw 383da46c32 Document installation procedure on Slackware (#47657)
Add section with installation procedure on Slackware Linux using sbopkg and SlackBuilds.org build scripts repository.
6 years ago
Jordan Borean 501acae5ab
Added basic equivalent to PowerShell modules (#44705)
* Added basic equivalent to PowerShell modules

* changes based on latest review

* Added tests

* ignore sanity test due to how tests are set up

* Changes to work with PSCore

* Added documentation and change updated more modules

* Add some speed optimisations to AddType

* fix some issues in the doc changes

* doc changes
6 years ago
InputValidation 7760b04020 Updated Red Hat Repo (#48173)
Updated Red Hat Repo to current version number
6 years ago
Matt Martz 45ff6df1af Remove Deprecated configs 2.8 (#46825)
* Removed deprecated ANSIBLE_HOSTS

* Bump sudo/su configs to match deprecation version for cli and playbook args

* Bump include configs to match deprecation version for 'include'
6 years ago
Adam Miller 8c362da6dc swap out RM for 2.8, it me now (#48013)
Signed-off-by: Adam Miller <admiller@redhat.com>
6 years ago
Aren 6243f36319 gcp additional info & edit (#45986)
* There were 2 introduction headings

line 36 was a duplicate 'introduction' heading, and the section is more of a requisites description.

+label: docsite_pr

* edit for line 32+33 & 45>50 added
6 years ago
Mark Jeromin 8d2f6c31de updated user_guide for regex test, #24155 (#47893) 6 years ago
mbk87 5ab30e0079 protocol (#47666)
* clarifies reference to SSH, adds link for further reading
6 years ago
Risto Oikarinen 4b2a090418 Fix vars_prompt "private" description and improve example (#47688)
* Fix vars_prompts "private" description and improve example

* Fix indentation
6 years ago
Risto Oikarinen f000baf6f7 Add yaml version of using host variables example (#47700) 6 years ago
Bianca Henderson e38796bf7b Slight Change in Wording in "Reporting Bugs and Features" (#47984)
* Adding a link for PR info

* Not specifying Google Groups in wording
6 years ago
Brian Coca 40d8b91d07 added missing vars (#47993)
fixes #31900
6 years ago
Bianca Henderson 248827227a Correcting syntax of PyYAML package (#47987) 6 years ago
Christian Kotte 754c377dbd VMware: Improve output of vmware_local_role_facts (#47871) 6 years ago
angystardust 89f03314ce VMware: improve readability and fix privileges names on scenario_clone_template (#47889) 6 years ago
Abhijeet Kasurde ab0d90f882 VMware: Fix documentation for cloning template (#47847)
Fixes: #46700

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Martin Krizek ec32bda2ef ansible-galaxy docs: fix init of container role (#47853) 6 years ago
Moritz Grimm 1a91b797bd updated documentation fixing #47202 (#47267) 6 years ago
Jordan Borean 73141d5035 pip: produce better error msg on import error (#47743)
* pip: produce better error msg on import error

* Added porting guide entry for 2.7
6 years ago
John R Barker f536944e3a Molecule is now IRC: ansible-molecule (#47860) 6 years ago
John R Barker 4572d9ccd7
ansible-lint and molecule part of Red Hat (#47826) 6 years ago
Alicia Cozine 7db63851e0 Updates variables docs: facts examples, headers, links, etc. (#47767)
* refreshes ansible facts output and updates some references/headers
6 years ago
Bianca Henderson e6d99cb2bf Adding a link for PR info (#47778) 6 years ago
Abhijeet Kasurde 6d36849f72 Update plugin filter documentation (#46665)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
John R Barker d189e58f63 Correct AWX community link (#47742) 6 years ago
mbk87 24e1da972e bad space (#47667)
removes whitespace
6 years ago
John R Barker 749af9fd22 Document all Working Group, email lists and IRC channels (#47615)
Put all communication info in one place so we can update links to point here.
6 years ago
John R Barker 72359a10e6 Tidy up Contributors Docs (#47619)
* Tidy up docs on GitHub, direct people to docs.ansible.com
* De-duplicate documentation and move useful info
6 years ago
John R Barker 166e84b9c4 Docs: No need to follow up on backport PRs (#47616)
Also tidy up `notes` section into a single box
6 years ago
Ben Cornett 6229f89369 Fix spelling (#47692) 6 years ago
Johannes Brunswicker d3be5d5327 Creates base Sophos UTM module (#45781)
* Fixes #18568
* Commit of the first set of utm modules
* added documentation line for module_utils file
* removed other utm modules for the first pr
* added maintainers to botmeta
* implemented fixes for shippable
* fixed whitespaces and newlines in included doc fragment
* added types and choices to documentation
* fix for E501
* Implemented change requests
* changed utm_utils license to BSD
* changed str() to to_native()
* added a status state that will just return information about my object
* renamed state 'status' to 'info'
* added team_e-spirit to botmeta and added the team as maintainer for the utm_utils
* only return a result if the lookup was not empty. Do not return a null result
* removed info state
* added boilerplate
* made preparation for info-only modules
6 years ago
Andrea Perotti 8bc4a18500 Updates intro to dynamic inventory page (#46799)
* Added Foreman to the list of inventory scripts
6 years ago
Abhijeet Kasurde e5318c5c4f doc: Scenario guide for VMware HTTP API usage (#47117)
This adds scenario guide for using VMware HTTP API using uri module.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Matt Martz f7ba63e047
Add shorthand debugger method to recreate the task from the original ds (#46987)
* Add shorthand debugger method to recreate the task from the original ds, and re-template. Fixes #46321

* Fix rst header

* Indicate update_task was added in 2.8
6 years ago
d3nisko 6c2e4c1ca8 Update YAMLSyntax.rst (#47491)
* Update YAMLSyntax.rst to correct syntax of a list vs dict.
6 years ago
Simon Legner 5959158612 doc(user_guide): fix typos (#47425) 6 years ago
Alicia Cozine 4219d25fc7 Add docs about contributing to docs (#46481)
* adds page on community contributions to docs
6 years ago
Aurelio Jargas e58e43279c Fix markup: inline literal with spaces (#47560)
Fixes rST/Sphinx error on the YAML syntax page of the core docs.
6 years ago
Jordan Borean ddfd1dbfc6
Add helper function to return helpful import error msg (#47409) 6 years ago
markafarrell 94eab56d51 Update netconf jumphost documentation (#47339)
* doc/update netconf jumphost docs

* Remove requirement for nc. Option for Port 830

Based on https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Proxies_and_Jump_Hosts#Passing_Through_a_Gateway_Using_stdio_Forwarding_(Netcat_Mode)

* Fix formatting

* More formatting fixes

* Remove incorrectly added newline
6 years ago
He Guimin 85ba30a3db Add new module ali_instance (#36898) 6 years ago
Ganesh Nalawade 335a979f1d
Fix prompt mismatch issue for ios (#47004)
* Fix prompt mismatch issue for ios

Fixes #40884 #44463

*  If the command prompt is matched check if data is
   still pending to be read from buffer.
*  This fix adds a new timer `buffer_read_timeout`
   which will be trigerred after command prompt
   is matched and data is attempted to be read from channel.
   If not data is present of channel the timer will expire
   and response we be returned to calling function.

* Fix unit test failure

* Update to make buffer timeout float

* Update doc and fix review comment

* Fix CI issues

* Update doc

* Fix review comments

* Fix review comments
6 years ago
Richard Metzler acda7bae5f fix callback name
+label: docsite_pr
6 years ago
Alicia Cozine f1ad012375 removes docs/api dir from .gitignore and Makefile (#47366)
* removes docs/api dir from .gitignore and Makefile

* reduces noise on removing build artifacts
6 years ago
Alicia Cozine cd7232eeb7 refines vmware sample scenario page (#47320) 6 years ago
Artem Zinenko 3fa33ce96b Fixed typos in winrm doc (#47351) 6 years ago
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
6 years ago
Bianca Henderson e52761fbd3 Making minor changes (#47311)
<!--- Your description here -->

+label: docsite_pr
6 years ago
John R Barker 4991ef30c2 ROADMAP_2_8.rst link to GH project (#47265) 6 years ago
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.
6 years ago
Jon Stevens 0272fd4b37 docs: Fix restructuredtext link format (#47199)
Fix two links on guide_online.rst
6 years ago
Petr Ruzicka 53217a3dbd with_items is obsolete - using loop instead (#46806) 6 years ago
Petr Ruzicka 559c92f9b6 with_items is obsolete - using loop instead (#46805) 6 years ago
Petr Ruzicka b17f02a89a with_items is obsolete - loop should be used instead (#46524) 6 years ago
Dag Wieers 4fc6ab55aa This fixes a weird indentation issue in the menu (#45089) 6 years ago
Matt Martz abe64775cf Add porting guide note about inline vars on import/include_tasks (#47121)
* Add porting guide note about inline vars. Fixes #47102
6 years ago
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.
6 years ago
Matt Clay c3a6737004 Add BOM check to shebang sanity test.
Includes fixes for docsite files with a UTF-8 BOM.
6 years ago
Alicia Cozine b26aa66a41
fixes local toc, updates language (#47054) 6 years ago
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
6 years ago
Bianca Henderson ffc46e1648 Making minor grammatical changes (#46844)
fixes to dev_guide page
6 years ago
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
6 years ago
Alicia Cozine 9764f32513 adds stub API docs in a single file (#46663)
* adds stub API docs in a single file
6 years ago
Risto Oikarinen e1cfc2500c Clean playbook filters doc by adding whitespaces (#46569) 6 years ago
Dag Wieers 1771874ac8 Indentation 6 years ago
Dag Wieers d0f3aaff62 Update wording as requested by review
Also improve wording.
6 years ago
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.
6 years ago
Mike Klebolt 5c93068223 incorrect ref (#46492) 6 years ago
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
6 years ago
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
6 years ago
Jordan Borean 1599752f26 docs: add Support section for plugin types (#46520)
* docs: add Maintenance section for plugin types
* Added supported_by name in bold to match Status
6 years ago
Sloane Hertel c4d1f0d416 Add docs for inventory caching (#46402)
* Add docs for inventory caching

* Fix subsection headers

* Fix top header
6 years ago
Matt Clay a4c9f57b38 Move docsite requirements to the docs/docsite dir. (#46518) 6 years ago
Jordan Borean b570af020c added porting guide for PowerShell EAP changes (#46451) 6 years ago
Alicia Cozine e97391b7ab updates language about documentation versions and releases on index page (#46465) 6 years ago
Dag Wieers 92037679c4 Fix subelements example correctly (#46482) 6 years ago
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.
6 years ago
Alicia Cozine ba9348883b
updates latest in docs conf.py (#46400) 6 years ago
Andrew Paradi 641c569a20 Fix spelling error in subelements Filter example (#46446)
<!--- Your description here -->

+label: docsite_pr
6 years ago
Takashi Sugimura 069ba81386 remove unnecessary space (#46462)
kindly advised from jborean93
6 years ago
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
6 years ago
Sandra McCann a1fae193c7 disable gather facts and update playbook output (#46409)
* disable facts gather and update playbook output

* fix output
6 years ago
Alicia Cozine 04b726dc14 Updates release & maintenance version docs for 2.7 6 years ago
Artur Juraszek c0de93310f Mention YAML as a AWS CloudFormation template language (#46345) 6 years ago
Enno Gröper 1ff331e66a Update playbooks_delegation.rst (#46254)
Fix example variable lookup.

+label: docsite_pr
6 years ago
Alicia Cozine 66eb5681f4 yes, we do run validate_modules in Shippable (#46280) 6 years ago
Andrii Trykush 90126f37cd Corrected typo
Corrected typo
ansible_serach_path --> ansible_search_path
+label: docsite_pr
6 years ago
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
6 years ago
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
6 years ago
Dag Wieers 771a3983d2 Docs: Keep the module index clean (#46155)
A lot of modules have a short_description with a trailing dot even
though we don't want trailing dots in the index. This change removes
it when creating the document index.
6 years ago
Sam Doran 4c929d3a7a Correct loop syntax in example (#46178) 6 years ago
Deric Crago 065b7ac300 moved 'strftime' filter into 'Other Useful Filters' section (#45801) 6 years ago
John R Barker f1038a5c05
ROADMAP_2_8 stub (#46120)
* ROADMAP_2_8 stub

* Update ROADMAP_2_8.rst
6 years ago
Rémy Léone 1d4d49369e Add a guide for Scaleway (#44810) 6 years ago
Alicia Cozine d1beb8436b restores legacy testing file (#46095)
* restores legacy testing file

* corrects links to legacy testing page

* oops, copy-pasta fix
6 years ago
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
6 years ago
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
6 years ago
Sandra McCann df3655968f Infoblox scenario guide (#45664)
* creates infoblox scenario guide
* adds link to infoblox guide from modules
* adds WAPI to prerequisites
6 years ago
Simon Metzger fc7e5f16e8 Update developing_modules_general_aci.rst
<!--- Your description here -->

+label: docsite_pr
6 years ago
Brian Coca 03d8b68549 added note about cli execution of include_x (#45227) 6 years ago
Rémy Léone d3d1ff7990 Add a guide for using Online with Ansible (#45277) 6 years ago
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
6 years ago
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
6 years ago
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
6 years ago
Eric Helms 74b94e119e Deprecate foreman and katello modules (#42043)
* Deprecate foreman and katello modules in 2.8, remove in 2.12
6 years ago
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'
6 years ago
Alicia Cozine f430f60541
Restore license agreement (#45809)
* adds page for CLA in community docs with links from dev and community docs
6 years ago
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
6 years ago
Veaceslav Mindru 84a4257774 adding git+ssh uri scheme (#36025)
* incorporates git+ssh into existing example
6 years ago
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
6 years ago
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
6 years ago
skylerbunny a892a6ef03 Add undocumented configuration parameter and explain in porting guide (#36059)
* Add undocumented configuration parameter and explain in porting guide
6 years ago
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
6 years ago
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 *)
6 years ago
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
6 years ago
Dag Wieers e038338e9f Improvements to structure 6 years ago
Jacob McGill 78d7769bd9 ACI: Move dev_guide from Wiki to Ansible docs 6 years ago
Kevin Breit 3b38bf377e meraki - Remove YAML formatting on JSON code block (#45526)
* Remove YAML formatting on JSON code block
6 years ago
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.
6 years ago
Dag Wieers 6999bf318f Fix link and toctree (#45595) 6 years ago
Pilou 95649dc793 FAQ: fix a typo, add link to 'vars' lookup (#42412)
* FAQ: add link to vars plugin doc

* Typo (s/Techinically/Technically/)
6 years ago
Dag Wieers 310b0a2521 Docs: Make docsite rebuilds smarter/faster (#45062)
* Make the following scripts  idempotent so that we only have to rebuild changed docs, not all docs:

  * plugin_formatter
  * generate_man
  * dump_keywords.py
  * dump_config.py
  * testing_formatter.sh
6 years ago
Alicia Cozine 6e68d77f6d adds license details to dev guide pages (#45574)
* adds license details to dev guide pages

* fixes capitalization error
6 years ago
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
6 years ago
Alicia Cozine 228fee4f3a lineinfile note belongs in changelog for 2.6, not 2.7 (#45517) 6 years ago
Brian Coca e9c2695ce7 updated fbsd install instructions (#45309) 6 years ago
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
6 years ago
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.
6 years ago
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
6 years ago
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
6 years ago
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>
6 years ago
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
6 years ago
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
6 years ago
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
6 years ago
Alicia Cozine 9a76441c02
rewrite of the developer guide, part 1 (#45179)
* rewrite of the developer guide, part 1
6 years ago
Brian Coca 44510448b0 prefer ansible_facts namespace and dict notation (#44980)
* prefer ansible_facts namespace and dict notation

* fixed mistranslation
6 years ago
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.
6 years ago
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
6 years ago
Brian Coca 70f3f084ac fixed chlog path 6 years ago
Sandra McCann fe119c18ef fixed formatting (#45164)
(cherry picked from commit 58ca82fa1c)
6 years ago
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
6 years ago
Sam Doran d257095976 Change Mac OSX to macOS in installation docs (#44971)
* Change Mac OSX to macOS in docs

* Lowercase via
6 years ago
Yanis Guenane 857a553fa1 Vultr: Create the Vultr Guide (#44515) 6 years ago
Brian Coca cbd54a4b2c added more reasons to avoid dot notation (#43724) 6 years ago
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.
6 years ago
Sandra McCann cccf5e6e77 fixed grammar and spelling issues (#44931)
* fixed grammar and spelling issues

* fixed autocorrect mistake and sanity test errors
6 years ago
Brian Coca 3f657ca28f clarify priority setting (#44865)
* clarify priority setting

* updated as per fb
6 years ago
Dag Wieers ac3781d40b Fix broken CI (#44937)
* Fix document structure

* Fix broken CI
6 years ago
Dag Wieers 32fc6746d8
Fix document structure (#44935) 6 years ago
Christopher Torgalson 2dfff57f57 Extends 'which notation should I use' section in FAQ (#43729)
* Extends 'which notation should I use' section in FAQ
6 years ago
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.
6 years ago