Commit Graph

1908 Commits (4eba84ce78a70cd1ddfd825afc8b08b2b602b57f)

Author SHA1 Message Date
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>
6 years ago
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
6 years ago
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
6 years ago
Abhijeet Kasurde a6ecbe7a4b
Check metadata.status presence (#50416)
Generate error if metadata.status is empty or missing.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
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>
6 years ago
Evgeni Golov ace38a2646 two indentation fixes in playbooks_reuse_roles.rst (#51934)
+label: docsite_pr
6 years ago
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
6 years ago
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
6 years ago
Andrii Radyk 07cff73719 Fix yaml indentation for from_yaml_all filter example (#51998) 6 years ago
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.
6 years ago
RMuskovets eb54dab362 Update developing_rebasing.rst (#51650) 6 years ago
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
6 years ago
Ingo Meldau 1fdceac37e Update playbooks_delegation.rst (#51949)
Changed from 'comand' to 'command'
6 years ago
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
6 years ago
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>
6 years ago
Sandra McCann d92797f594 removed old localhost content (#51839) 6 years ago
Sandra McCann 9c058d3121 Add default Network timeout values to network troubleshooting guide (#51555)
* add toc and default timeout values

* make options more obvious
6 years ago
Alex Willmer c7f8e5d05e doc: Correct path of unit tests directory (#51631)
+label: docsite_pr
6 years ago
Wojciech Sciesinski fbbda7267b Add a missed command (#50781)
* Add a missed command

* Link to the WinRM configuration page
6 years ago
Bianca Henderson 51ac4d3441 Update Ansible docsite CSS to fix multi-page printing issue (#51472)
* Update css to fix multi-page printing issue

* Add margin edit
6 years ago
Satyajit Bulage dab381dd71 Broken link fixed. (#51492)
Fixes #51433

Signed-off-by: Satyajit Bulage <sbulage@redhat.com>
6 years ago
Brian Coca 4ac0c23db6
added unsafe toggle to vars_prompt (#49219)
* added unsafe toggle to vars_prompt

	fixes #47534
6 years ago
Mahendra Yadav 10a402a9c8 Update developing_modules_general_windows.rst (#51493)
<!--- Your description here -->
Typo fix
+label: docsite_pr
6 years ago
Toshio Kuratomi b0ac7d9652 Toshio is now release manager for 2.8 and future 2.6 (#51452) 6 years ago
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>
6 years ago
allan bailey 1f9ad3bf50 grammer fix and changed description to iteratively from recursively. (#50837) 6 years ago
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.
6 years ago
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>
6 years ago
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
6 years ago
Dag Wieers 49afb3da34 Update Docsite edit (#51115)
* Improved template for docsite edits
6 years ago
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>
6 years ago
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.`
6 years ago
Felix Fontein 4732728e40 Updating #51035: add rename to porting guide. (#51230) 6 years ago
Jeremy Booker b787d8b23c Remove "as mentioned above" (#51295)
Remove "as mentioned above" because "variables" weren't mentioned anywhere above.
6 years ago
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.
6 years ago
mclean 8e9a5c8de7 changes 'github' to 'GitHub' in community (#51111)
* changes 'github' to 'GitHub' in community
6 years ago
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
6 years ago
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
6 years ago
Brian Coca 9793b194b9 clarify environment (#50987)
* clarify environment

* it does work on windoez
6 years ago
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.
6 years ago
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>
6 years ago
Sandra McCann 3eec7f1820 Modules tocfix (#51077)
define & create subcategories, output by category and subcat
6 years ago
Dag Wieers 2798d5bafc
Clarify gather_facts and highlight important lines
Clarify gather_facts and highlight important lines

+label: docsite_pr
6 years ago
Felix Fontein d2c4f57f16 docker_service: rename to docker_compose. (#51035)
* Rename docker_service -> docker_compose.

* Added changelog.

* Update scenario guide.

* Clean up module.
6 years ago
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
6 years ago
Dag Wieers 1fb2165bd8
Fix typo
+label: docsite_pr
6 years ago
Nathaniel Case 9702893729
Remove deprecated options from modules (#50246)
* Remove deprecated options from modules

* Update tests

* Add porting guide notes
6 years ago
Matt Martz 552cb1f6b9
Add porting guide note about change from 49317 (#49629) 6 years ago
Matt Martz ab0985a83a
Update the example for API use to reflect new context object (#50723) 6 years ago
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
6 years ago
ABond d55479d063 DigitalOcean module deprecation (#47272) 6 years ago
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
6 years ago
Miguel Gonzalez 8546273f5e Make module handle its own exit (#50728) 6 years ago
Alan Rominger baf59ccaac Put in documented default for gcp_compute filters (#50025) 6 years ago
Dag Wieers 7a1ceb6988
Correct the command for test coverage
+label: docsite_pr
6 years ago
Dag Wieers 9e003d702f
Fix relative paths
+label: docsite_pr
6 years ago
Chris Nicel 94b74f1419 Update windows_setup.rst (#50941)
<!--- Your description here -->

minor spelling correction

+label: docsite_pr
6 years ago
Matt Clay 560e922440 Add more ansible-test aliases to test docs. (#50921) 6 years ago
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
6 years ago
René Moser d60d794411 docs: tags: streamline indentation (#50875)
* docs: tags: streamline indentation to minimal indent
6 years ago
Simon Legner 33b9c880a4 Consistent typesetting of "GitHub" (#50929) 6 years ago
branen 88029a73d6 Correct docsite typos: it's -> its (#50812) 6 years ago
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>
6 years ago
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>
6 years ago
Dag Wieers 646c34dcde Docs: Fix highlight line (#50756) 6 years ago
Karolis Kalantojus b5162c7a47 Documentation fix for developing own plugin (#50547)
Seems like `self` is not necessary in the call args

+label: docsite_pr
6 years ago
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
6 years ago
René Moser 48ffe2f3b2
tests: vultr: convert legacy tests to targets (#50156) 6 years ago
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
6 years ago
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
6 years ago
Jonas DOREL d9ae906772 Add galaxy.html#dependencies link (#49984)
* Add galaxy.html#dependencies link

+label: docsite_pr
6 years ago
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
6 years ago
Felix Fontein 9657a21438 Docs: add Pygments lexer for Ansible output (#50318)
* Add specialized lexer for Ansible output.

* Make linter happy.

* Use different tokens.
6 years ago
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>
6 years ago
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>
6 years ago
fretis 0a56a22098 Update playbooks_loops.rst (#50437)
Error in the example for exclusion pattern

+label: docsite_pr
6 years ago
Felix Fontein 4c473ecef4 Sort suboptions and subresults in docs. (#50315)
Fixes #50041.
6 years ago
Alicia Cozine 4d6807a6b0 uses correct highlighting (#50457) 6 years ago
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>
6 years ago
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
6 years ago
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>
6 years ago
plastikat 4b300189fd Fix docs typo at Special Variables (#50230) 6 years ago
Abhijeet Kasurde ff49bbd15d Misc documentation update (#50190)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
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>
6 years ago
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.``
6 years ago
Dag Wieers 76450fd1c2
Docs: Show parameter types (in purple) (#49966)
* Docs: Show parameter types (in purple)

* Changes based on feedback

* Remove leftover statement after review

* Simplify TOC and support section

* Add missing 'v' to version_added

* Remove the v for version

* Update docs/templates/plugin.rst.j2

Co-Authored-By: dagwieers <dag@wieers.com>

* Update docs/templates/plugin.rst.j2

Co-Authored-By: dagwieers <dag@wieers.com>

* Move Author into Support section

* Avoid more "isn't included in any toctree" errors

* Add Red Hat support section, list module status
6 years ago
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
6 years ago
Hans Melby 8487f2feb4 Update playbooks_intro.rst (#50187) 6 years ago
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.
6 years ago
Dmitry Lihachev 9a7dbd5213 Fix incorrect examples with random filter (#50137) 6 years ago
Dag Wieers ee29ba5d4f plugin_formatter.py: Improve the output when processing docs (#46541)
* Improve the output when processing files

* Update docs/bin/plugin_formatter.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Show progress indicator.

* Don't pp.pformat() huge structures when they aren't used anyway.

This saves ~10 seconds on my machine.

* Only show ASCII spinner if stdout is a TTY.

* Fix: E722 do not use bare 'except'
6 years ago
Dag Wieers 9bc401a272 Remove older version_added information from docs (#50097) 6 years ago
Sandra McCann b873f34ea3 link to KB article -certified modules (#50050) 6 years ago
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**.
6 years ago
Jeffrey Reeves 1e647db8dc Redacted IP addresses under SSH_CLIENT & SSH_CONNECTION (#49991) 6 years ago
Toshio Kuratomi 3fba006207 Update bare exceptions to specify Exception.
This will keep us from accidentally catching program-exiting exceptions
like KeyboardInterupt and SystemExit.
6 years ago
Martin Krizek 79947245e2 docs: remove not implemented password_hash feature (#49945) 6 years ago
Matt Martz 67ce743cc9 Remove erroneous extra-vars example, and a few really old versionadded indicators. Fixes #38415 (#49955) 6 years ago
Alicia Cozine 90a6771bc8
removes space from example of L(link) syntax (#49908) 6 years ago
Jordan Borean 8d008fed35
windows dev docs: fix a few issues and add missing info (#49836) 6 years ago
Brian Coca f645680fee corrected docs on args 6 years ago
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
6 years ago
Alicia Cozine bd1e566c8f
link from API stub page to module_utils page (#49831) 6 years ago
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
6 years ago
Bianca Henderson 52843fcabc Making changes to the Community Guide index (#49670) 6 years ago
Humberto Nanni 128760cc47 Update intro_installation.rst (#49756)
directions to install ansible on CLR Linux
6 years ago
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
6 years ago
Evgeni Golov 32dbb99bb8 plugin_formatter.py: accept multiple template dirs (#49765)
this allows to override certain templates without copying the whole
template directory
6 years ago
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.
6 years ago
Abhijeet Kasurde eb61d26a2a Add missing parameter in virtualenv command (#49675)
Fixes: #43115

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Alicia Cozine a71cd49a0c Style guide index (#49746)
* First revision of ansible style guide index page
6 years ago
Sandra McCann 32c2b3b3be Styleguide basic (#49747)
* cleaned up basics page

* made codeblock visible

* added anchor
6 years ago
Andreas Krüger 18bf48cec2 Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 6 years ago
Alicia Cozine ef34b7cb83
fixes typo in windows usage guide (#49672) 6 years ago
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.
6 years ago
trogdor_the_burninator b3c277decc [FIX] grammatical structure of phrase (#49660) 6 years ago
Phuurl 29c96d20fb Corrects minor typos in the documentation (#49668)
Signed-off-by: Phuurl <chubble.10@icloud.com>
6 years ago
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
6 years ago
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
6 years ago
Tim Burke 6e43f9fe8f Fix ReST formatting for Galaxy docs link (#49575) 6 years ago
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.
6 years ago
Pilou 7fd8d8d8c7 doc: fix link to ansible-config (#49597) 6 years ago
Toshio Kuratomi bd7322a3f6 Simplify FactCache.update()
We only need FactCache.update() for the backwards compatibility shim as
MutableMapping.update() will do the right thing.
6 years ago
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.
6 years ago
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>
6 years ago
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>
6 years ago
mbk87 95d810ab94 apt over apt-get (#47663)
* apt over apt-get

* added note on apt-get for older versions
6 years ago
Dag Wieers 257a8af922
Fix typo
Fix a small typo

+label: docsite_pr
6 years ago
owenmann 23637aa349 Update faq.rst: typo (#49491)
* Update faq.rst

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

+label: docsite_pr
6 years ago
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
6 years ago
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>
6 years ago
John R Barker 092f75cee4 Only one strategy_plugins page (#49442) 6 years ago
Abhijeet Kasurde 45e41f5a3d Add Action plugin example (#49290)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
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.
6 years ago
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
6 years ago
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