Commit graph

143 commits

Author SHA1 Message Date
Sébastien BARTHÉLÉMY
a4c11ee231 add missing newline in ansible_play_batch doc 2016-11-02 13:39:11 -04:00
Brian Coca
86ea21a73d ansible_play_batch (#17779)
* ansible_play_batch

* added version added
2016-09-28 10:32:19 -04:00
Brian Coca
89f1cd6a8f clarified play_hosts/ansible_play_hosts docs 2016-09-23 11:23:25 -04:00
j0hnsmith
4650d8910e Feature/add ansible play hosts all (#17498)
* refactor ignore_limits_and_restrictions

into ignore_limits and ignore_limitations

* add ansible_play_hosts_all

* update docs re ansible_play_hosts_all

* only use play.hosts when is has a value

* replace ansible_play_hosts with ansible_play_hosts_all

* remove unnecessary var
2016-09-23 11:17:46 -04:00
scottb
bfad319619 Merge pull request #15820 from jinesh-choksi/patch-2
Key names in the ansible_local variable are converted into lower case
2016-09-21 14:41:04 -07:00
Tim Baldwin
89a61b5b43 fixed word case (#16753)
The word "times" should not be capitalized unless at the beginning of a sentence or in a proper noun.
2016-07-20 18:02:23 -04:00
Aaron Mortenson
5bba918052 added more documentation of loops with register (#16208) 2016-06-09 13:13:51 -04:00
James Cammarata
b37b51dcea Fix variable precedence issue where set facts beat role params
Also updates doc on variable precedence, as it was incorrect for the
order of play vars/vars_prompt/vars_files in relation to set_fact and
registered variables.

Fixes #14702
Fixes #14826
2016-06-07 11:25:02 -05:00
Marius Gedminas
b479a80d45 Document playbook_dir (#16166)
It was added back in 2013, in version 1.3: https://github.com/ansible/ansible/issues/4246
2016-06-07 09:13:06 -04:00
Toshio Kuratomi
d45a394f63 Mocate ansible_ssh_changes into a common directory 2016-05-24 11:37:04 -07:00
Jinesh Choksi
67a64efb58 Key names in the ansible_local variable are converted into lower case
Adding a note to the documentation to highlight that key names in the ansible_local variable are converted into lower case when they are read from the local facts on the host.
2016-05-11 13:32:01 +01:00
nikut
54440a30c0 doc fix for delegate_to / ansible_host (issue #15546) (#15605) 2016-04-26 11:18:06 -04:00
Mengdi Gao
bb037f033c Fix typo in variable docs 2016-04-11 01:07:39 +08:00
Strahinja Kustudić
eed6cf5dad Adds 'ansible_check_mode' boolean magic variable
* Makes it possible to pass any options variable to VariableManager
  by changing `load_options_vars(options)` in `lib/ansible/utils/vars.py`
2016-04-08 00:26:02 +02:00
Brian Coca
84bbd2b4e3 corrected version added for ansible_version 2016-03-17 07:25:37 -07:00
Abhijit Menon-Sen
0c6693aa4c Merge pull request #14947 from mscherer/add_ansible_version_doc
Add doc on ansible_version, fix #13204
2016-03-17 14:48:50 +05:30
Abhijit Menon-Sen
00312723b2 Merge pull request #14484 from Antillean/extra-vars_docs
Documenting that extra-vars 'key=value' is for strings
2016-03-17 14:46:18 +05:30
Michael Scherer
8b808cab9e Add doc on ansible_version, fix #13204 2016-03-13 09:54:24 +01:00
Vladimir Rutsky
35880e6254 fix reference to chapter + trailing dot 2016-02-29 18:21:05 +03:00
Brian Coca
b0bed27211 minor doc fixes 2016-02-26 16:46:26 -05:00
Matt Martz
38b663471d Merge pull request #14311 from sivel/unsafe-yaml-constructor
Add new 'unsafe' YAML constructor
2016-02-23 11:29:53 -06:00
Sandra Wills
11f081cb99 minor typo fix
missing "the" added to 2.x listing to match wording for 1.x
2016-02-19 10:35:43 -05:00
Sandra Wills
c172a289e4 light editing of variable precedence list wording
QA had asked me a while ago to clean up the way the precedence list for 1.x was worded,
as the intro from the list started with "then comes", as if something should preceed
it. The comments from OxABAB were not helpful themselves, but his issue reminded me that
this was on my to do list to make a little cleaner and clearer.  Edits made to remove the
"then comes" intros for each list line, to help with clarity.
2016-02-19 10:32:34 -05:00
Kamal Wood
0c1395ed2f Documenting that values passed in using the extra-vars 'key=value' syntax are interpreted as strings. 2016-02-15 14:13:39 +00:00
Matt Martz
5cd4afaa1d Add documentation about the unsafe YAML tag 2016-02-04 11:54:23 -06:00
Usman Ehtesham Gul
4779f29777 Fix Doc mistake
Fix Doc mistake in ansible/docsite/rst/playbooks_variables.rst
2015-12-13 01:24:27 -05:00
sam-at-github
a96a879fcf Add fullstop to make sentence make sense. Touch parargraph while at it. 2015-12-05 13:06:58 +11:00
Timothy Appnel
fde7c14cd0 v1 variable precedence order was off.
Noticed that the v1 variable precedence docs list facts discovered as having a lower precedence than inventory variables. It is in reality the other way around. The v2 section gets this right.
2015-11-06 13:48:35 -05:00
Toshio Kuratomi
5e0d55ae5b Change the dict attribute collision warning to recommend using bracket notation 2015-11-01 13:32:45 -08:00
Robin Schneider
ad0d299c56
Avoid key names which are valid attributes for data types in Python.
Closes #12990.

Alternative to #12992

This PR excludes all attributes of the following data types: lists,
tuples, dicts, sets, integers, floats, strings and Unicode objects.

It is expected that only the attributes of dicts and sets would cause an
problem like in #12990.
2015-10-31 23:58:16 +01:00
Sandra Wills
bc14ed380e variables precedence reordering and added para to help explain precedence rules 2015-10-22 09:12:43 -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
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
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
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
Austin Ziegler
67a980c9ef Describe the units for fact_caching_timeout 2015-09-29 11:59:55 -04:00
Brian Coca
0aeaacb947 fixed zpellings 2015-09-15 12:06:40 -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
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
Borys Borysenko
6b396cdab7 fix code block quoting and boldface for modules name 2015-09-15 10:56:41 +03: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
827f2ff0ac corrected var name 2015-07-29 15:46:13 -04:00
Michael Scherer
c2c20baf01 Add more explicit documentation on ansible_nodename and ansible_hostname
Fix #9971, based on text from Paul Czarkowski
2015-07-25 14:27:59 +02:00
Brian Coca
493d91cb55 Merge pull request #11531 from tamsky/tamsky-document-jsonfile
document `jsonfile` fact cache
2015-07-10 18:14:59 -04:00
Marc Tamsky
aaf59319e4 document jsonfile and provide example config 2015-07-09 23:33:31 -10:00