Commit graph

898 commits

Author SHA1 Message Date
Brian Coca
6c1e806a2f added return docs management 2015-05-18 09:57:44 -04:00
Brian Coca
d42cfb3386 added module checklist docs 2015-05-18 08:57:22 -04:00
Toshio Kuratomi
8a26b17f16 Merge pull request #11009 from kustodian/fix-pattern-documentation
Fixed documentation for host pattern portions
2015-05-15 09:20:51 -07:00
Strahinja Kustudić
fa1549fec1 Fixed documentation for host pattern portions 2015-05-14 12:24:36 +02:00
Serge van Ginderachter
9b646dea41 Add optional 'skip_missing' flag to subelements 2015-05-12 12:52:16 -05:00
Brian Coca
537baf6512 Merge pull request #10903 from gtback/include-variable-structure-docs
Make "include" variable documentation consistent
2015-05-11 22:56:56 -04:00
Alex Muller
1caee5cb79 Remove unnecessary 'from' in playbook intro docs
To make this sentence make sense.

Fixes #10970.
2015-05-11 20:12:21 +01:00
Tom Paine
0c21f05bcd Update become.rst
Visually separate commands and values from description text for clarity. Add value detail for become_user and become_method to match become.
2015-05-11 18:33:24 +01:00
Brian Coca
419ef0d19c Merge pull request #10959 from bcoca/sudo_docfix
fixed docs on the meaning of -H sudo arg
2015-05-08 14:53:42 -04:00
Brian Coca
2e8758d8c4 fixed docs on the meaning of -H sudo arg
fixes #7418
2015-05-08 11:08:10 -04:00
Tom Paine
1108fd3dd2 Update playbooks_tags.rst
highlight the command part of the sentence to clarify use of 'all' tag.
2015-05-07 12:22:08 +01:00
Jon Hawkesworth
9d572afb61 Add advice about using unpatched Windows Management Framework 3.0.
Hopefully this should reduce bug reports like #10878 and #10825
2015-05-06 06:33:34 +01:00
Toshio Kuratomi
4839243366 Documentation fixes 2015-05-05 13:51:22 -07:00
Brian Coca
91caadab86 Merge pull request #10884 from nickhammond/privilege_escalation
Add become docs to the intro configuration for #10881
2015-05-05 10:47:03 -04:00
Brian Coca
e971b60f26 updated docs about ansible_hosts/inventory env vars 2015-05-05 09:48:57 -04:00
Brian Coca
5959f83248 Merge pull request #10860 from bcoca/role_doc_clarify
clarify role spec, dependencies and galaxy involvment.
2015-05-04 12:17:17 -04:00
Greg Back
8a7496af42 Make "include" variable documentation consistent
There is already a good example of a list variable ("ssh_keys")
contained above this snippet, so reuse the content here.
2015-05-01 16:45:56 -05:00
Bill Nottingham
4d4e2bb5a0 Tweak vault description.
Vault isn't specifically for source control. Make description a little more generic and descriptive.
2015-05-01 13:53:29 -04:00
Charles Lanahan
c9815ef286 Update intro_dynamic_inventory.rst
Examples of special characters being converted to underscores for clarity.
2015-05-01 10:23:56 -07:00
Brian Coca
4e85419257 Merge pull request #10853 from cgar/spelling
just a few spelling error changes

I swear only 95% of those are mine!
2015-04-30 09:02:09 -04:00
Nick Hammond
be15d74935 Add become docs to the intro configuration for #10881 2015-04-29 21:22:24 -05:00
Brian Coca
3846528366 clarify role spec, dependencies and galaxy involvment.
fixes #10832
2015-04-28 16:38:53 -04:00
Toshio Kuratomi
39650efc38 Fix title underline for rst 2015-04-28 11:11:49 -07:00
Carlos E. Garcia
cfbfd38723 just a few spelling error changes 2015-04-28 09:36:42 -04:00
Tyler Harper
ee32403467 change --ansible-private-keyfile to --private-key
An old command line option was left in the documentation.
2015-04-27 11:16:56 -04:00
Brian Coca
8161dab60a added notes about privilege escalation limitations 2015-04-21 15:32:35 -04:00
Greg Taylor
c5e9a87e74 Correct emphasis markup nit in playbooks_vault.rst
It looks like the original intention was to italicize, but someone was used to another markup language. I have switched the wrapped tags so we're showing italics and not a broken link.
2015-04-21 11:11:57 -07:00
Hiroaki Nakamura
f0158d4eed Add Python 2.7 to Conrol Machine Requirements in docsite 2015-04-22 02:57:26 +09:00
Hennadiy (Gena) Verkh
da3780908a Fixed links 2015-04-21 11:32:10 +02:00
Mikko Ekström
1d966ac5bb Correct minor spelling typos. 2015-04-21 00:13:52 +02:00
Brian Coca
56deb35e67 updated intro to new become syntax, also added link to full become docs 2015-04-20 13:31:36 -04:00
Brian Coca
5d446bbd5b Merge pull request #10767 from sivel/issue/10763
Correct the ternary example. Fixes #10763
2015-04-18 22:48:44 -04:00
Matt Martz
d34e7d7bca Correct the ternary example. Fixes #10763 2015-04-18 16:05:35 -05:00
Kevin Ndung'u
5913227d9f Make shell quoting rules explanation a bit clearer
I personally got confused by the use of 'vs' in the explanation.
Maybe this explains it better?
2015-04-18 12:47:02 +03:00
Mark Phillips
77afdd16b0 Fixed a few typos in the become documentation 2015-04-16 17:30:54 +01:00
eroldan
87dde862bd Fixed wrong example of 'environment' for setting PATH 2015-04-13 16:21:08 -03:00
Toshio Kuratomi
bad554d517 Merge pull request #9268 from kustodian/docs_advance_conditions
Added an example for paretheses
2015-04-13 10:13:41 -07:00
Toshio Kuratomi
1121928f50 Merge pull request #10318 from dmahler/devel
Some grammatical updates
2015-04-13 08:43:31 -07:00
Jesse Rusak
652cd6cd5e Fix --force-handlers, and allow it in plays and ansible.cfg
The --force-handlers command line argument was not correctly running
handlers on hosts which had tasks that later failed. This corrects that,
and also allows you to specify force_handlers in ansible.cfg or in a
play.
2015-04-10 19:38:59 -04:00
Chris Church
944690118f Update windows documentation to indicate how to specify kerberos vs. basic auth. 2015-04-09 15:51:43 -04:00
Brian Coca
1e7f7bfc12 Merge pull request #10642 from gaomd/patch-1
Remove redundant whitespace.
2015-04-08 11:21:22 -04:00
Niall Donegan
3ae4ee9c52 Updated outdated link to module directory.
Core modules link updated and Extras link added.
2015-04-08 14:24:21 +01:00
Mengdi Gao
665babdaab Remove redundant whitespace. 2015-04-08 14:19:45 +08:00
Mohamed Hazem
bb3f50361e Replaced --start-at with --start-at-task 2015-04-05 20:47:22 +03:00
Bill Nottingham
7e3b3b6ebe Update intro_windows.rst
Add a bit about what Windows versions PS3 is actually available for.
2015-04-03 14:26:45 -04:00
Bill Nottingham
22608939eb Update intro_windows.rst
Refer to PowerShell consistently.
2015-04-03 14:23:04 -04:00
Matt Martz
fa076591c9 Don't recommend installing ansible via homebrew 2015-04-02 15:30:37 -05:00
Luke
132c0e794d note added to source section
Added reminder to not use source install method if you're going to be installing ansible for a Tower system
2015-04-01 08:29:56 -04:00
Brian Coca
c90e3f0d16 small updates to community and contribution page 2015-03-29 15:58:56 -04:00
Henrik Danielsson
c6942578bf Added installation instructions for Arch Linux. 2015-03-24 12:00:58 +01:00
Cristian Ciupitu
577cdcadb3 Doc: use literal code blocks for YAML examples
Without this, the straight double quotes (") are displayed as curved
quotes (“ and ”).
2015-03-23 22:52:42 +02:00
Tim Rupp
9a680472f8 Fixes a brief spelling error
Fixes a simple spelling mistake that was bugging me when I read the online
docs. Trying to make the docs as great as possible.
2015-03-21 19:22:12 -07:00
Henry Todd
10e14d0e0a Update add_host example in AWS Guide
The add_host module now uses "groups" instead of "groupname" to allow for specifying more than one group.
2015-03-21 13:21:55 +08:00
Brian Coca
64b447f01b grammer correction 2015-03-20 16:55:03 -04:00
Brian Coca
690d227034 extended return value explanation 2015-03-20 16:55:03 -04:00
Brian Coca
94909bd4a2 Added return values documentation to modules 2015-03-20 16:55:03 -04:00
Toshio Kuratomi
d1641f2925 Remove the multiline string for arguments not. 2015-03-19 16:10:01 -07:00
Toshio Kuratomi
86dc83b76d Merge pull request #10163 from maxamillion/docs_yaml_dict_playbook
Add intro to playbook docs using YAML dictionaries
2015-03-19 16:08:36 -07:00
Michael Crilly
8e346186b2 Correct version number.
1.8.4 is the latest stable now, I believe.
2015-03-13 18:07:18 +00:00
Jeff Widman
f6d8e457ab Typo: lead --> led 2015-03-11 01:20:17 -07:00
Brian Coca
5f6db0e164 preliminary privlege escalation unification + pbrun
- become constants inherit existing sudo/su ones
- become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group
- changed method signatures as privlege escalation is collapsed to become
- added tests for su and become, diabled su for lack of support in local.py
- updated playbook,play and task objects to become
- added become to runner
- added whoami test for become/sudo/su
- added home override dir for plugins
- removed useless method from ask pass
- forced become pass to always be string also uses to_bytes
- fixed fakerunner for tests
- corrected reference in synchronize action plugin
- added pfexec (needs testing)
- removed unused sudo/su in runner init
- removed deprecated info
- updated pe tests to allow to run under sudo and not need root
- normalized become options into a funciton to avoid duplication and inconsistencies
- pushed suppored list to connection classs property
- updated all connection plugins to latest 'become' pe

- includes fixes from feedback (including typos)
- added draft docs
- stub of become_exe, leaving for future v2 fixes
2015-03-10 18:42:36 -04:00
Brian Coca
39a3d6f5ed added version to ternary example 2015-03-10 12:42:55 -04:00
Brian Coca
0ff77b3650 Merge pull request #10404 from maxalbert/doc_enhancement
Add note to section 'Loops' that the 'when:' statement is processed per-item
2015-03-10 10:51:47 -04:00
Brian Coca
a4c7aca419 Merge pull request #10395 from AndrewLorente/patch-2
Mention `view` in the ansible vault docs
2015-03-10 10:43:05 -04:00
Dag Wieers
2e67372919 Make the example somewhat more feature complete
New users might think that "state=started" implies that the service is also started at boot-time, which isn't.
By adding it, this change makes a clear distinction between the service state, and whether it is enabled (at boot).
And makes the example more feature-complete as this is what most people would be doing anyway.
2015-03-09 16:16:58 +01:00
Brian Coca
08617c087b Merge pull request #8866 from Fresheyeball/patch-1
Document Environment in tasks as well
2015-03-09 02:05:27 -04:00
Toshio Kuratomi
cc7385d8f7 Add the playbook filters to a toctree 2015-03-06 21:02:40 -08:00
Maximilian Albert
af593c2f51 Add note to section 'Loops' that the 'when:' statement is processed per-item. 2015-03-06 21:35:49 +00:00
Andrew Lorente
822c401a71 Mention view in the ansible vault docs 2015-03-05 14:01:09 -08:00
Vincent van Scherpenseel
01886ede28 Update playbooks_vault.rst
Typo fix (passwords -> files).
2015-03-05 14:05:38 +01:00
Brian Coca
6223094c54 Merge pull request #10351 from lekum/doc-update-mock
Update doc for testing PR with mock dependency
2015-02-27 08:54:51 -05:00
Alejandro Guirao
0e493dbd69 Update doc for testing PR with mock dependency 2015-02-27 09:34:20 +01:00
Brian Coca
d0f8df4bdb Merge pull request #10079 from lorin/csv-lookup-doc
Add docs for csvfile lookup
2015-02-26 23:54:57 -05:00
Brian Coca
5a64b2e269 Merge pull request #10305 from bcoca/cartesian
Cartesian
2015-02-26 23:25:33 -05:00
Brian Coca
c9cbe9d528 Merge pull request #9906 from NateEag/patch-1
"its" => "it's" in docsite/rst/intro_adhoc.rst
2015-02-26 22:57:17 -05:00
Toshio Kuratomi
82685799cb filter name is realpath, not readlink
Fixes #10062
2015-02-26 14:17:39 -08:00
Brian Coca
c81d981164 Merge pull request #10183 from bcoca/tag_control
adds complex tag management
2015-02-25 10:36:11 -05:00
David Mahler
c4144b1391 Some grammatical updates 2015-02-22 19:28:16 +00:00
Maciej Delmanowski
c10f4c23dd Specify that 'ipaddr' is available in 1.9 2015-02-21 14:11:04 +01:00
Maciej Delmanowski
25ef581a90 Add basic examples of ipaddr filter use 2015-02-21 13:34:22 +01:00
Maciej Delmanowski
71dae62b2a Add IP address filter documentation 2015-02-21 13:21:07 +01:00
Maciej Delmanowski
c866a26d81 Move Jinja2 filters documentation to separate file 2015-02-21 13:01:22 +01:00
Brian Coca
965680a18e documented cartesian lookup in 1.9 2015-02-20 09:06:17 -05:00
Brian Coca
a66c559818 documented new wantlist feature 2015-02-19 18:29:29 -05:00
Brian Coca
54cf8f1138 Merge pull request #10256 from kstrauser/kerberos-docs
Added winrm/kerberos configuration information
2015-02-16 12:48:21 -05:00
Kirk Strauser
1b67aa94e8 Added winrm/kerberos configuration information 2015-02-16 09:36:39 -08:00
Lorin Hochstein
639f06e0e8 Document redis_kv Python package dependency
Mention in docs that the redis_kv lookup requires that the redis Python package
is installed.
2015-02-15 22:37:58 -05:00
Brian Coca
af573db47a documented new tag behaviour 2015-02-13 08:27:07 -05:00
Toshio Kuratomi
53e5c5e33f Merge pull request #10205 from alefteris/patch-1
Typo in galaxy.rst
2015-02-12 12:00:25 -08:00
Brian Coca
62a6378c4a Merge pull request #8792 from bcoca/ternary_filter
ternary filter
2015-02-12 11:29:49 -05:00
Brian Coca
ec8483eb69 Merge pull request #10227 from fullergalway/patch-1
Small change to guid_gce.rst,  'project-name', should be 'project_id'
2015-02-12 10:00:13 -05:00
fullergalway
a8c02ea807 Small update to guid_gce.rst, says 'project-name', should be 'project_id'. 2015-02-12 09:15:43 +00:00
Tongliang Liu
1fc2095157 Added "--recursive" to git clone command in installation via yum section. Changed rpm build parent directory to current dir. 2015-02-11 20:00:38 -08: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
Thanos Lefteris
ef11c8ce55 Typo in galaxy.rst 2015-02-11 23:03:45 +02:00
Brian Coca
13d788021f Merge pull request #4820 from mscherer/add_local_config
Add path for user defined plugin
2015-02-11 14:44:07 -05:00
Brian Coca
9820165265 Merge pull request #10188 from simontite-capita-ti/patch-1
Update playbooks_delegation.rst
2015-02-09 10:14:34 -05:00
simontite-capita-ti
21094614c0 Update playbooks_delegation.rst
There's a space missing "hosts:127.0.0.1" should be "hosts: 127.0.0.1"
2015-02-09 11:05:21 +00:00
Brian Peiris
ae5f64c232 Update YAMLSyntax.rst 2015-02-05 11:16:39 -05:00
Brian Peiris
32a5dc22c6 Reformat description of a dictionary entry. 2015-02-05 11:13:33 -05:00
Adam Miller
1e787bd91e Add intro to playbook docs using YAML dictionaries 2015-02-04 09:56:44 -06:00
Erika Heidi
c20c6d4eb4 [Vagrant guide] Updating private key location
Since Vagrant 1.7.0, released in December 2014, the private key file is autogenerated and has a new location - check the changelog for more info: [version 1.7.0 changelog](https://github.com/mitchellh/vagrant/blob/master/CHANGELOG.md#170-december-9-2014)
2015-02-02 13:30:17 +01:00
Michael Scherer
d6edbeb4d0 Fix documentation on hostfile vs inventory , follow up of #10130 2015-02-01 12:12:40 +01:00
Brian Coca
daa2c3a956 Merge pull request #9584 from Sgoettschkes/issue_docs_missing_ansible_sudo
Adding inventory parameter to documentation
2015-01-28 13:42:59 -05:00
Brian Coca
990d08b63f Merge pull request #10113 from bcoca/url_lookup
Url lookup
2015-01-28 09:54:40 -05:00
Dagobert Michelsen
7a90139e3c Add OpenCSW for Solaris 2015-01-28 10:23:03 +01:00
Brian Coca
6118bf4b64 corrected missing quote 2015-01-27 17:48:39 -05:00
Brian Coca
424065229c added example of url lookup 2015-01-27 17:25:55 -05:00
William Jimenez
36e0e1ef26 explain -q flag for env-setup
See https://github.com/ansible/ansible/issues/10109
2015-01-27 12:56:21 -08:00
Lorin Hochstein
0474b5ce5d Document that dnstxt lookup requires dnspython
Add a line in the docs to specify that dnstxt requires that you have the
dnspython package installed.
2015-01-25 15:20:49 -05:00
Lorin Hochstein
6a7012474b Add docs for csvfile lookup 2015-01-23 21:06:12 -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
cf6f05e71d Merge pull request #10039 from tima/doc-version-fix
Modified the version numbers in one section on index of docs to reflect their current state.
2015-01-19 15:30:41 -05:00
Brian Coca
1a1b66702f Merge pull request #10037 from lekum/aws-doc-bug
Add missing register
2015-01-19 15:29:59 -05:00
Brian Coca
2a9d5054bf Merge pull request #9995 from bcoca/hash_filters
Hash filters
2015-01-19 15:17:39 -05:00
Jeremy Voorhis
f6e309bebb Fix copy/paste in plugins docs. 2015-01-18 15:55:24 -08:00
Timothy Appnel
802f0048e5 Modified the version numbers in one section on index of docs to reflect their current state. 2015-01-18 14:34:02 -05:00
Alejandro Guirao
63808ee3f1 Add missing register 2015-01-18 14:27:26 +01: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
Major Hayden
eaac53922c Small spelling fix for Rax docs 2015-01-13 21:19:27 -06: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
stevelenihan
c29da7927c Correcting spelling mistake
Change 'uncrypted' to 'unencrypted'
2015-01-13 16:53:14 +00:00
Kerry Ivan Kurian
630ae89977 fix typo 2015-01-12 12:24:17 -07:00
Brian Coca
375f4d701c Merge pull request #9076 from jirutka/patch-1
Add Gentoo install notes do intro_installation
2015-01-12 10:27:03 -05:00
Marco Ippolito
31c8523371 Updated shebang from #!/bin/bash to #!/usr/bin/env bash (more flexible) 2015-01-10 17:21:43 -08:00
volanja
e213fdb15d to replace running with started 2015-01-09 01:24:41 +09:00
Toshio Kuratomi
fe53d86a83 inventory is ini-like but not quite like other implementations 2015-01-05 09:18:52 -08:00
Brian Coca
8760392a95 Merge pull request #9910 from NateEag/patch-3
Fix some typos in developing_modules.rst
2014-12-29 17:40:33 -05:00
Nate Eagleson
410c8fc825 Fix some typos in developing_modules.rst 2014-12-29 08:39:39 -05:00
Nate Eagleson
d2cae91dcf Improve wording in playbooks_intro.rst
I was reading the docs and thought "that wording seems off."
2014-12-29 08:03:38 -05:00
Nate Eagleson
20937f6fa2 "its" => "it's" in docsite/rst/intro_adhoc.rst
Noticed this grammar error while reading through the intro and figured
I'd send a quick PR.
2014-12-28 21:35:30 -05:00
René Moser
a88e928bf0 doc: mention smart gathering for facts caching 2014-12-25 23:33:56 +01:00
Toshio Kuratomi
fb5b682989 Use "override" instead of "loaded second" to be clear about what happens
Need for clarification brought up here:
https://github.com/ansible/ansible/issues/9877
2014-12-23 12:37:42 -08:00
Jérémie Astori
35b94948b9 Fix conditionals doc example
Use most recent parameters for yum
2014-12-21 23:42:01 -05:00
Toshio Kuratomi
7ab1e52575 Merge pull request #9832 from bcoca/math_filters
math filters!
2014-12-16 15:42:22 -08:00
Brian Coca
b07ce8b942 removed redundant math functions as jinja2 provides abs() and round()
already
2014-12-16 17:57:21 -05:00
Brian Coca
6a3c26eb70 removed stray j 2014-12-16 17:49:32 -05:00
Brian Coca
7a43d40050 math filters! 2014-12-16 17:47:50 -05:00
Toshio Kuratomi
b74a02301b Fix documentation syntax problems 2014-12-16 12:25:41 -08:00
Brian Coca
8908f4a0ef Merge pull request #7214 from lorin/dyn-inv-doc
Document static groups of dynamic groups
2014-12-15 17:56:25 -05:00
axiaoxin
5838812967 minor 2014-12-15 15:55:12 +08:00
axiaoxin
36eab28c7c making the whitespace expicity in dict 2014-12-15 15:53:35 +08:00
axiaoxin
c0cb4b3e08 in key/value pairs, whitespace is needed after the colon 2014-12-15 15:44:00 +08:00
axiaoxin
b9761a0692 members of a list must start with `- ` 2014-12-15 15:32:49 +08:00
Michael Scherer
72eab3c019 fix the documentation path for latest regarding plugins 2014-12-11 23:35:37 +01:00
Donovan Hernandez
a1a6b8dfbb Fix typo for the word "maintaining" 2014-12-11 02:10:44 -06:00
Tim Gerla
23405b60cb fix up formatting for one code section in guide_aws 2014-12-10 19:04:02 -08:00
Mike Putnam
09ef8f5722 Typo fix in playbook delegation docs. 2014-12-10 12:13:31 -06:00
Mike Putnam
e507a79b96 Typo fix 2014-12-10 11:41:31 -06:00