Commit graph

132 commits

Author SHA1 Message Date
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
Gerard Lynch
4942f18100 added role_path to magic var section 2015-06-24 16:54:53 +01:00
Peter Parente
2aba3b4172 Fix typo: "name" to "role" 2015-06-21 15:39:22 -04:00
Maciej Delmanowski
c866a26d81 Move Jinja2 filters documentation to separate file 2015-02-21 13:01:22 +01:00
Brian Coca
62a6378c4a Merge pull request #8792 from bcoca/ternary_filter
ternary filter
2015-02-12 11:29:49 -05:00
Brian Coca
f05a1085e9 Merge pull request #9249 from tjanez/doc-add_note_about_escaping_with_regex_replace
Added a note about escaping backreferences when using 'regex_replace' filter
2015-02-11 17:47:19 -05:00
Björn Andersson
65e4f2b2bc Add filter to turn a string into a UUID
This filter was made because I needed to create idempotent UUIDs when
installing the agent for Go (http://go.cd), which uses UUIds to
distinguish the agents from each other.

It uses a newly created Ansible namespace to distinguish UUIDs created
by Ansible from any other source. The new namespace is a random one
created by uuidgen on OSX.
2015-01-21 08:07:17 +08:00
Brian Coca
2a9d5054bf Merge pull request #9995 from bcoca/hash_filters
Hash filters
2015-01-19 15:17:39 -05:00
Brian Coca
b28ef1701f Merge pull request #9896 from resmo/fix/doc
doc: mention smart gathering for facts caching
2015-01-16 10:17:51 -05:00
Brian Coca
ffe1dcde28 Merge pull request #9713 from bcoca/fact_cache_n_gathering
mentioned gathering settings in fact caching.
2015-01-16 10:17:17 -05:00
Brian Coca
35247fabb8 added hash and password_hash functions
documented new hashing filters and preexisting hashing filters
removed extra sha1 example in others, clarified some of the hashing examples
2015-01-13 14:05:57 -05:00
René Moser
a88e928bf0 doc: mention smart gathering for facts caching 2014-12-25 23:33:56 +01:00