diff --git a/docsite/rst/ansible_ssh_changes_note.rst b/docsite/rst/ansible_ssh_changes_note.rst new file mode 100644 index 0000000000..ccc289d89d --- /dev/null +++ b/docsite/rst/ansible_ssh_changes_note.rst @@ -0,0 +1,3 @@ +.. note:: + + Ansible 2.0 has deprecated 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. diff --git a/docsite/rst/faq.rst b/docsite/rst/faq.rst index fd08de00e9..90b9a1cb09 100644 --- a/docsite/rst/faq.rst +++ b/docsite/rst/faq.rst @@ -3,6 +3,7 @@ Frequently Asked Questions Here are some commonly-asked questions and their answers. + .. _set_environment: How can I set the PATH or any other environment variable for a task or entire playbook? @@ -21,6 +22,8 @@ How do I handle different machines needing different user accounts or ports to l Setting inventory variables in the inventory file is the easiest way. +.. include:: ansible_ssh_changes_note.rst + For instance, suppose these hosts have different usernames and ports:: [webservers] diff --git a/docsite/rst/guide_rax.rst b/docsite/rst/guide_rax.rst index 53c956f54e..5ad806e4e5 100644 --- a/docsite/rst/guide_rax.rst +++ b/docsite/rst/guide_rax.rst @@ -123,6 +123,8 @@ Here's what it would look like in a playbook, assuming the parameters were defin The rax module returns data about the nodes it creates, like IP addresses, hostnames, and login passwords. By registering the return value of the step, it is possible used this data to dynamically add the resulting hosts to inventory (temporarily, in memory). This facilitates performing configuration actions on the hosts in a follow-on task. In the following example, the servers that were successfully created using the above task are dynamically added to a group called "raxhosts", with each nodes hostname, IP address, and root password being added to the inventory. +.. include:: ansible_ssh_changes_note.rst + .. code-block:: yaml - name: Add the instances we created (by public IP) to the group 'raxhosts' diff --git a/docsite/rst/guide_vagrant.rst b/docsite/rst/guide_vagrant.rst index 122242ccc1..2aad2f1a03 100644 --- a/docsite/rst/guide_vagrant.rst +++ b/docsite/rst/guide_vagrant.rst @@ -105,6 +105,8 @@ inventory file may look something like this: machine ansible_host=127.0.0.1 ansible_port=2222 +.. include:: ansible_ssh_changes_note.rst + If you want to run Ansible manually, you will want to make sure to pass ``ansible`` or ``ansible-playbook`` commands the correct arguments for the username (usually ``vagrant``) and the SSH key (since Vagrant 1.7.0, this will be something like diff --git a/docsite/rst/intro_inventory.rst b/docsite/rst/intro_inventory.rst index d3ac8cfa18..0a9d4f0c9d 100644 --- a/docsite/rst/intro_inventory.rst +++ b/docsite/rst/intro_inventory.rst @@ -64,7 +64,12 @@ For numeric patterns, leading zeros can be included or removed, as desired. Rang [databases] db-[a:f].example.com -You can also select the connection type and user on a per host basis:: + +.. include:: ansible_ssh_changes_note.rst + +You can also select the connection type and user on a per host basis: + +:: [targets] diff --git a/docsite/rst/intro_windows.rst b/docsite/rst/intro_windows.rst index a5b7c619ef..64cd64b885 100644 --- a/docsite/rst/intro_windows.rst +++ b/docsite/rst/intro_windows.rst @@ -154,6 +154,8 @@ Ansible's windows support relies on a few standard variables to indicate the use winserver1.example.com winserver2.example.com +.. include:: ansible_ssh_changes_note.rst + In group_vars/windows.yml, define the following inventory variables:: # it is suggested that these be encrypted with ansible-vault: diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index 7b71223f23..cf4fd7fb69 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -719,7 +719,7 @@ or in a file as above. .. _variable_precedence: Variable Precedence: Where Should I Put A Variable? -``````````````````````````````````````````````````` +```````````````````````````````````````````````````` A lot of folks may ask about how variables override another. Ultimately it's Ansible's philosophy that it's better you know where to put a variable, and then you have to think about it a lot less. @@ -735,6 +735,8 @@ a use for it. If multiple variables of the same name are defined in different places, they get overwritten in a certain order. +.. include:: ansible_ssh_changes_note.rst + In 1.x the precedence is: * extra vars (``-e`` in the command line) always win