Commit graph

1472 commits

Author SHA1 Message Date
Jordan Borean
8ef2e6da05 Add support for Windows hosts in the SSH connection plugin (#47732)
* Add support for Windows hosts in the SSH connection plugin

* fix Python 2.6 unit test and sanity issues

* fix up connection tests in CI, disable SCP for now

* ensure we don't pollute the existing environment during the test

* Add connection_windows_ssh to classifier

* use test dir for inventory file

* Required powershell as default shell and fix tests

* Remove exlicit become_methods on connection

* clarify console encoding comment

* ignore recent SCP errors in integration tests

* Add cmd shell type and added more tests

* Fix some doc issues

* revises windows faq

* add anchors for windows links

* revises windows setup page

* Update changelogs/fragments/windows-ssh.yaml

Co-Authored-By: jborean93 <jborean93@gmail.com>
2019-03-07 16:38:02 -08:00
James Cassell
e55e8fe2c4 regex_escape: support POSIX basic regex (#50327) 2019-03-07 08:51:19 -05:00
Dag Wieers
f47191674e
utilities: Clean up parameter types and add seealso (#53063)
* utilities: Clean up parameter types and add seealso

* Add inventory modules

* Add more references, clarify with-loops
2019-03-07 00:25:59 +01:00
Brian Coca
c0a4cf297d add '_facts' rule to module checklist (#53359)
* add '_facts' rule to module checklist

* Update docs/docsite/rst/dev_guide/developing_modules_checklist.rst

Co-Authored-By: bcoca <bcoca@users.noreply.github.com>
2019-03-06 15:52:12 -05:00
Gonéri Le Bouder
0b579a0837 doc: preseve block-quote structure (#53293)
Without the `::`, the indentation of the example block is lost.
2019-03-06 13:45:22 -05:00
Sloane Hertel
9687879840
Fix inventory cache interface (#50446)
* Replace InventoryFileCacheModule with a better developer-interface

Use new interface for inventory plugins with backwards compatibility

Auto-update the backing cache-plugin if the cache has changed after parsing the inventory plugin

* Update CacheModules to use the config system and add a deprecation warning if they are being imported directly rather than using cache_loader

* Fix foreman inventory caching

* Add tests

* Add integration test to check that fact caching works normally with cache plugins using ansible.constants and inventory caching provides a helpful error for non-compatible cache plugins

* Add some developer documentation for inventory and cache plugins

* Add user documentation for inventory caching

* Add deprecation docs

* Apply suggestions from docs review

* Add changelog
2019-03-06 12:12:35 -06:00
Jordan Borean
6b294eab4d
win_dsc - Add argument validation and other fixes (#53093)
* win_dsc - Add argument validation and other fixes

* Fix doc issues
2019-03-06 06:49:37 +10:00
Xaroth
646a8586a5 Remove old 'srtd' theme and references. (#49289) 2019-03-05 12:22:17 -06:00
Matt Martz
a639dc6d88
Add a new check to ensure that module arguments are valid python identifiers (#53278)
* Add a new check to ensure that module arguments are valid python identifiers

* Move the check up higher, out of the if docs block

* Skip validate-modules on py2

* Remove errant alias
2019-03-05 10:26:06 -06:00
Felix Fontein
8c628c9b2c Simplify docker_*_facts return names (#51939)
* Simplify docker_*_facts return names.

* Adjust regular return values of modules to match style of docker_*_facts modules.
2019-03-05 16:09:00 +00:00
Sandra McCann
d12e3580ea replaced outdate release info with checkmarks (#53016) 2019-03-04 10:56:58 -06:00
Abhijeet Kasurde
c948849d4d VMware: vmware_vm_inventory using vaulted config (#53048)
* VMware: vmware_vm_inventory using vaulted config

Adds documentation about using vaulted inventory cofiguration file
for vmware_vm_inventory plugin.

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

* Review comments

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-03-04 10:37:57 -06:00
Chris Gavin
43042682e8 Fix an incorrect function call in a documentation example. (#53233) 2019-03-04 07:27:24 -06:00
Sebastian Wojciechowski
5cc6a70398 Remove redundant article in testing integration note (#53209) 2019-03-04 07:21:10 -06:00
Maxim Zaitsev
a015953316 Fixed a typo in playbooks_async.rst (#53200) 2019-03-04 07:16:09 -06:00
Yanis Guenane
fcec3d0600 Become plugin: Update documentation to match other plugin doc (#53266) 2019-03-04 07:13:52 -06:00
Chuck Douglas
0e9a79a589 Change the retry_files_enabled to False and modify the comments to reflect that this has been disabled (#52581)
* Change the retry_files_enabled to False and modify the comments to reflect that
this has been disabled.

* Change the default action of retry_files_enabled to False

* Update porting guide to reflect change in default state of retry_files_enabled variable

* Change log documenting a change in default behaviour of retry_files_enabled

* Revert config change to comment out the retry_files_enabled line to let the user decided what is best.
Comment above still states how to change.
2019-02-28 10:13:26 -05:00
Matt Davis
4d3a6123d5
Python interpreter discovery (#50163)
* Python interpreter discovery

* No longer blindly default to only `/usr/bin/python`
* `ansible_python_interpreter` defaults to `auto_legacy`, which will discover the platform Python interpreter on some platforms (but still favor `/usr/bin/python` if present for backward compatibility). Use `auto` to always use the discovered interpreter, append `_silent` to either value to suppress warnings.
* includes new doc utility method `get_versioned_doclink` to generate a major.minor versioned doclink against docs.ansible.com (or some other config-overridden URL)

* docs revisions for python interpreter discovery

(cherry picked from commit 5b53c0012ab7212304c28fdd24cb33fd8ff755c2)

* verify output on some distros, cleanup
2019-02-27 23:52:02 -08:00
Kevin Breit
4af5842409 Developer documentation - Change path to connection_plugins (#52577)
* Change path to connection_plugins

* Update docs/docsite/rst/dev_guide/developing_plugins.rst

Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
2019-02-27 11:53:39 -06:00
Jordan Borean
7360db5956 doc - skip/windows for integration tests (#53010) 2019-02-26 15:41:46 -06:00
Felix Fontein
c6ae23062b Deprecate returned facts. (#52518) 2019-02-26 21:37:29 +00:00
John R Barker
80cc6417fa Docs: List of Sanity Tests (#52986)
* Improve sanity test docs, how to run sanity tests section
2019-02-26 11:27:39 -06:00
Pilou
d8a2d64ec1 osx_say callback plugin: add espeak support, rename to say (#33740)
* rename into say

* add support for espeak command

* adds symlink from osx_say to say

* Update version number
2019-02-26 09:46:35 -06:00
Alicia Cozine
a361140680 Update the Loop docs (#47895)
* first review of loops page

* round two

* round three

* puts 'not deprecating' message in a note

* fixes note syntax

* clarifies loop_control sections

* loops require list input

* incorporates bcoca and sivel feedback

* fixes links

* more bcoca feedback

* adds examples to loop update guidelines

* adds explicit code-blocks

* remove stray copypasta
2019-02-26 10:40:13 -05:00
Esa Varemo
5bdc6636bc Fix the example plugin paths (#52881)
Based on https://docs.ansible.com/ansible/latest/reference_appendices/config.html
the default callback paths do not contain `_plugin`. Thus `~/.ansible/plugins/callback_plugins` and `/usr/share/ansible/plugins/plugin_type/action_plugins` are incorrect. Verified on 2.7.5 that by default `plugins/action` works and `plugins/action_plugins` does not.
2019-02-25 15:35:34 -06:00
Brian Coca
40a053ce78
better error for bad module options (#52726)
also document clearly inline vaults don't work on 'options'
  fixes #52707
2019-02-25 15:58:51 -05:00
Sam Doran
f52a088862
Add option to ignore, warn, or error when a module parameter is converted to a string (#51404)
* Add new module property to Windows modules
* Add brief pause to file tests to ensure the stat times are not equal, which was happening sometimes.
* Raise TypeError on error rather than fail_json()
* Rework error message to be less verbose
* Add porting guide entry
2019-02-22 16:44:32 -05:00
Divided by Zer0
1f06b3ca7d ungrouped as a list (#50593)
* update the developing_inventory docs to show ungrouped as a dict with a "children" key; avoid 
[WARNING]: Found both group and host with same name: ungrouped
2019-02-22 14:57:35 -06:00
Ed Costello
0e467be0f1 Update vault docs for client scripts, multiple keys and misc (#43993)
* Fix and update vault docs, add and clarify examples and options, introduce the concept of labeling a vault for clarity even if only a single password is in use for a given run, rework multi-password section to align to these concepts.

* Document -client scripts for ansible vault.

Co-Authored-By: orthanc <orthanc@users.noreply.github.com>
2019-02-22 14:22:18 -06:00
Garfield Lee Freeman
fb97204291 Deprecating panos modules; pointing to Galaxy role (#52355)
* Deprecating panos modules; pointing to Galaxy role

* Updating porting guide; deprecating panos_set

* Changing 2.11 to 2.12
2019-02-22 14:41:40 -05:00
Martin Krizek
be9f07279e Add stats on rescued/ignored tasks (#48418)
* Adding rescued/ignored tasks to stats gathering

Fixes #31245

* Amend integration tests to pass

* callback/dense.py: fix too-many-format-args

* Add changelog

* Amend counter_enabled and unixy callbacks

* Fix syntax error

* Fix typo in the changelog

* Remove not needed comment

* Re-add skipped

* Add test for rescued

* Fix colors...

* Fix unstable tests?

* Add a note to the porting guide

* Re-word the note in the porting guide

Fixes #20346
Fixes #24525
Fixes #14393

Co-authored-by: James Cammarata <jimi@sngx.net>
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
2019-02-20 13:00:47 +10:00
Mukhammad Karimov
da77057566 Update filter documentation (#52575)
Added documentation for ip4_hexr filter
2019-02-19 13:38:39 -05:00
Sandra McCann
d7f5262dad remove version detail from platform guides (#52512) 2019-02-19 10:04:07 -06:00
Abhijeet Kasurde
57d85031d7
Parse multiple values for single key in cmdline facts (#49591)
* Facts parsing for cmdline can now handle multiple values for a single key.
* Unit tests for cmdline fact parsing
* Review comments

Fixes: #22766

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-02-19 15:47:06 +05:30
Tobias Vollmer
c5a1ec4692 ansible-galaxy init does create a sub directory (#52390)
`ansible-galaxy init` creates a directory named `role_name` (in the given example) instead of adding the structure in the current working directory.

Additionally adding a clarification for repository creation as the proper repository root is not described yet.

+label: docsite_pr
2019-02-18 15:07:30 -05:00
Luke D Russell
6e739b12a6 Update network_debug_troubleshooting.rst (#52446)
<!--- Your description here -->

+label: docsite_pr
2019-02-18 14:24:10 -05:00
Hannes Ljungberg
0bf9052e06 docker_swarm_service: Remove defaults (#52420)
* Remove update_parallelism default

* Remove update_delay default

* Add documentation about removing defaults

* Present porting guide changes as a list
2019-02-18 14:19:19 -05:00
Alex Stephen
6ae04017d8 GCE deprecation warning (#52116)
* GCE deprecation warning

* porting guide typo

* fixing ignores

* moving error code back

* underscore marking on gce

* forgot to change status
2019-02-18 16:42:19 +00:00
Nicolas Quiniou-Briand
2b9341f139 fix typo in example (#52475)
Add extra space

+label: docsite_pr
2019-02-18 14:59:47 +01:00
Abhijeet Kasurde
e0d8d9c2bf validate-modules: Documentation bool (#50085)
* validate-modules: Documentation bool

This check allows to catch cases where type of argument is different than documentation does.

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

* Wrong comparison for 'str'

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

* Add ignore.txt

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

* Fix logic and clean up ignore.txt
2019-02-15 14:27:52 -08:00
David
f697e264cc doc: remove grammatical glitch (#52336) 2019-02-15 19:37:24 +01:00
Jordan Borean
de118734e9
Ansible.Basic - add required_by to module spec (#51407)
* Ansible.Basic - add required_by to module spec

* fix typo in docs
2019-02-15 13:00:25 +10:00
Jordan Borean
7b8e814a10 Ansible.Basic: make module options case insensitive with dep warning (#51583)
* Ansible.Basic: make module options case insensitive with dep warning

* Add porting guide info
2019-02-13 21:55:43 -05:00
Gavin Kyte
a722021207 Change un-ordered list to ordered (#52033)
Makes sense to make implied order explicit with an ordered list
2019-02-13 09:21:08 -06:00
Sayed Anisul Hoque
bf20c4126c Updated the ansible-galaxy docs (#52070)
* Updated the ansible-galaxy docs

<!--- Your description here -->

Updated the documentation that reflects the default branch that will be used for the `version` option in ansible-galaxy.

+label: docsite_pr

* Updated the documentation

As per the code (6d4307377f/lib/ansible/galaxy/role.py (L237))[ansible/galaxy/role.py] Defaults to the branch set as a default in the repository otherwise defaults to the master.

* Update docs/docsite/rst/reference_appendices/galaxy.rst

Co-Authored-By: anis016 <anis016@users.noreply.github.com>
2019-02-12 16:33:54 -05:00
Andrew Gaffney
9c35f18dd6 Custom jinja Undefined class for handling nested undefined attributes (#51768)
This commit creates a custom Jinja2 Undefined class that returns
Undefined for any further accesses, rather than raising an exception
2019-02-12 15:04:00 -05:00
Keith Maxwell
7fbacf920d Remove misleading statement passwords must be same (#49798)
* Remove misleading statement passwords must be same

Since 2.4 Ansible has supported multiple vault passwords:
<https://docs.ansible.com/ansible/latest/user_guide/vault.html#multiple-vault-passwords>

Meaning lines like the following are misleading:

> The password used with vault currently must be the same for all files you wish
> to use together at the same time.

-- `docs/docsite/rst/user_guide/vault.rst`

To demonstrate this with Ansible 2.7, save the following as `example.yaml`:

```
- name: Display output from two vaults with different passwords
  hosts: localhost
  connection: local
  vars_files: [one.yaml, two.yaml]
  tasks:
    - name: View secret from one.yaml vault
      debug: { var: one }
    - name: View secret from two.yaml vault
      debug: { var: two }
```

Then run the three following commands choosing two different passwords:

```
$ echo 'one: 1' | ansible-vault encrypt --vault-id id1@prompt --output=one.yaml
$ echo 'two: 2' | ansible-vault encrypt --vault-id id2@prompt --output=two.yaml
$ ansible-playbook --vault-id id1@prompt --vault-id id2@prompt example.yaml
```

`ansible-vault` stores an ID in plain text in the vault file.

* Remove note about default in Ansible 2.1

As requested by gundalow in https://github.com/ansible/ansible/pull/49798
2019-02-12 10:47:01 -05:00
Abhijeet Kasurde
fab815fc3b
VMware: Handle duplicate VM names in vmware_vm_facts (#45412)
This fix changes facts returned from vmware_vm_facts to list of dict from
dict of dict.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-02-12 16:31:42 +05:30
Evgeni Golov
ace38a2646 two indentation fixes in playbooks_reuse_roles.rst (#51934)
+label: docsite_pr
2019-02-11 14:47:09 -05:00
Matt Martz
445ff39f94
Become plugins (#50991)
* [WIP] become plugins

Move from hardcoded method to plugins for ease of use, expansion and overrides
  - load into connection as it is going to be the main consumer
  - play_context will also use to keep backwards compat API
  - ensure shell is used to construct commands when needed
  - migrate settings remove from base config in favor of plugin specific configs
  - cleanup ansible-doc
  - add become plugin docs
  - remove deprecated sudo/su code and keywords
  - adjust become options for cli
  - set plugin options from context
  - ensure config defs are avaialbe before instance
  - refactored getting the shell plugin, fixed tests
     - changed into regex as they were string matching, which does not work with random string generation
     - explicitly set flags for play context tests
 - moved plugin loading up front
 - now loads for basedir also
 - allow pyc/o for non m modules
 - fixes to tests and some plugins
 - migrate to play objects fro play_context
 - simiplify gathering
 -  added utf8 headers
 - moved option setting
 - add fail msg to dzdo
 - use tuple for multiple options on fail/missing
 - fix relative plugin paths
 - shift from play context to play
 - all tasks already inherit this from play directly
 - remove obsolete 'set play'
 - correct environment handling
 - add wrap_exe option to pfexec
 - fix runas to noop
 - fixed setting play context
 - added password configs
 - removed required false
 - remove from doc building till they are ready

future development:
  - deal with 'enable' and 'runas' which are not 'command wrappers' but 'state flags' and currently hardcoded in diff subsystems

* cleanup

  remove callers to removed func
  removed --sudo cli doc refs
  remove runas become_exe
  ensure keyerorr on plugin
  also fix backwards compat, missing method is attributeerror, not ansible error
  get remote_user consistently
  ignore missing system_tmpdirs on plugin load
  correct config precedence
  add deprecation
  fix networking imports
  backwards compat for plugins using BECOME_METHODS

* Port become_plugins to context.CLIARGS

This is a work in progress:
* Stop passing options around everywhere as we can use context.CLIARGS
  instead

* Refactor make_become_commands as asked for by alikins

* Typo in comment fix

* Stop loading values from the cli in more than one place

Both play and play_context were saving default values from the cli
arguments directly.  This changes things so that the default values are
loaded into the play and then play_context takes them from there.

* Rename BECOME_PLUGIN_PATH to DEFAULT_BECOME_PLUGIN_PATH

As alikins said, all other plugin paths are named
DEFAULT_plugintype_PLUGIN_PATH.  If we're going to rename these, that
should be done all at one time rather than piecemeal.

* One to throw away

This is a set of hacks to get setting FieldAttribute defaults to command
line args to work.  It's not fully done yet.

After talking it over with sivel and jimi-c this should be done by
fixing FieldAttributeBase and _get_parent_attribute() calls to do the
right thing when there is a non-None default.

What we want to be able to do ideally is something like this:

class Base(FieldAttributeBase):
    _check_mode = FieldAttribute([..] default=lambda: context.CLIARGS['check'])

class Play(Base):
    # lambda so that we have a chance to parse the command line args
    # before we get here.  In the future we might be able to restructure
    # this so that the cli parsing code runs before these classes are
    # defined.

class Task(Base):
    pass

And still have a playbook like this function:

---
- hosts:
  tasks:
  - command: whoami
    check_mode: True

(The check_mode test that is added as a separate commit in this PR will
let you test variations on this case).

There's a few separate reasons that the code doesn't let us do this or
a non-ugly workaround for this as written right now.  The fix that
jimi-c, sivel, and I talked about may let us do this or it may still
require a workaround (but less ugly) (having one class that has the
FieldAttributes with default values and one class that inherits from
that but just overrides the FieldAttributes which now have defaults)

* Revert "One to throw away"

This reverts commit 23aa883cbed11429ef1be2a2d0ed18f83a3b8064.

* Set FieldAttr defaults directly from CLIARGS

* Remove dead code

* Move timeout directly to PlayContext, it's never needed on Play

* just for backwards compat, add a static version of BECOME_METHODS to constants

* Make the become attr on the connection public, since it's used outside of the connection

* Logic fix

* Nuke connection testing if it supports specific become methods

* Remove unused vars

* Address rebase issues

* Fix path encoding issue

* Remove unused import

* Various cleanups

* Restore network_cli check in _low_level_execute_command

* type improvements for cliargs_deferred_get and swap shallowcopy to default to False

* minor cleanups

* Allow the su plugin to work, since it doesn't define a prompt the same way

* Fix up ksu become plugin

* Only set prompt if build_become_command was called

* Add helper to assist connection plugins in knowing they need to wait for a prompt

* Fix tests and code expectations

* Doc updates

* Various additional minor cleanups

* Make doas functional

* Don't change connection signature, load become plugin from TaskExecutor

* Remove unused imports

* Add comment about setting the become plugin on the playcontext

* Fix up tests for recent changes

* Support 'Password:' natively for the doas plugin

* Make default prompts raw

* wording cleanups. ci_complete

* Remove unrelated changes

* Address spelling mistake

* Restore removed test, and udpate to use new functionality

* Add changelog fragment

* Don't hard fail in set_attributes_from_cli on missing CLI keys

* Remove unrelated change to loader

* Remove internal deprecated FieldAttributes now

* Emit deprecation warnings now
2019-02-11 11:27:44 -06:00
James Cassell
953058d025 standardize connection variable names (#51776)
* standardize user/password connection vars

* docs: use ansible_user and ansible_password

* docs: var precedence for connection vars

* docs: ansible_become_pass -> ansible_become_password etc
2019-02-11 10:43:10 -05:00
Andrii Radyk
07cff73719 Fix yaml indentation for from_yaml_all filter example (#51998) 2019-02-10 21:21:15 +05:30
Richard Diphoorn
ad549e375a Changed 'Control Machine' to 'Control Node' (#51696)
* Changed 'Control Machine' to 'Control Node' in the documentation. Changing the term 'Control Machine' to 'Control Node', to be in line with the basic concepts here: https://docs.ansible.com/ansible/latest/network/getting_started/basic_concepts.html

Also for both entities; Control/Managed using the same common denominator 'Node' brings consistency.

* Updated reference links to new term.
2019-02-08 13:40:09 -06:00
RMuskovets
eb54dab362 Update developing_rebasing.rst (#51650) 2019-02-08 13:29:39 -06:00
Nathaniel Case
7ad238b358
Document httpapi and cliconf plugins (#49503)
* Create new documentation pages for httpapi and cliconf

* Add new documentation to plugins toctree and Makefile

* Add DOCUMENTATION to cliconf

* Apply suggestions from code review
2019-02-08 11:04:05 -05:00
Ingo Meldau
1fdceac37e Update playbooks_delegation.rst (#51949)
Changed from 'comand' to 'command'
2019-02-08 16:19:16 +05:30
Toshio Kuratomi
dfd8b659c0 Have update-bundled check for updates to all bundled code
Add a test for whether we have bundled code inside of ansible that needs to be updated
2019-02-06 13:59:55 -08:00
Sandra McCann
2c0897caf2 mention ansible-lint and editor tools that help with playbook development (#51769)
* introduce ansible-lint in playbook docs, mention editors help playbook syntax

Co-Authored-By: samccann <samccann@redhat.com>
2019-02-06 14:56:52 -06:00
Sandra McCann
d92797f594 removed old localhost content (#51839) 2019-02-06 14:16:36 -06:00
Sandra McCann
9c058d3121 Add default Network timeout values to network troubleshooting guide (#51555)
* add toc and default timeout values

* make options more obvious
2019-02-05 14:46:29 -06:00
Alex Willmer
c7f8e5d05e doc: Correct path of unit tests directory (#51631)
+label: docsite_pr
2019-02-02 00:59:13 +01:00
Wojciech Sciesinski
fbbda7267b Add a missed command (#50781)
* Add a missed command

* Link to the WinRM configuration page
2019-02-01 12:46:24 +10:00
Satyajit Bulage
dab381dd71 Broken link fixed. (#51492)
Fixes #51433

Signed-off-by: Satyajit Bulage <sbulage@redhat.com>
2019-01-31 12:53:17 -06:00
Brian Coca
4ac0c23db6
added unsafe toggle to vars_prompt (#49219)
* added unsafe toggle to vars_prompt

	fixes #47534
2019-01-30 15:01:13 -05:00
Mahendra Yadav
10a402a9c8 Update developing_modules_general_windows.rst (#51493)
<!--- Your description here -->
Typo fix
+label: docsite_pr
2019-01-30 10:16:32 -06:00
Toshio Kuratomi
b0ac7d9652 Toshio is now release manager for 2.8 and future 2.6 (#51452) 2019-01-29 18:05:59 -06:00
Brian Coca
eebece91b1 add note about register + skip (#51339)
* add note about register + skip

 fixes #27968

* Update docs/docsite/rst/user_guide/playbooks_conditionals.rst

Co-Authored-By: bcoca <bcoca@users.noreply.github.com>

* Update docs/docsite/rst/user_guide/playbooks_conditionals.rst

Co-Authored-By: bcoca <bcoca@users.noreply.github.com>
2019-01-29 16:28:18 -05:00
allan bailey
1f9ad3bf50 grammer fix and changed description to iteratively from recursively. (#50837) 2019-01-29 15:37:01 -05:00
Will Thames
23b5599244 Add k8s module_defaults group and document (#51093)
It makes sense to use module_defaults with k8s modules, and thus
have a k8s module_defaults group.
2019-01-29 14:23:27 -06:00
Ryan Merolle
8c703da46a dellos module doc updates for network_cli (#51207)
* dellos module doc updates for network_cli

* remove ansible 2.6 reference from dellos10

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* remove ansible 2.6 reference from dellos6

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* remove ansible 2.6 reference from dellos10

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* remove ansible 2.6 reference from dellos6

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* fix dellos6 register copy mistake

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* remove ansible 2.6 reference from dellos9

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* fix dellos6 register copy mistake

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* removed indicator of dellos modules being maintained by ansible network team

dellos modules are maintained by Dell

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* removed indicator of dellos modules being maintained by ansible network team

dellos modules are maintained by Dell

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* Removed indicator of dellos modules being maintained by ansible network team

DellOS modules are maintained by Dell

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>

* remove ansible 2.6 reference from dellos9

Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>
2019-01-29 15:19:55 -05:00
kysamson
60d134aeaf Clarify priority setting in Inventory doc (#51343)
* priority setting note in inventory doc

The `ansible_group_priority` variable is also described in *Using Variables* and was given a clarification in issue #41512. The variable is also documented in *Working with Inventory* without the caveat that it needs to be declared on the inventory and not a group_vars file. This change adds that as a note

+label: docsite_pr
2019-01-29 14:44:31 -05:00
Hannes Ljungberg
b426daa064 docker_swarm_service: Remove root as default user (#51110)
* Remove root as default user

* Add changelog fragment

* Add deprecation documentation

* Tweak user default docs for docker_swarm_service

Co-Authored-By: hannseman <hannes@5monkeys.se>

* Tweak user default deprecation docs

Co-Authored-By: hannseman <hannes@5monkeys.se>
2019-01-27 16:26:41 +00:00
vvvlc
48442a4a33 added pipelining for z/OS (#51212)
* added pipelining for z/OS

* Update docs/docsite/rst/reference_appendices/faq.rst

agreeed

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

agreeed

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

* Update docs/docsite/rst/reference_appendices/faq.rst

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update faq.rst

reformatted section for error message `The module libpython2.7.so was not found.`
2019-01-25 10:42:54 -05:00
Felix Fontein
4732728e40 Updating #51035: add rename to porting guide. (#51230) 2019-01-24 16:50:11 -06:00
Jeremy Booker
b787d8b23c Remove "as mentioned above" (#51295)
Remove "as mentioned above" because "variables" weren't mentioned anywhere above.
2019-01-24 16:39:24 -06:00
Felix Fontein
f6122fb63b Fix docs syntax highlighting errors (#50836)
* Add support for [WARNING]: ...

* Fix unreachable/failed output lexing.

* Detecting retry/--limit lines.

* Removing strange (invisible) characters which cause lexing problems.

* Using better-fitting lexers.

* Improve YAML lexing: don't accept quotes in keys.

* Add Django lexer (unchanged) from Pygments.

* Add support for != and % operators.
2019-01-24 16:09:41 -06:00
mclean
8e9a5c8de7 changes 'github' to 'GitHub' in community (#51111)
* changes 'github' to 'GitHub' in community
2019-01-24 14:28:39 -06:00
Brian Coca
96b3ef5553
Doc fragments to plugins (#50172)
* promote doc_fragments into actual plugins

  change tests hardcoded path to doc fragments
  avoid sanity in fragments
  avoid improper testing of doc_fragments
  also change runner paths
 fix botmeta
 updated comment for fragments
 updated docs
2019-01-23 20:03:47 -05:00
Sandra McCann
16511501b6 Remove outdated minor release info from table (#50903)
* removed outdated minor release info from table
* fixed grammar nits
* added link to releases
2019-01-23 15:22:40 -06:00
Brian Coca
9793b194b9 clarify environment (#50987)
* clarify environment

* it does work on windoez
2019-01-23 13:54:05 -06:00
Ken Dreyer
1b09197244 doc: describe merging to ansible.module_utils.* (#51152)
Add a section to the documentation describing precisely how Ansible
merges custom module_utils/* Python code into the "ansible.module_utils"
namespace.
2019-01-23 13:52:16 -06:00
Sandra McCann
47d22bbcd8 add network roles info (#49501)
* add network roles info
* add role update instructions
* implemented feedback

Co-Authored-By: samccann <samccann@redhat.com>
2019-01-23 13:36:05 -06:00
Dag Wieers
2798d5bafc
Clarify gather_facts and highlight important lines
Clarify gather_facts and highlight important lines

+label: docsite_pr
2019-01-23 17:25:24 +01:00
Felix Fontein
d2c4f57f16 docker_service: rename to docker_compose. (#51035)
* Rename docker_service -> docker_compose.

* Added changelog.

* Update scenario guide.

* Clean up module.
2019-01-23 12:21:57 +00:00
Sandra McCann
b023b89ec9 add example of hosts in multiple inventory groups (#50895)
* add example of hosts in multiple groups

* fixed spacing

* added nested group example
2019-01-22 17:49:51 +01:00
Dag Wieers
1fb2165bd8
Fix typo
+label: docsite_pr
2019-01-22 15:45:01 +01:00
Nathaniel Case
9702893729
Remove deprecated options from modules (#50246)
* Remove deprecated options from modules

* Update tests

* Add porting guide notes
2019-01-22 09:18:26 -05:00
Matt Martz
552cb1f6b9
Add porting guide note about change from 49317 (#49629) 2019-01-21 13:28:07 -06:00
Matt Martz
ab0985a83a
Update the example for API use to reflect new context object (#50723) 2019-01-21 11:21:06 -06:00
Ganesh Nalawade
1b6228fa10
Increase persistent command_timeout default value (#51056)
* Increase persistent command_timeout default value

*  Increase command_timeout default value from 10 to 30 sec
   to reduce frequent timeout issue for network connection
   types (netconf/network_cli/httpapi/napalm)

* Fix review comments
2019-01-21 10:50:52 +05:30
ABond
d55479d063 DigitalOcean module deprecation (#47272) 2019-01-19 21:25:33 +00:00
Will Thames
57a5e3e299 Merge module defaults groups docs into one page (#51045)
The information on module defaults groups would be
better alongside the rest of the module defaults docs

Remove the orphaned old doc
2019-01-18 12:13:28 -05:00
Miguel Gonzalez
8546273f5e Make module handle its own exit (#50728) 2019-01-18 12:03:59 -05:00
Alan Rominger
baf59ccaac Put in documented default for gcp_compute filters (#50025) 2019-01-18 11:39:24 +00:00
Dag Wieers
7a1ceb6988
Correct the command for test coverage
+label: docsite_pr
2019-01-16 14:42:01 +01:00
Dag Wieers
9e003d702f
Fix relative paths
+label: docsite_pr
2019-01-16 00:26:07 +01:00
Chris Nicel
94b74f1419 Update windows_setup.rst (#50941)
<!--- Your description here -->

minor spelling correction

+label: docsite_pr
2019-01-15 13:24:22 -08:00
Matt Clay
560e922440 Add more ansible-test aliases to test docs. (#50921) 2019-01-15 22:02:43 +01:00
Brian Coca
119b65f919
Clarify clear facts (#50667)
* Revert "avoid x2 setting of set_fact when 'cacheable' (#50564)"

This reverts commit 207848f354.

* clarify clear_facts with set_fact cacheable

 revert previous 'fix' as it will break playbooks by changing precedence
 opted to leave current behaviour but document it on both plugins to mitigate confusion

 fixes #50556

 also fix grammer, add comment, remove unused e
2019-01-15 15:20:33 -05:00
René Moser
d60d794411 docs: tags: streamline indentation (#50875)
* docs: tags: streamline indentation to minimal indent
2019-01-15 15:54:38 +01:00
Simon Legner
33b9c880a4 Consistent typesetting of "GitHub" (#50929) 2019-01-15 14:53:04 +01:00
branen
88029a73d6 Correct docsite typos: it's -> its (#50812) 2019-01-11 15:49:54 -05:00
Abhijeet Kasurde
af914695e6
VMware: Fix vmware_vm_inventory (#50592)
* Added documentation around using vmware dynamic inventory plugin
* Fixed bug for populating host_ip in hostvars for given inventory host
* VMware: Add properties in vmware_vm_inventory

Fixes: #50249

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-01-11 21:33:14 +05:30
Satyajit Bulage
13d94ed681 Update filter documentation (#50255)
Added documentation for following filters -

* Product
* human_readable
* human_to_bytes

Signed-off-by: Satyajit Bulage <sbulage@redhat.com>
2019-01-11 15:09:42 +05:30
Karolis Kalantojus
b5162c7a47 Documentation fix for developing own plugin (#50547)
Seems like `self` is not necessary in the call args

+label: docsite_pr
2019-01-08 16:38:29 -05:00
Brian Coca
207848f354 avoid x2 setting of set_fact when 'cacheable' (#50564)
* avoid x2 setting of set_fact when 'cacheable'

  fixes #50556

* ammend docs to new behaviour

* added period
2019-01-08 10:12:49 -05:00
René Moser
48ffe2f3b2
tests: vultr: convert legacy tests to targets (#50156) 2019-01-07 22:23:54 +01:00
Toshio Kuratomi
40e7c7a210
Add a porting guide entry for ansible_distribution facts (#50251)
* Add a porting guide entry for ansible_distribution facts

Switching away from platform.distro() will cause changes sometimes due
to the new code using new sources of information that may be out of sync
with the old ones.  Just have to make people aware of that and also what
we are doing to mitigate it when appropriate.

* wordsmithed, added links for new distro backend
2019-01-04 10:03:56 -08:00
Toshio Kuratomi
afdbb0d9d5 Save the command line arguments into a global context
* Once cli args are parsed, they're constant.  So, save the parsed args
  into the global context for everyone else to use them from now on.
* Port cli scripts to use the CLIARGS in the context
* Refactor call to parse cli args into the run() method
* Fix unittests for changes to the internals of CLI arg parsing
* Port callback plugins to use context.CLIARGS
  * Got rid of the private self._options attribute
  * Use context.CLIARGS in the individual callback plugins instead.
  * Also output positional arguments in default and unixy plugins
  * Code has been simplified since we're now dealing with a dict rather
    than Optparse.Value
2019-01-03 18:12:23 -08:00
Jonas DOREL
d9ae906772 Add galaxy.html#dependencies link (#49984)
* Add galaxy.html#dependencies link

+label: docsite_pr
2019-01-03 12:06:10 -05:00
Klaus Frank
f80ce60cf9 Make WinRM security warning more explicit (#50263)
Make WinRM security warning more explicit.
Currently the warning is "viewed by anyone", this is a much lower risk than arbitrary command injection. Therefore the risk should be phrased appropriately.

+label: docsite_pr
2019-01-03 11:43:51 -05:00
Felix Fontein
9657a21438 Docs: add Pygments lexer for Ansible output (#50318)
* Add specialized lexer for Ansible output.

* Make linter happy.

* Use different tokens.
2019-01-03 11:25:54 -05:00
Abhijeet Kasurde
ae404d1476 gcp: documentation update (#50183)
* gcp: documentation update

* Update example about dynamic inventory
* minor typo fixes in gcp_utils
* Additional information about enabling inventory plugin in ansible.cfg

partially fixes: #44404

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-01-03 10:02:46 -05:00
Abhijeet Kasurde
a45063defe Update changed_when and failed_when examples (#50411)
Added examples in playbooks_error_handling doc for handlining
multiple conditions in changed_when and failed_when

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-01-03 09:50:59 -05:00
fretis
0a56a22098 Update playbooks_loops.rst (#50437)
Error in the example for exclusion pattern

+label: docsite_pr
2019-01-03 09:36:33 -05:00
Alicia Cozine
4d6807a6b0 uses correct highlighting (#50457) 2019-01-02 13:28:35 -05:00
Aaron Surty
81a6007307 ansible-doc: update faq to include common z/OS pitfalls (#18555) (#49504)
* ansible-doc: update faq to include common z/OS pitfalls (#18555)
Co-Authored-By: gitaaron <aaron.surty@gmail.com>
2018-12-21 13:50:30 -06:00
Nathaniel Case
b2423e7602
Log device interaction and push labeled logs back to controller (#50028)
* Add session tracing support for network_cli, netconf and httapi connection

*  Add `persistent_log_messages` configuration option to log device inteaction
   in log file for network_cli, netconf and httapi connection
   type
*  Log jsonrpc request and response in log file is configuration option
   is enabled

* Update docs to talk about warning shown when persistent_log_messages is on
2018-12-21 10:31:43 -05:00
Abhijeet Kasurde
14eba662c8 Correct match test documentation (#50229)
Match test matches zero or more characters at the begining of the string.

Fixes: #32366

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-21 09:38:31 -05:00
plastikat
4b300189fd Fix docs typo at Special Variables (#50230) 2018-12-21 11:11:54 +05:30
Abhijeet Kasurde
ff49bbd15d Misc documentation update (#50190)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-20 15:50:10 -06:00
Risto Oikarinen
b2f6259259 Add more detailed documentation on how to use multiple inventories (#47586)
* Add a new section on how to use multiple inventory sources w/ examples

Co-Authored-By: zharalim <zharalim@outlook.com>
2018-12-20 15:45:41 -06:00
Jacob Floyd
069e0b8d57 Make modprobe module check for builtins as well (#37150)
Without this modprobe always reports changed when modprobe-ing a builtin module.

With this, if a kernel module is a builtin, the modprobe module will:
- succeed (without incorrectly reporting changed) if ``state`` is ``present``;
- fail if ``state`` is ``absent``

The failure will have whatever error message modprobe returns when
attempting to remove a builtin module. For example:
``modprobe: ERROR: Module nfs is builtin.``
2018-12-20 15:30:29 -06:00
Jon Pugh
e2b39a0607 Change the Packet.net section to be more consistent with the other *Cloud Guide pages. (#50170)
<!--- Your description here -->

+label: docsite_pr
2018-12-20 09:26:41 -06:00
Hans Melby
8487f2feb4 Update playbooks_intro.rst (#50187) 2018-12-20 17:43:52 +05:30
Brian Coca
b0c28f86de Revert range change (#50155)
* Revert "Fix incorrect examples with random filter (#50137)"

This reverts commit 9a7dbd5213.

The correction is incomplete and also based on a 'fix' that was supposed to have been reverted already

* Revert "Added `+1` to the `end` in `random` filter so that it was inclusive (#27215)"

This reverts commit ea2b89c7ae.

reverted fix as agreed at the time, but missed by maintainers.
2018-12-19 11:12:32 -06:00
Dmitry Lihachev
9a7dbd5213 Fix incorrect examples with random filter (#50137) 2018-12-19 12:07:17 +01:00
Sandra McCann
b873f34ea3 link to KB article -certified modules (#50050) 2018-12-17 16:27:28 -06:00
Dag Wieers
653c3da500 Fix document references in modules (#49892)
* Docs: Fixes internal module reference syntax for seealso
* Updates anchors and links
* Updates seealso in the docs for module **win_chocolatey**.
2018-12-17 10:20:06 -06:00
Jeffrey Reeves
1e647db8dc Redacted IP addresses under SSH_CLIENT & SSH_CONNECTION (#49991) 2018-12-17 09:01:53 -06:00
Martin Krizek
79947245e2 docs: remove not implemented password_hash feature (#49945) 2018-12-14 17:45:07 -06:00
Matt Martz
67ce743cc9 Remove erroneous extra-vars example, and a few really old versionadded indicators. Fixes #38415 (#49955) 2018-12-14 17:09:25 -06:00
Alicia Cozine
90a6771bc8
removes space from example of L(link) syntax (#49908) 2018-12-14 09:15:57 -06:00
Jordan Borean
8d008fed35
windows dev docs: fix a few issues and add missing info (#49836) 2018-12-14 06:00:36 +10:00
Jordan Borean
190d1ed7f1 win become: refactor and add support for passwordless become (#48082)
* win become: refactor and add support for passwordless become

* make tests more stable

* fix up dep message for Load-CommandUtils

* Add further check for System impersonation token

* re-add support for become with accounts that have no password

* doc fixes and slight code improvements

* fix doc sanity issue
2018-12-12 17:15:25 -08:00
Alicia Cozine
bd1e566c8f
link from API stub page to module_utils page (#49831) 2018-12-12 14:20:42 -06:00
Dag Wieers
baf0ad2309 Docs: Add a "seealso" section to the module docs (#45949)
* Docs: Add a separate  "seealso" section to the module docs
to list related modules and/or related references. This clears up the notes
section for things that are actual notes.

So you can add a section in your module documentation and four types of
references are possible.

    seealso:

    # Reference by module name
    - module: aci_tenant

    # Reference by module name, including description
    - module: aci_tenant
      description: ACI module to create tenants on a Cisco ACI fabric.

    # Reference by rST documentation anchor
    - ref: aci_guide
      description: Detailed information on how to manage your ACI infrastructure using Ansible.

    # Reference by Internet resource
    - name: APIC Management Information Model reference
      description: Complete reference of the APIC object model.
      link: https://developer.cisco.com/docs/apic-mim-ref/

This PR also includes:

- Implements ansible-doc support
- Implements schema support for the seealso options
- Updates to the development documentation
- Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters
  - This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again).
- We fixed the possible suboption types (which was limited to 'bool' only)

* Use latest stable instead of devel docs
2018-12-12 14:19:58 -06:00
Bianca Henderson
52843fcabc Making changes to the Community Guide index (#49670) 2018-12-12 13:49:00 -06:00
Humberto Nanni
128760cc47 Update intro_installation.rst (#49756)
directions to install ansible on CLR Linux
2018-12-12 13:17:43 -06:00
Pierre-Louis Bonicoli
7e278b23b4 inventory plugin order: update doc
add doc for #44428:
- add changelog fragment
- update porting guide
also:
- update auto inventory plugin doc
- mention toml plugin in examples
2018-12-12 09:35:13 -08:00
Pilou
1bad617f29 Inventory plugins move auto before ini (#44428)
* inventory plugins: try auto before ini

auto plugin should run before ini to avoid ini being able to parse
some plugin configuration YAML files successfully.

* Update comment

comment was added by 2ffe3c42bb but
related code was later removed by
506e6a0b2d.
2018-12-11 15:17:05 -05:00
Abhijeet Kasurde
eb61d26a2a Add missing parameter in virtualenv command (#49675)
Fixes: #43115

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-10 16:43:33 -06:00
Alicia Cozine
a71cd49a0c Style guide index (#49746)
* First revision of ansible style guide index page
2018-12-10 15:32:45 -05:00
Sandra McCann
32c2b3b3be Styleguide basic (#49747)
* cleaned up basics page

* made codeblock visible

* added anchor
2018-12-10 14:30:34 -06:00
Andreas Krüger
18bf48cec2 Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 2018-12-10 09:17:15 -06:00
Alicia Cozine
ef34b7cb83
fixes typo in windows usage guide (#49672) 2018-12-08 13:42:39 -06:00
Tim Burke
2b347d01fd Clean up some roadmap dates (#49630)
- Add year to the 2.1 roadmap.
- Move 2.6 final release from expected to actual timeline.
  As expected, v2.6.0 was tagged Jun 28.
2018-12-07 16:56:44 -06:00
trogdor_the_burninator
b3c277decc [FIX] grammatical structure of phrase (#49660) 2018-12-07 16:55:45 -06:00
Phuurl
29c96d20fb Corrects minor typos in the documentation (#49668)
Signed-off-by: Phuurl <chubble.10@icloud.com>
2018-12-07 16:54:32 -06:00
Matt Martz
9007dbec2f
Add info about loop based on jinja2 loop var (#42134)
* Add info about loop based on jinja2 loop var

* ansible_loop

* Update test count

* Add extended loop_control that defines whether ansible_loop should be added

* Extended needs to be defaulted

* Revert "Update test count"

This reverts commit f1e93ee469825f4cdcd90fb28667d29aa088275c.

* Add docs about loop_control.extended

* Add revindex and revindex0

* Document ansible_loop in special vars

* Add changelog fragment

* Add tests, change items to allitems so that dot notation works, fix logic error with previtem
2018-12-07 13:49:50 -06:00
Matt Martz
3a4d476512
Add now() jinja2 global func for getting the date/time (#43792)
* Add now() jinja2 global func for getting the date/time

* Docs and changelog

* now isn't a lookup, it doesn't need disabled
2018-12-07 11:25:53 -06:00
Tim Burke
6e43f9fe8f Fix ReST formatting for Galaxy docs link (#49575) 2018-12-06 11:06:46 -05:00
Chris St. Pierre
63b7882cbb Deprecate the github_hooks module (#49296)
It was super incomplete, and the interface was pretty strange; it had
built-in features to handle pretty bespoke workflows ("clean504",
e.g.) but was lacking lots of other useful features (like the ability
to create a webhook with a shared secret). Rather than try to update
the interface in a backwards compatible way, I've replaced it with the
more predictable, single-purpose github_webhook and
github_webhook_facts modules.
2018-12-06 15:56:53 +00:00
Toshio Kuratomi
bd7322a3f6 Simplify FactCache.update()
We only need FactCache.update() for the backwards compatibility shim as
MutableMapping.update() will do the right thing.
2018-12-05 12:33:27 -08:00
Toshio Kuratomi
33f0c1ce22 FactCache changes
* Fix FactCache to conform to the dict API
  * update needs to take a dict rather than a key and a value
  * __init__ needs to allow for setting the intial dictionary
* Remove unneeded _display and _cache attributes
* Move ansible.plugins.cache.FactCache to
  ansible.vars.fact_cache.FactCache because this isn't part of the cache
  plugin API.
* Add backwards compatibility when calling update on the new FactCache
* Remove code for calling old FactCache. There's no way to call the old
  FactCache so there's no need for backwards compatible code for calling
  code.  Backwards compatibility is handling things which are calling
  the new FactCache.
* Port our code to the new FactCache location.
2018-12-05 12:33:27 -08:00
Abhijeet Kasurde
8db7fcf45c ipaddr: Add missing documenation about network/prefix filter (#49532)
* ipaddr: Add missing documenation about network/prefix

Fixes: #17871

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-05 12:14:13 -05:00
Abhijeet Kasurde
287a42eba0 Added recommendation about module name (#49540)
* Added recommendation about module name

Added general guidelines for naming a module.

Fixes: #19665

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-05 10:30:40 -05:00
mbk87
95d810ab94 apt over apt-get (#47663)
* apt over apt-get

* added note on apt-get for older versions
2018-12-05 09:14:48 -05:00
Dag Wieers
257a8af922
Fix typo
Fix a small typo

+label: docsite_pr
2018-12-05 03:20:10 +01:00
owenmann
23637aa349 Update faq.rst: typo (#49491)
* Update faq.rst

<!--- Your description here -->
minor: typo

+label: docsite_pr
2018-12-04 15:44:29 -05:00
Martin Krizek
d20d66dc2f docs: try to clarify handlers a bit more (#49322)
* docs: try to clarify handlers a bit more
* docs: refines description of duplicate handler names
2018-12-03 15:21:59 -06:00
Alicia Cozine
8d01e26d18 Refines docs on creating action plugins (#49392)
* Refines docs on creating action plugins

Co-Authored-By: acozine <879121+acozine@users.noreply.github.com>
2018-12-03 10:44:15 -05:00
John R Barker
092f75cee4 Only one strategy_plugins page (#49442) 2018-12-03 20:35:01 +05:30
Abhijeet Kasurde
45e41f5a3d Add Action plugin example (#49290)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-11-30 15:53:38 -06:00
XOmniverse
5c525f9466 Update intro_inventory.rst to show YAML ranges (#49265)
Adds a YAML example inventory listing a range of hosts to complement existing INI example.
2018-11-30 14:29:57 -06:00
Ian Wienand
44c734e624 Local test docs: correct tox shell command usage (#49350)
The ansible-test shell command doesn't have a --python option; you
have to specify the tox environment directly to the --tox command

Partially fixes: #49349
2018-11-30 13:16:01 -06:00
Chris Archibald
73348ae32d Fixes for na_ontap_cluster_peer (#48329)
* Fixes for na_ontap_cluster_peer, incorporating review comments, version, etc.
2018-11-29 16:22:02 -06:00
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
2018-11-29 16:17:59 -06:00
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>
2018-11-29 15:42:10 -06:00
Alicia Cozine
02baae6e99 revises inventory intro page (#49330)
* revises inventory intro page

* changes :doc: to :ref: for links
2018-11-29 16:33:29 -05:00
Alicia Cozine
e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 14:03:00 -06:00
Brian Coca
8461321a6a clarify registered vs facts (#45432)
* clarify registered vs facts

fixes #45411

* wordsmithing
2018-11-29 15:00:36 -05:00
Brian Coca
7f04ee1eb4 corrected action plugin docs (#49321)
fixes #49277
2018-11-29 14:44:16 -05:00
David M Noriega
0922a6566d Adding note on async+check mode incompatibility (#41427)
Fixes ansible/ansible#40991
2018-11-29 10:33:43 -05:00
Xaroth
59e7a9442e -Change: set the 'canonical_url' theme option to enable rendering of canonical urls, promoting the 'latest' docs to search engines. (#49190) 2018-11-27 10:35:50 -06:00
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.
2018-11-26 15:55:25 -06:00
John R Barker
c3d579c52a Docker & Remote Management Working Groups (#49023)
* Adds Docker & Remote Management Working Groups
2018-11-26 13:27:47 -06:00
John R Barker
3433ca286d Docs reorg /community/index & /dev_guide/index (#48734)
* Improved community/index.rst makes it easier to find existing content
2018-11-26 13:00:26 -06:00
Matt Martz
7287d396e2 Prevent metadata changes in a stable branch (#48994) 2018-11-26 14:51:39 +00:00
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>
2018-11-24 12:02:04 +05:30
johnstudarus
679b7dce63 Update guide_packet.rst (#49007)
Properly parses the returned data to get the device data and IP address. 


+label: docsite_pr
2018-11-22 16:53:24 +00:00
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
2018-11-22 08:14:43 +00:00
Yunge Zhu
d3b52d2a72 fix xxx.com (#48972) 2018-11-21 11:28:30 +08:00
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
2018-11-20 17:06:51 -06:00
Wojciech Sciesinski
cebe64ac0c Add a missed command (#48857)
adds command to set the environment for the hacking script
2018-11-20 14:14:18 -06:00
Andreas Krüger
e1fbd54ebb Add link to include / import module doc to discussion of include / import. (#48932) 2018-11-20 14:02:58 -06:00
Bianca Henderson
89a9bc0488 Change intro portion of Testing page (#48692)
* Change intro portion of Testing page
2018-11-20 09:43:53 -05:00
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.
2018-11-19 09:59:54 +00:00
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.
2018-11-19 01:50:20 -05:00
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.
2018-11-16 16:38:47 -08:00
Alex Ratner
0c7f6e5047 fixes for typos, grammar, and links (#48721)
* fixes for typos, grammar, and links on magic vars page
2018-11-15 17:46:41 -06:00
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)
2018-11-15 16:17:29 -05:00
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.
2018-11-15 10:01:29 -05:00
Martin Krizek
9ce9c9698a committer_guidelines.rst: update core committers (#48662)
* committer_guidelines.rst: update core committers

* Another update
2018-11-14 15:07:57 -05:00
Toshio Kuratomi
b759862daa Add an example to serial usage (#48669) 2018-11-14 11:57:10 -05:00
Dylan Silva
498bb74717 Updated roadmap to reflect dates for 2.8 (#48626)
* Updated roadmap to reflect dates for 2.8
2018-11-14 15:54:15 +00:00
Matt Clay
1a3bf09f8a
Add test to require docs for action plugins. (#48376) 2018-11-13 22:52:36 -08:00
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
2018-11-13 22:42:02 +00:00
Michael Scherer
2ca7279cae Correct the variable name in example (#48603)
Changed from 'ansilbe_python_interpreter' to 'ansible_python_interpreter'
2018-11-13 22:00:13 +05:30
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
2018-11-13 09:29:39 -06:00