1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

1476 commits

Author SHA1 Message Date
Will Thames
ab55726fad Clarify module documentation
Make the position on _facts modules more emphatic
Add documentation for RETURN structure
2015-10-29 10:02:59 +10:00
Lars Kellogg-Stedman
097adec834 add documentation for with_file loops
This commit adds documentation for the `with_file` loop construct,
resolving #7890 and #9160.
2015-10-28 16:56:21 -04:00
Brian Coca
46acf892d5 clarified ignore_errors 2015-10-27 19:59:43 -04:00
Petrox
cad053af04 Typo fix: invenotry to inventory
Typo fix: invenotry to inventory :)
2015-10-27 22:54:14 +01:00
Brian Coca
6637982deb added docs for include with_items and usage of multiple lopo vars (item) 2015-10-23 10:32:31 -04:00
Sandra Wills
bc14ed380e variables precedence reordering and added para to help explain precedence rules 2015-10-22 09:12:43 -04:00
Aidan Hobson Sayers
9f8c4d716a Document setting environment variables in a playbook 2015-10-22 12:07:54 +01:00
Borys Borysenko
126276ce6c Fix order of handlers that were notified in different sections 2015-10-21 11:00:47 +03:00
José Moreira
25e4a3ad2a Fixed docs typo 2015-10-20 16:38:16 +01:00
Brano Zarnovican
84967e282a DOC: in yum examples, 'pkg' arg renamed to 'name'
* alternating both pkg/name in examples might be confusing
* even if pkg= is working, it is not documented in
  module's refrence guide
2015-10-20 13:49:04 +02:00
Nick Cartwright
17469d0781 Fix typo: comma not colon separates groups in patterns 2015-10-16 04:30:46 +01:00
Ryan S. Brown
48e1396496 Add -y to yum command, otherwise it would hang indefinitely 2015-10-15 13:55:53 -04:00
Ryan S. Brown
9dcde77e0e Document using the raw module to install a py2.X and simplejson
In the installation guide, the raw module is mentioned as an option for
installing Python or simplejson on managed nodes that don't have them.
This change adds an example for users that may already be familiar with
using ansible but are checking install docs because they don't know the
requirements for managed nodes, or are using a distribution that doesn't
include Python 2 by default.
2015-10-15 13:35:07 -04:00
Sandra Wills
ce0cedc4a7 Merge pull request #12764 from docschick/docschick-fixes
vault and variables best practices info added, edited, and referenced
2015-10-15 10:01:06 -04:00
Sandra Wills
8501a46baa vault and variables best practices info added, edited, and referenced
This work fulfills PR #11799. Moved the content out of the vault file,
into best practices, edited it, then referenced it from variables and
vaults content files.
2015-10-15 09:55:17 -04:00
jdelaporte
c2a5381438 Fix links to dynamic inventory script example.
:doc`aws_example` no longer existed.
2015-10-14 12:17:05 -05:00
Sandra Wills
1918604e72 reordering entries in glossary for alphabetical order 2015-10-14 11:37:27 -04:00
Toshio Kuratomi
3f2efddeb2 Merge pull request #12733 from docschick/ansible_ssh_docswork
added "include" for ansible_ssh_ change to another section
2015-10-13 11:22:31 -07:00
Sandra Wills
7dfce28e9a added "include" for ansible_ssh_ change note to another section of intro_inventory.rst for clarity 2015-10-13 13:59:44 -04:00
James Cammarata
76c8318351 Merge pull request #12688 from docschick/ansible_ssh_docswork
Ansible ssh changes docswork
2015-10-13 07:59:49 -04:00
Sandra Wills
32cb2fa215 removed repetition of note and replaced with an include directive
ansible_ssh_* changes from 1.9 to 2.0, original note made into a separate file
for easier editing, and an include for this new file added to each of the 6 file affected
by this change
2015-10-12 11:41:09 -04:00
Sandra Wills
748ff72b6b fixed typo, depricated --> deprecated, in all 6 notes 2015-10-12 08:01:24 -04:00
Toshio Kuratomi
6292520c45 Merge pull request #12444 from knakayama/bugfix/update-docs
Update docs (playbooks_loops.rst, playbooks_filters.rst)
2015-10-09 20:09:53 -07:00
Toshio Kuratomi
d660381f98 Merge pull request #12450 from glnds/devel
Installation update for people using Fishshell
2015-10-09 19:39:30 -07:00
Toshio Kuratomi
676e4232e3 Merge pull request #12438 from lekum/doc_shelvefile_lookup
Update lookups doc with shelvefile example
2015-10-09 14:34:51 -07:00
Sandra Wills
84240c9f28 fixed git conflict with double para 2015-10-08 21:44:50 -04:00
Sandra Wills
f24fbb04c9 note modified a bit, then reviewed/approved by jmartin
Ansible 2.0 has depricated the “ssh” from ansible_ssh_user,
ansible_ssh_host, and ansible_ssh_port to become ansible_user,
ansible_host, and ansible_port. If you are using a version of
Ansible prior to 2.0, you should continue using the older style
variables (ansible_ssh_*). These shorter variables are ignored,
without warning, in older versions of Ansible.
2015-10-08 21:41:27 -04:00
Sandra Wills
6af2b2a4cb added note about ansible_ssh_* change
added a note like the following to each file hit with unlabled 2.0 changes...
Ansible 2.0 moved away from using ansible_ssh_* variables to accepting
ansible_* variables. If you are using a version of Ansible prior to 2.0,
you should continue using the older style variables (ansible_ssh_*), such
as ansible_ssh_user instead of ansible_user and ansible_ssh_port instead of
ansible_port, which appear in the following content. These shorter variables
are ignored, without warning, in older versions of Ansible.
2015-10-08 21:39:26 -04:00
Bill Nottingham
aec58bfbb3 Update playbooks_blocks.rst
Remove heading that appears to be extraneous.
2015-10-07 14:26:23 -04:00
deyvsh
155282f94a Indicate that credstash plugin is new in v2
Also offer a poor-man's alternative.
2015-10-07 17:40:50 +01:00
James Cammarata
fb0294be03 Merge pull request #12657 from jhawkesworth/powershell_strict_mode_version_2
Explictly set the version of strict mode to use for powershell modules.
2015-10-07 10:30:36 -04:00
deyvsh
c4c8493f1b Add an example for map() to the filters page 2015-10-07 12:33:39 +01:00
=
345ce424c6 Explictly set the version of strict mode to use for powershell modules. 2015-10-07 06:24:37 +01:00
Brian Coca
130ba70598 added missing blank line for markup separation 2015-10-05 09:05:59 -04:00
Brian Coca
da458bbfd6 added way to display inventory vars for host to faq + some minor fixes/edits 2015-10-05 08:57:43 -04:00
Abhijit Menon-Sen
478e234bc3 Reword the jump host section in the FAQ
It's just s/extra_args/common_args/, but I reworded some parts to make
things a bit clearer too.

Closes #12335
2015-10-02 21:26:25 +05:30
Abhijit Menon-Sen
3ad9b4cba6 Rework additional ssh argument handling
Now we have the following ways to set additional arguments:

1. [ssh_connection]ssh_args in ansible.cfg: global setting, prepended to
   every command line for ssh/scp/sftp. Overrides default ControlPersist
   settings.
2. ansible_ssh_common_args inventory variable. Appended to every command
   line for ssh/scp/sftp. Used in addition to ssh_args, if set above, or
   the default settings.
3. ansible_{sftp,scp,ssh}_extra_args inventory variables. Appended to
   every command line for the relevant binary only. Used in addition to
   #1 and #2, if set above, or the default settings.
3. Using the --ssh-common-args or --{sftp,scp,ssh}-extra-args command
   line options (which are overriden by #2 and #3 above).

This preserves backwards compatibility (for ssh_args in ansible.cfg),
but also permits global settings (e.g. ProxyCommand via _common_args) or
ssh-specific options (e.g. -R via ssh_extra_args).

Fixes #12576
2015-10-02 21:26:25 +05:30
Brian Coca
00b8a24299 Merge pull request #12579 from acogdev/devel
Alphabitize retry_files_enabled and retry_files_save_path
2015-10-01 20:01:04 -04:00
Brian Coca
75f99f873b Merge pull request #12379 from bcoca/document_vars
Document vars

merging so we can push PRs against the common repo
2015-10-01 12:57:51 -04:00
Trond Hindenes
e9786db541 Windows: Updated docs to reflect the new name of get-attr, along with examples 2015-09-30 23:29:05 +02:00
acogdev
e6958df9a8 Put retry_files_enabled and retry_files_save_path into alphabetical order. Found when investigating #11491 2015-09-30 13:41:51 -06:00
Brian Coca
d380cc7e7d Merge pull request #12543 from DevOps4Networks/devel
Guidance for pycrypto install on Mac OSX
2015-09-30 11:10:53 -04:00
Nathan Sowatskey
e7029a90e6 #12454 changing to footnote. 2015-09-30 10:45:43 +02:00
Austin Ziegler
67a980c9ef Describe the units for fact_caching_timeout 2015-09-29 11:59:55 -04:00
Nathan Sowatskey
68a927466e Updating Mac OSX guidance comment to make it a note for issue #12454. 2015-09-29 11:14:28 +02:00
Nathan Sowatskey
420589c715 Adding Mac OSX guidance comment for issue #12454. 2015-09-29 11:10:26 +02:00
Toshio Kuratomi
4225c0677d Merge pull request #12548 from amenonsen/pr-9130-rebase
#9130 rebase: EC2 Inventory Boto Profile Support
2015-09-28 10:47:12 -07:00
Jameel Al-Aziz
c08137a3d2 Update ec2 inventory documentation to refer to AWS_PROFILE 2015-09-28 21:35:46 +05:30
willthames
9c967dd054 Allow ec2 inventory to use a boto profile
This allows the EC2 inventory plugin to be used with
the same configuration against different EC2 accounts

Profile can be passed using --profile variable or using
EC2_PROFILE environment variable e.g.

```
EC2_PROFILE=prod ansible-playbook -i ec2.py playbook.yml
```

Added documentation on profiles to EC2 dynamic inventory doc

Only tries to use profiles if --profile argument is given
or EC2_PROFILE is set to maintain compatibility will boto < 2.24.

Works around a minor bug in boto where if you try and use
a security token with a profile it fails (boto/boto#2100)
2015-09-28 21:35:46 +05:30
Abhijit Menon-Sen
d4af7d256b Mention ansible_ssh_pipelining in intro_inventory 2015-09-28 20:55:14 +05:30
Nathan Sowatskey
ee6317ca07 Adding Mac OSX guidance comment for issue #12454. 2015-09-28 15:46:37 +02:00
Nathan Sowatskey
c8835b873b Adding Mac OSX guidance comment for issue #12454. 2015-09-28 15:40:32 +02:00
Nathan Sowatskey
f5c453f2b2 Adding Mac OSX guidance comment for issue #12454. 2015-09-28 15:39:35 +02:00
Brian Coca
b757798f3e Merge pull request #12483 from jeffwidman/patch-2
Clarified that .yml, .yaml, and .json are allowable file extensions for inventory vars files
2015-09-25 20:45:53 -04:00
Marius Gedminas
b57d549e16 Typo in shell command in example 2015-09-25 10:27:35 +03:00
Jeff Widman
3f135e3fac Clarified that .yml, .yaml, and .json are allowable file extensions for inventory variables files. 2015-09-22 17:56:04 -07:00
Jeff Widman
983ee0898d Add mention of roles_path parameter to ansible-galaxy install command 2015-09-22 15:03:40 -07:00
Nathaniel Schaaf
356cae9e5d Fix typo 2015-09-21 09:59:28 -05:00
Gert Leenders
2dc61bc73f Installation update for people using Fishshell 2015-09-21 11:31:44 +02:00
knakayama
f717f14fe9 Update docs (playbooks_loops.rst, playbooks_filters.rst) 2015-09-20 22:48:07 +09:00
Toshio Kuratomi
b11a44e5b4 Merge pull request #12097 from mgedmin/patch-1
Fix typo, remove redundant paragraph
2015-09-20 05:45:06 -07:00
James Cammarata
37f2cbc429 Merge pull request #12436 from amenonsen/ranges
Support «hosts: foo[1:]» and add tests for split/apply_subscript
2015-09-18 15:32:15 -04:00
Brian Coca
5dd61ad3fe Merge pull request #12409 from mgedmin/patch-2
Fix example formatting in the documentation
2015-09-18 14:21:58 -04:00
Abhijit Menon-Sen
2fcdb37e7b Support «hosts: groupname[1:]» notation (~= 'the rest of the group') 2015-09-18 22:28:34 +05:30
Alejandro Guirao
8288e27051 Update lookups doc with shelvefile example 2015-09-18 14:51:03 +02:00
James Cammarata
951128d7a6 Merge branch 'hostpatterns' of https://github.com/amenonsen/ansible into amenonsen-hostpatterns 2015-09-17 13:31:51 -04:00
James Cammarata
ba82e57445 Merge branch 'sudo_on_if_needed' of https://github.com/apollo13/ansible into apollo13-sudo_on_if_needed 2015-09-17 11:03:27 -04:00
Abhijit Menon-Sen
b47bc343ea Document , instead of : in intro_patterns, update changelog 2015-09-17 19:34:19 +05:30
Florian Apolloner
d9f873495e Ported over #7158 to support SELinux context switches. 2015-09-17 15:03:46 +02:00
Paul Freeman
f14c617084 Documentation for retry_files_enabled and retry_files_save_path 2015-09-17 11:59:32 +01:00
Marius Gedminas
5d3d53e890 Fix example formatting 2015-09-17 11:05:37 +03:00
James Cammarata
0685262d06 Merge pull request #12397 from lambeau/devel
Fix spelling
2015-09-16 16:44:09 -04:00
Chris Church
c5409ab493 Remove ansible_winrm_ host/port/user/pass options, update exception handling around establishing a winrm connection. 2015-09-16 16:38:19 -04:00
Chris Church
056c6b77d0 Support additional options for WinRM connections via inventory variables. 2015-09-16 16:38:18 -04:00
Joshua Kugler
3004e9bec8 Fixing a small typo
Just adding a missing letter.
2015-09-16 11:00:19 -08:00
Nathaniel Schaaf
ffc67f0a37 Fix spelling 2015-09-16 10:48:23 -05:00
James Cammarata
719e4020e0 Merge pull request #12387 from jkugler/patch-1
Small change so the YAML renders as code.
2015-09-16 10:38:23 -04:00
Joshua Kugler
d31f61e35c Wrong column named
Correcting the docs to match the example, which I assume to be correct.
2015-09-15 15:49:38 -08:00
Joshua Kugler
1dc7cce910 Small change so the YAML renders as code.
The line above the last YAML code block in this document did not have the requisite :: characters, so the YAML did not render correctly in the docs.
2015-09-15 15:37:20 -08:00
Brian Coca
0aeaacb947 fixed zpellings 2015-09-15 12:06:40 -04:00
Brian Coca
b6d6c2e4db corrected all missing paths changes 2015-09-15 11:57:54 -04:00
Brian Coca
4241df41aa fixed typoe (thanks @resmo) 2015-09-15 11:45:55 -04:00
Brian Coca
7f52d909c4 rewrote 1.x section of precedence to prevent promissing specificity to those reading docs for earlier versions 2015-09-15 11:40:53 -04:00
Brian Coca
6e34e84417 documenting var precedence
made new sections for vars, started explaining scope, gave example on command line override of connection vars
added some formatting changes and clarifications
2015-09-15 11:40:53 -04:00
Brian Coca
7c669f5a33 Merge pull request #12375 from jhawkesworth/configuring_kerberos_doc
Documentation PR. Add kerberos configuration instructions to windows intro page
2015-09-15 10:23:53 -04:00
Tim Gerla
e5a981e713 typo fix 2015-09-15 10:00:01 -04:00
Brian Coca
5c7bca9e17 Merge pull request #12369 from bborysenko/docsite/playbooks_variables
docs - minor fixes to playbooks_variables
2015-09-15 09:53:23 -04:00
Brian Coca
43ea5f0853 added note about registered variables 2015-09-15 09:49:22 -04:00
=
e5cad0fd9a Add kerberos configuration instructions to windows intro 2015-09-15 08:57:08 +01:00
Borys Borysenko
6b396cdab7 fix code block quoting and boldface for modules name 2015-09-15 10:56:41 +03:00
yannig.perre@gmail.com
54eb08eb0d Fix ansible v2 documentation for ini lookup plugin (property => properties). 2015-09-14 20:50:09 +02:00
Brian Coca
d8b671ca76 Merge pull request #12348 from bborysenko/docsite/playbooks_intro
docsite - playbooks_intro - minor tweaks
2015-09-14 09:25:13 -04:00
Borys Borysenko
4064063794 use boldface for modules name 2015-09-14 10:01:07 +03:00
Borys Borysenko
f5cfb5577e fix code block quoting 2015-09-14 09:55:39 +03:00
Gerard Lynch
e5211a9b18 playbooks_filters - minor fixes 2015-09-13 12:29:53 +01:00
Abhijit Menon-Sen
f56a6e0951 Rename ansible_ssh_{host,port,user} in docs to ansible_*
The _ssh variants will continue to work, but the shorter, more generic
names are preferred now.
2015-09-10 19:41:47 +05:30
Brian Coca
6dac8512a1 Merge pull request #12307 from jtyr/doc_fixes
Doc fixes
2015-09-10 09:17:22 -04:00
Jiri tyr
14dc16ca54 Adding missing colon to fix the block formating 2015-09-10 15:14:23 +02:00
Jiri tyr
174f805fb3 Resurrection of the comment filter 2015-09-10 14:37:42 +02:00
Kenny Gillen
00d2a80542 s/rpmbuild/rpm-build
When I followed these instructions, the generated path was 'rpm-build', not 'rpmbuild'. My rpm-build version is rpm-build-4.11.1-25.el7.x86_64 if that's relevant. Maybe this is 'just me', but wanted to feed back in case it's the same for everyone.
2015-09-08 17:59:53 +01:00