Commit graph

1591 commits

Author SHA1 Message Date
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
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
Evgeni Golov
32dbb99bb8 plugin_formatter.py: accept multiple template dirs (#49765)
this allows to override certain templates without copying the whole
template directory
2018-12-11 16:19:40 -05: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