Alan Descoins
d505474832
Updated documentation.
12 years ago
Joshua Lund
be6feee058
Minor cleanup of YAML Syntax documentation
12 years ago
Ches Martin
b35fc42d36
Enhance meta-docs on... contributing to docs.
...
- Update FAQ entry to refer to docsite README and reduce redundancy.
- Add additional info to docsite README: Sphinx building, link to module
documentation reference.
12 years ago
Tim Gerla
7e07bca6bf
very minor fix to playbooks2 to fix a formatting error
12 years ago
Michael DeHaan
77a4dcca85
Sphinx/docs syntax fixes
12 years ago
Michael DeHaan
feb4a8847d
Slight edit to when_changed docs
12 years ago
Michael DeHaan
b603bb0f73
Merge branch 'changed_when-doc' of git://github.com/stoned/ansible into devel
12 years ago
Xiao Hanyu
23ff2f2992
Merging docs
12 years ago
Joshua Lund
e8c6da6045
Cleanup Glossary documentation
12 years ago
Michael DeHaan
9314341923
Merge pull request #3465 from jlund/best-practices
...
Add documentation for Role Variables to the Best Practices page
12 years ago
Michael DeHaan
ce89382473
Legacy variable removal.
12 years ago
Michael DeHaan
597e5075f1
Merge pull request #3585 from devo-ps/documentation
...
Minor typo on site about host_key_checking config section.
12 years ago
Michael DeHaan
1867fb4888
Update an example.
12 years ago
Michael DeHaan
10bc6f6d9c
Merge pull request #3541 from pol/docs_withitems_regivar
...
Create with_items example with a registered var
12 years ago
Michael DeHaan
c101d4b30b
Documentation indentation fix.
12 years ago
Michael DeHaan
deda5c8ee7
Remove backlinks:top which is setting hyperlinks in docs sections so they are hard to bookmark.
12 years ago
Michael DeHaan
ad5ac71219
Merge pull request #3542 from pol/docs_task_format
...
Update to conventional task format
12 years ago
Michael DeHaan
f938bc660f
Slight documentation tweak.
12 years ago
Michael DeHaan
21e06a87ce
Merge pull request #3530 from candeira/with_nested
...
add documentation for with_nested
12 years ago
Vincent Viallet
6a00cb7b3b
Minor typo on site about host_key_checking config section.
12 years ago
Joshua Lund
a5459e8a03
* Added documentation for Role Variables
...
* Fixed a few minor typos
12 years ago
Pol Llovet
8a0861f804
Create with_items example with a registered var
12 years ago
Pol Llovet
d933fef93f
Deprecate only_if in favor of when.
12 years ago
Pol Llovet
bd7448ccf0
Update to conventional task format
12 years ago
Javier Candeira
d3a97bfb07
add documentation for with_nested
12 years ago
Stoned Elipot
60d2ad3642
Document changed_when clause
12 years ago
Michael DeHaan
324a28f3dd
Merge pull request #3439 from eest/bestpractices_templates_fix
...
Fix path to ntp.conf.j2 in example.
12 years ago
Michael DeHaan
90dfc115d6
Merge pull request #3463 from stoned/filterskipped
...
Add Jinja2 filter 'skipped' to test for a registered variable from a ski...
12 years ago
Joshua Lund
7c78fef1f5
Fixed some minor typos in the Advanced Playbooks documentation
12 years ago
Stoned Elipot
906746b1f0
Add Jinja2 filter 'skipped' to test for a registered variable from a skipped task
12 years ago
Michael DeHaan
d002c2d907
Document 'smart' option and connection type default changes.
12 years ago
Michael DeHaan
107ced7ec5
Mention envrionment variable configuration.
12 years ago
Michael DeHaan
1ead97098d
Talk more about transports in documentation.
12 years ago
Patrik Lundin
1f1aa1f0a8
Fix path to ntp.conf.j2 in example.
...
The "common" role adds "common/templates/" to the src path.
12 years ago
Michael DeHaan
f3dc5707a8
Merge pull request #3282 from jlaska/devel
...
Reference ansible_lsb.major_release, not ansible_lsb.major_version
12 years ago
Michael DeHaan
39105dc853
Fix RST formatting in documentation (underline too short)
12 years ago
Michael DeHaan
6dd93fa964
Some minor doc tweaks
12 years ago
Michael DeHaan
ee4d9b1516
Merge branch 'devel' of git://github.com/shirou/ansible into devel
12 years ago
Michael DeHaan
f2e3a9a850
Merge pull request #3370 from y-p/PR_role_doc_enh
...
Add doc example of attaching tags to a role
12 years ago
y-p
a4dfc14a6c
Add doc example of attaching tags to a role
12 years ago
shirou
a439afeb8f
add description about host parameters in a inventory file.
12 years ago
James Laska
eb2ae8b3c2
Reference major_release, not major_version
12 years ago
Michael DeHaan
85ef79443a
Fix a documentation formatting warning.
12 years ago
Joshua Lund
0f81d1630f
* Updated all ansible.cc references in the documentation to point
...
to ansibleworks.com
* Fixed a few misspelled words
12 years ago
Michael DeHaan
58f5bfb4c1
Merge pull request #3252 from tgerla/gettingstarted
...
Explicitly mention the Linux requirement for the Ansible machine, remove...
12 years ago
Tim Gerla
f2cf8d3e67
Fine-tune Ansible control system OS requirements a bit
12 years ago
Jim Tittsler
240a52906e
spelling ansbile->ansible
12 years ago
Tim Gerla
6f426f7986
Explicitly mention the Linux requirement for the Ansible machine, and remove a vestigial heading.
12 years ago
Michael DeHaan
89ee762ab7
Merge pull request #3247 from SirScott/vars_prompt_docs
...
Document the 'default' argument for vars_prompt.
12 years ago
Joshua Lund
ba853b8c1a
Fixed a few small typos
12 years ago
Scott Sturdivant
cc12b85e49
Document the 'default' argument for vars_prompt.
12 years ago
Michael DeHaan
fda74110bd
Merge pull request #3202 from trbs/20130613_docs_fix_ansible_cfg_loading_order
...
docs fix ansible cfg loading order
12 years ago
Michael DeHaan
306caf84f9
Merge pull request #3218 from lorin/fileglob-roles
...
Document: with_file(glob) relative path and roles
12 years ago
Michael DeHaan
a1d1ce8360
Merge branch 'docs_examples' of git://github.com/jpmens/ansible into standardize_docs
12 years ago
Jan-Piet Mens
5c69918d53
DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
...
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string
Added deprecation warning to moduledev.rst and remove deprecated example from it
Fixed up a few typos and uppercased some acronyms.
add consistency to how EXAMPLES are formatted
12 years ago
Lorin Hochstein
d7ba2e06eb
Document: with_file(glob) relative path and roles
...
Document that with_file and with_fileglob path is relative to
the files directory inside of a role.
12 years ago
trbs
653fac2f5c
fix loading order of ansible.cfg in documentation
12 years ago
Ralph Bean
dd5707ddd9
Well, a little more readability.
12 years ago
Ralph Bean
416e72c900
Fix a typo in the docs.
12 years ago
Michael DeHaan
643b5e2c5d
Fix dead link, remove redundant section.
12 years ago
Michael DeHaan
1fd863cf5d
Update docs to reference release tarball directory on new site.
12 years ago
Tim Gerla
8a9cded133
re-add docs css class required for some theme elements
12 years ago
Michael DeHaan
36e9cf5d7d
Mention YAML variable quoting.
12 years ago
Michael DeHaan
36c3c91d6e
Add roles to glossary.
12 years ago
Buce
7d2422cf92
Update supported package managers
...
Ansible has modules for package managers other than yum and apt,
so update the documentation accordingly.
12 years ago
Buce
563147d344
Reference Inventory & Patterns more
...
Link to the Inventory & Patterns page in places where the Getting
Started guide refer to it, so that users unfamiliar with the
inventory syntax can easily familiarize themselves with it.
12 years ago
Tim Gerla
b3e0071635
show entire doc index in left sidebar on the documentation home page
12 years ago
Michael DeHaan
92dce671bb
Resolve merge commit
12 years ago
Michael DeHaan
d706aca82b
Merge
12 years ago
Michael DeHaan
2f37314d41
Revise section referencing 1.1 since release is Monday. Will push with release.
12 years ago
Michael DeHaan
cabeafc550
Remove 1.1 reference (docs will be pushed with release of 1.2)
12 years ago
Bartłomiej Piotrowski
cd65bbc1c4
Add info about apk-tools module to contrib.rst.
12 years ago
Tim Gerla
a26cbd957c
fix heading styles for 'pending information' to avoid creating a new top-level chapter
12 years ago
Patrick Regan
4e5c0da7d6
Trivial typo fix in Amazon documentation
12 years ago
Serge van Ginderachter
18e7974021
add mention of github.com/ginsys/ansible-plugins in contrib.rst
12 years ago
Michael DeHaan
7f0e89a2f6
Explain when statements with |failure and |success.
12 years ago
Michael DeHaan
754d5f91a3
Show how to set PW length.
12 years ago
Michael DeHaan
bddbdd4881
avoid duplicate hyperlink warning (silly Sphinx)
12 years ago
Michael DeHaan
1de2028677
Update docs about examples, add edX online's configuration repo to examples
12 years ago
Michael DeHaan
9f567f05d6
Document group_vars and host_vars additional paths.
12 years ago
Michael DeHaan
fbba92b61e
Add an example of JSON extra variables on the command line.
12 years ago
Jan Duzinkiewicz
8ebd1792eb
advanced playbooks docs yaml snippets always use ---
12 years ago
Michael DeHaan
e75ab08e3d
Merge pull request #3054 from maxamillion/maxamillion/docsite
...
provide link to older docs when mentioning older docs
12 years ago
Michael DeHaan
53c490f453
Merge pull request #3050 from lorin/os-grizzly-only
...
Document: OpenStack inventory script needs grizzly
12 years ago
Michael DeHaan
fd77804bff
Merge pull request #3017 from sergevanginderachter/roles-script
...
Add roles support for the script module
12 years ago
Adam Miller
80bf5d49fe
provide link to older docs when mentioning older docs
12 years ago
Michael DeHaan
0a28358ebc
Minor docs tweak.
12 years ago
Michael DeHaan
c9b2df619b
Merge pull request #3043 from mvo5/feature/document-facts
...
Feature/document facts
12 years ago
Michael DeHaan
31b31a12e7
Merge pull request #3052 from chelsea/devel
...
Updated loop documentation with explicit example of hash usage
12 years ago
Adam Miller
33870745b1
fix ambiguous use of automatically automatic in Roles docs
12 years ago
Chelsea Robb
b8045bc29e
Updated loop documentation with explicit example of hash usage
12 years ago
Michael DeHaan
b5ed926720
Add AWS doc to table of contents.
12 years ago
Lorin Hochstein
bbe352b544
Document: OpenStack inventory script needs grizzly
...
The OpenStack Inventory script uses the OS-EXT-IPS:type parameter
to distinguish between fixed and floating IP addresses.
This was only added in the Grizzly release, see
https://bugs.launchpad.net/nova/+bug/1117784
Specify in the docs that this inventory script requires Grizzly
or greater.
12 years ago
Michael DeHaan
267b29cec7
Manpage tweaks, docs rebuild
12 years ago
Michael DeHaan
efee2e2630
Some tweaks to EC2 docs
12 years ago
Michael DeHaan
383b8ce14a
Merge branch 'awsdocs' of git://github.com/lwade/ansible into devel
12 years ago
Michael DeHaan
2c433cb707
Add an example of Jinja2 casting.
12 years ago
Michael Vogt
746edecf68
fix indent
12 years ago
Michael Vogt
b625f99938
fix typo
12 years ago
Michael Vogt
e13842fad1
add gathering-facts example
12 years ago
Michael Vogt
03e9d9a742
update info on debian/ubuntu packages
12 years ago
Serge van Ginderachter
5859af7285
script support for roles: use the files/ directory
...
instead of an additional scripts/ directory
12 years ago
Serge van Ginderachter
0224dc464d
roles/x/scripts support: update docs
...
also added example on where regular tasks fit in
12 years ago
lwade
07a1b2f1c1
Start of aws best practices docs
12 years ago
Michael DeHaan
8475a92dec
Merge pull request #2939 from mmoya/lookup-crypted-passwds
...
Add support for crypted passwords to password lookup
12 years ago
Maykel Moya
96afc3f462
Add support for crypted passwords to password lookup
...
Added new parameter 'encrypt' with same semantics from that of
vars_prompt. When encryption is requested a random salt will be
generated and stored along the password in the form:
'<password> salt=<salt>'.
Also store passwords with an ending '\n' for easier looking at files
with console tools. File content was being already rstripped so this
is harmless.
12 years ago
Stoned Elipot
2b58e03571
Fix registered variable usage example
12 years ago
Michael DeHaan
8a860779fd
Add some notes about 1.2 things, just to make it more obvious.
12 years ago
Michael DeHaan
0748e86f0e
Fix documentation about examples in modules so folks use the new style.
12 years ago
Maykel Moya
db618f837f
Fix link to Ansible Resources in moduledev page
12 years ago
Michael DeHaan
1b5dd3f15b
Clean up variable examples to say "$x" is still fine for a reference.
12 years ago
Michael DeHaan
63b4eea90b
Remove searchindex.js from source control.
12 years ago
Michael DeHaan
d1a59fe62b
Merge branch 'when_docs' of git://github.com/tartansandal/ansible into devel
...
Conflicts:
docsite/latest/rst/playbooks2.rst
docsite/latest/searchindex.js
12 years ago
Kahlil (Kal) Hodgson
cabd40b0aa
add docs for 'when: var is defined' idiom
12 years ago
Lorin Hochstein
c66b724817
Document: sudo works per-task too
...
Document that you can use sudo at the task level as well
12 years ago
Michael DeHaan
ce67588dcf
Fix module doc organization
12 years ago
Michael DeHaan
627b6a0455
Have 1.2 clear in docs
12 years ago
Tim Gerla
bdf50d1fb7
Fix up a couple of references to 'only_if' and change them to 'when'
12 years ago
Michael DeHaan
4ce6eca8b3
Slight tweak to set_fact variable documentation to clarify scope info.
12 years ago
Michael DeHaan
4bea9a612f
Don't use "finally" here as it's not 2.4 compliant.
12 years ago
Michael DeHaan
391fb98ee2
Allow modules to be categorized, and also sort them when generating the documentation.
12 years ago
Michael DeHaan
0fd3af8c3c
Document regex patterns.
12 years ago
Michael DeHaan
099e7b39a9
use lookup macro rather than with to demonstrate lookup plugins
12 years ago
Michael DeHaan
a61824470d
Update gitignore
12 years ago
Michael DeHaan
b6a8d402c5
Document variables are reserved.
12 years ago
Lars Vogdt
21d9789377
added informations for openSUSE and SUSE Linux Enterprise
12 years ago
Michael DeHaan
13e90c396c
Merge pull request #2733 from chadoh/patch-1
...
Documentation: Mention vars_files before the Roles section in playbooks1 chapter
12 years ago
Stoned Elipot
e1ee257619
Default sudo password to SSH password.
...
While here factor out password prompting in ansible.utils
12 years ago
Michael DeHaan
b1d40ed064
Merge pull request #2734 from chadoh/patch-2
...
Documentation: Links are the best kinds of instructions
12 years ago
Jim Kleckner
5e5235a433
Nit fix spelling of separate
12 years ago
Chad Ostrowski
e1396f853b
Links are the best kinds of instructions
...
Link people right to this page on Github, so they can click "edit" right there. No need for them to search for the repo, figure out that the docsite isn't a separate repo, and navigate to the given dir.
12 years ago
Chad Ostrowski
0bb145af40
Mention vars_files before the Roles section
...
The Roles section assumes some familiarity with vars_files, which this note attempts to briefly provide.
12 years ago
Michael DeHaan
7fabaec55f
Fix doc formatting error
12 years ago
Michael DeHaan
c9a128a5c5
Rewrote the precedence docs.
12 years ago
Michael DeHaan
cf3c77661b
Document the new handler flushing system.
12 years ago
Michael DeHaan
84781bf185
Add documentation about pre_tasks and post_tasks with roles.
12 years ago
Michael DeHaan
adac8f5312
Showcase the new-style lookup plugin access in the authorized_key docs rather than the old-style $FILE
12 years ago
Michael DeHaan
cce2cad8dc
Fix with_sequence doc error
12 years ago
Michael DeHaan
84fb92dac6
Working on the FAQ.
12 years ago
Michael DeHaan
728d81bf12
Add link to prior docs version.
12 years ago
Michael DeHaan
62fe4cc3af
Explain conditionals as applied to roles. I could also explain with_items but the scope questions are complex
...
here, and it is better to include such loops inside the imported tasks.
12 years ago
Michael DeHaan
687a68091f
Mention roles in best practices
12 years ago
Michael DeHaan
ffb00d2071
Favor {{ foo }} rather than $foo in documentation.
12 years ago
Michael DeHaan
9ed246e432
Resolve merge conflict.
12 years ago
Michael DeHaan
26819d707d
Reorganize docs structure to support snapshots.
12 years ago
Michael DeHaan
e63dac15eb
Moving some more files into snapshot directory
12 years ago
Michael DeHaan
148d8859ba
Docs on parameterized roles, make document generation output less noisy
12 years ago
Michael DeHaan
a0a2ef3d9d
Merge pull request #2640 from trevor/devel
...
make json valid
12 years ago
Trevor Wennblom
b779fa4fe9
make json valid
12 years ago
Michael DeHaan
c5d9823467
Fix some items related to playbook includes and indentation.
12 years ago
gw0
80a4e02372
Improved Lookup plugins documentation
12 years ago
Michael DeHaan
f9890c9973
Show other way to ignore command/shell errors
12 years ago
Michael DeHaan
bccab0f2b7
Merge pull request #2514 from raphinou/patch-1
...
replaced && by ||
12 years ago
Michael DeHaan
cdf5e006ff
Merge pull request #2508 from tgerla/devel
...
Add some examples for local_action and rsync
12 years ago
Victor Castell
ceede2f71f
Place ad-hoc stuff from docs under context
12 years ago
raphinou
ba2582fff6
replaced && by ||
...
In the example, you want /bin/true to be executed if the first command has an error return code. Combining command with && will run the second only if the first is successful. Combining them with ||, the second will be run only of the first fails, what is wanted here.
12 years ago
Tim Gerla
d3a7c729ab
Add a note regarding rsync and ssh-agent/passphrase-less keys
12 years ago
Tim Gerla
0e01085ab6
Add some examples for local_action and rsync
12 years ago
Michael DeHaan
783a12cc0e
Resolve merge commit.
12 years ago
Michael DeHaan
518007a1ba
Fix version added attribute, update docs URL
12 years ago
Michael DeHaan
3d5aa5dc2c
Merge pull request #2487 from dorfsmay/20130322
...
fixed doc regarding wild card pattern on groups.
12 years ago
michael@ansibleworks.com
ecda87cb63
Fixup docsite links
12 years ago
michael@ansibleworks.com
e086d6fd89
Doc updates
12 years ago
Yves Dorfsman
5485451ddb
fix doc regarding wild card pattern on groups.
12 years ago
Tim Gerla
242f988daf
Add links to the ansible-examples repository
12 years ago
Yves Dorfsman
8b10cc5946
Mention of ansible-doc and man pages for modules.
12 years ago
Michael DeHaan
22cd10bc6f
Add note about wanting to do crypted passwords with $PASSWORD plugin.
12 years ago
Michael DeHaan
afb9ad1358
Fix duplicate Sphinx target in documentation.
12 years ago
Michael DeHaan
64a3839511
Fixup documentation formatting
12 years ago
Lorin Hochstein
efd3cbe8b4
Document how to implement check mode
...
Fixes #2410
12 years ago
bfx81
649dc25d46
Updated getting ansible on gentoo
12 years ago
Michael DeHaan
7d6d009d15
Merge pull request #2411 from tyll/docs
...
glossary.rst: fix type regarding file mode
12 years ago
Lorin Hochstein
c7cf2bc343
Docfix: ANSIBLE_LIBRARY_PATH -> ANSIBLE_LIBRARY
12 years ago
Till Maas
2b4621d8d7
glossary.rst: fix typo regarding file mode
12 years ago
Yves Dorfsman
2d0df2f233
Rephrased an awkward sentence.
12 years ago
Yves Dorfsman
d1d7d56315
typo in playbooks2.rst
12 years ago
Michael DeHaan
c53653dc0d
Merge pull request #2348 from candeira/password-plugin
...
password lookup plugin, with working tests and documentation
12 years ago
Michael DeHaan
daf7419f3a
Make Python 3 instructions a bit more clear.
12 years ago
Javier Candeira
ca6c36e1ac
password lookup plugin, with working tests and documentation
12 years ago
Michel Blanc
9c6b28c218
Update gettingstarted.rst
...
Adds note on python 3 incompatibility
Added note about ansible_python_interpreter for people having python3 as default interpreter (mainly Arch users ?)
Should fix #2344
12 years ago
Jim Kleckner
92844d3dcd
Minor spelling fixes
12 years ago
Michael DeHaan
b11cf15b3e
Merge pull request #2302 from leucos/patch-1
...
Update playbooks2.rst
12 years ago
Michael DeHaan
0b1343a281
Merge pull request #2306 from tbielawa/docdepends
...
Update the Makefile and build-site.py to notify of missing dependencies
12 years ago
Tim Bielawa
badb41390e
Update the Makefile and build-site.py to notify of missing dependencies for doc compiling
12 years ago
Michel Blanc
aeed04b73f
Cosmetic fixes
...
Fixed typo in passlib URL link
Fixed style in cryp scheme list
Fixed bullet 7 in variable precedence section
Adds statement regarding passlib requirement
12 years ago
Michel Blanc
f3b06a3008
Adds crypt scheme list for vars_prompt
...
Added more details on encrypt usage for vars_prompt, including a list of
crypt schemes and a ling to the passlib documentation.
12 years ago
Michel Blanc
d03954a24b
Update playbooks2.rst
...
Added doc on encrypt capability of vars_prompt.
Assuming the example in https://github.com/ansible/ansible/blob/devel/examples/playbooks/prompts.yml is still valid.
12 years ago
Dag Wieers
59912b47be
Allow 'make rpm' without the need for env-setup
...
As it used to be before, 'make rpm' from a cloned repository should work without the need to run hacking/env-setup. It's an easy fix, in line with what we already did for the man-pages.
12 years ago
Daniel Hokka Zakrisson
b130716b61
YAML requires quoting the entire value when it starts with a quote
...
Fixes #2280 .
12 years ago
Michael DeHaan
de09e9dade
Update doc reference to clarify that $item isn't expanded here.
12 years ago
Brian Coca
372b60a5f7
Added tip about ANSIBLE_KEEP_REMOTE_FILES to docsite
...
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
12 years ago
Michael DeHaan
a19a0ca91b
Update documentation on complex args to new simpler format.
12 years ago
Michael DeHaan
ff32e404d5
Most people are better off doing looping inside the playbook versus
...
outside, and get confused about scope. As a result simply this documentation
feature by not talking about it :)
12 years ago
Daniel Hokka Zakrisson
52c9a7af24
Fix references to user.username to be user.name
12 years ago
Cliffano Subagio
19082f7b20
Fix proxy env format
...
The incorrect format (e.g. http_proxy=http://proxy.bos.example.com:8080 ) gave this error: "environment must be a dictionary".
12 years ago
Michael DeHaan
f6e3583b9b
Fix path to DOCUMENTATION.yml
12 years ago
Michael DeHaan
3aceae57af
Fixup documentation formatting
12 years ago
Michael DeHaan
a5e4f4461e
Add linode example, remove macports since it didn't do changed=True/etc
12 years ago
Michael DeHaan
bd6852eda0
Merge branch 'doc_html_tweaks' of git://github.com/nigelm/ansible into devel
12 years ago
Michael DeHaan
7a6f3e6a6a
Missing colon in docs.
12 years ago