From 4a0e06dc8008fd96d6a7ec26a0fd7b102a5c3815 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sun, 29 Sep 2013 19:16:59 -0400 Subject: [PATCH] Resolving some doc errors. --- docsite/latest/rst/developing_modules.rst | 2 - docsite/latest/rst/index.rst | 2 +- docsite/latest/rst/intro_getting_started.rst | 2 +- docsite/latest/rst/intro_inventory.rst | 44 +++++++++---------- docsite/latest/rst/modules.rst | 6 +-- docsite/latest/rst/playbooks.rst | 6 +-- docsite/latest/rst/playbooks_conditionals.rst | 3 +- docsite/latest/rst/playbooks_roles.rst | 4 +- 8 files changed, 32 insertions(+), 37 deletions(-) diff --git a/docsite/latest/rst/developing_modules.rst b/docsite/latest/rst/developing_modules.rst index 248dde472f..e8b1a75179 100644 --- a/docsite/latest/rst/developing_modules.rst +++ b/docsite/latest/rst/developing_modules.rst @@ -431,8 +431,6 @@ the program. Stop by the mailing list to inquire about requirements. :doc:`modules` Learn about available modules - :doc:`contrib` - User contributed playbooks, modules, and articles `Github modules directory `_ Browse source of core modules `Mailing List `_ diff --git a/docsite/latest/rst/index.rst b/docsite/latest/rst/index.rst index 273f51f115..2dc56ee080 100644 --- a/docsite/latest/rst/index.rst +++ b/docsite/latest/rst/index.rst @@ -28,7 +28,7 @@ An Introduction intro_installation intro_getting_started intro_inventory - intro_inventory_dynamic + intro_dynamic_inventory intro_patterns intro_adhoc modules diff --git a/docsite/latest/rst/intro_getting_started.rst b/docsite/latest/rst/intro_getting_started.rst index 513a90c49e..a78c16536f 100644 --- a/docsite/latest/rst/intro_getting_started.rst +++ b/docsite/latest/rst/intro_getting_started.rst @@ -111,7 +111,7 @@ Also note that host key checking in paramiko mode is reasonably slow, therefore .. seealso:: - :doc:`examples` + :doc:`intro_ad_hoc` Examples of basic commands :doc:`playbooks` Learning ansible's configuration management language diff --git a/docsite/latest/rst/intro_inventory.rst b/docsite/latest/rst/intro_inventory.rst index 3d47a570f9..7876f4bb90 100644 --- a/docsite/latest/rst/intro_inventory.rst +++ b/docsite/latest/rst/intro_inventory.rst @@ -1,4 +1,4 @@ -.. _patterns: +.. _inventory: Inventory ========= @@ -172,27 +172,27 @@ List of Behavioral Inventory Parameters As aluded to above, setting the following variables controls how ansible interacts with remote hosts. Some we have already mentioned:: -ansible_ssh_host - The name of the host to connect to, if different from the alias you wish to give to it. -ansible_ssh_port - The ssh port number, if not 22 -ansible_ssh_user - The default ssh user name to use. -ansible_ssh_pass - The ssh password to use (this is insecure, we strongly recommend using --ask-pass or SSH keys) -ansible_connection - Connection type of the host. Candidates are local, ssh or paramiko. The default is paramiko before Ansible 1.2, and 'smart' afterwards which detects whether usage of 'ssh' would be feasible based on whether ControlPersist is supported. -ansible_ssh_private_key_file - Private key file used by ssh. Useful if using multiple keys and you don't want to use SSH agent. -ansible_python_interpreter - The target host python path. This is userful for systems with more - than one Python or not located at "/usr/bin/python" such as \*BSD, or where /usr/bin/python - is not a 2.X series Python. We do not use the "/usr/bin/env" mechanism as that requires the remote user's - path to be set right and also assumes the "python" executable is named python, where the executable might - be named something like "python26". -ansible\_\*\_interpreter - Works for anything such as ruby or perl and works just like ansible_python_interpreter. - This replaces shebang of modules which will run on that host. + ansible_ssh_host + The name of the host to connect to, if different from the alias you wish to give to it. + ansible_ssh_port + The ssh port number, if not 22 + ansible_ssh_user + The default ssh user name to use. + ansible_ssh_pass + The ssh password to use (this is insecure, we strongly recommend using --ask-pass or SSH keys) + ansible_connection + Connection type of the host. Candidates are local, ssh or paramiko. The default is paramiko before Ansible 1.2, and 'smart' afterwards which detects whether usage of 'ssh' would be feasible based on whether ControlPersist is supported. + ansible_ssh_private_key_file + Private key file used by ssh. Useful if using multiple keys and you don't want to use SSH agent. + ansible_python_interpreter + The target host python path. This is userful for systems with more + than one Python or not located at "/usr/bin/python" such as \*BSD, or where /usr/bin/python + is not a 2.X series Python. We do not use the "/usr/bin/env" mechanism as that requires the remote user's + path to be set right and also assumes the "python" executable is named python, where the executable might + be named something like "python26". + ansible\_\*\_interpreter + Works for anything such as ruby or perl and works just like ansible_python_interpreter. + This replaces shebang of modules which will run on that host. Examples from a host file:: diff --git a/docsite/latest/rst/modules.rst b/docsite/latest/rst/modules.rst index c4f65b84be..5a8cd388ca 100644 --- a/docsite/latest/rst/modules.rst +++ b/docsite/latest/rst/modules.rst @@ -63,13 +63,11 @@ See :doc:`moduledev`. .. seealso:: - :doc:`contrib` - User contributed playbooks, modules, and articles - :doc:`examples` + :doc:`intro_adhoc` Examples of using modules in /usr/bin/ansible :doc:`playbooks` Examples of using modules with /usr/bin/ansible-playbook - :doc:`moduledev` + :doc:`developing_modules` How to write your own modules :doc:`api` Examples of using modules with the Python API diff --git a/docsite/latest/rst/playbooks.rst b/docsite/latest/rst/playbooks.rst index 280f499bb5..eca407c1fa 100644 --- a/docsite/latest/rst/playbooks.rst +++ b/docsite/latest/rst/playbooks.rst @@ -325,13 +325,13 @@ can do this:: :doc:`YAMLSyntax` Learn about YAML syntax - :doc:`bestpractices` + :doc:`playbooks_bestpractices` Various tips about managing playbooks in the real world :doc:`modules` Learn about available modules - :doc:`moduledev` + :doc:`developing_modules` Learn how to extend Ansible by writing your own modules - :doc:`patterns` + :doc:`intro_patterns` Learn about how to select hosts `Github examples directory `_ Complete playbook files from the github project source diff --git a/docsite/latest/rst/playbooks_conditionals.rst b/docsite/latest/rst/playbooks_conditionals.rst index 7a51e5b429..8d5f1cb795 100644 --- a/docsite/latest/rst/playbooks_conditionals.rst +++ b/docsite/latest/rst/playbooks_conditionals.rst @@ -85,8 +85,7 @@ If a required variable has not been set, you can skip or fail using Jinja2's This is especially useful in combination with the conditional import of vars files (see below). -.. note :: When combining `when` with `with_items`, be aware that the `when` statement is processed separately for each item. - This is by design:: +Note that when combining `when` with `with_items` (see :doc:`playbook_loops`), be aware that the `when` statement is processed separately for each item. This is by design:: tasks: - command: echo {{ item }} diff --git a/docsite/latest/rst/playbooks_roles.rst b/docsite/latest/rst/playbooks_roles.rst index ed6e0eab54..28b8dd4b09 100644 --- a/docsite/latest/rst/playbooks_roles.rst +++ b/docsite/latest/rst/playbooks_roles.rst @@ -63,7 +63,7 @@ contain all of my wordpress tasks in a single wordpress.yml file, and use it lik - include: wordpress.yml user=alice - include: wordpress.yml user=bob -Variables passed in can then be used in the included files. We've already covered them a bit in :doc:`intro_variales`. +Variables passed in can then be used in the included files. We've already covered them a bit in :doc:`intro_variables`. You can reference them like this:: {{ user }} @@ -318,7 +318,7 @@ The resulting order of execution would be as follows:: Learn about YAML syntax :doc:`playbooks` Review the basic Playbook language features - :doc:`bestpractices` + :doc:`playbooks_best_practices` Various tips about managing playbooks in the real world :doc:`modules` Learn about available modules