Commit graph

1607 commits

Author SHA1 Message Date
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
Dag Wieers
646c34dcde Docs: Fix highlight line (#50756) 2019-01-11 09:13:08 +01:00
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
Felix Fontein
4c473ecef4 Sort suboptions and subresults in docs. (#50315)
Fixes #50041.
2019-01-02 15:40:44 -06: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
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
2018-12-20 18:34:32 +01: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
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'
2018-12-18 11:23:49 -06:00
Dag Wieers
9bc401a272 Remove older version_added information from docs (#50097) 2018-12-18 10:50:07 -06: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
Toshio Kuratomi
3fba006207 Update bare exceptions to specify Exception.
This will keep us from accidentally catching program-exiting exceptions
like KeyboardInterupt and SystemExit.
2018-12-16 15:03:19 -08: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
Brian Coca
f645680fee corrected docs on args 2018-12-13 10:56:33 -05:00