From 32cb2fa21536ae23ba15a1a3dd0e7a3b552036b3 Mon Sep 17 00:00:00 2001 From: Sandra Wills Date: Mon, 12 Oct 2015 11:41:09 -0400 Subject: [PATCH] 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 --- docsite/rst/ansible_ssh_changes_note.rst | 3 +++ docsite/rst/faq.rst | 5 ++--- docsite/rst/guide_rax.rst | 4 +--- docsite/rst/guide_vagrant.rst | 4 +--- docsite/rst/intro_inventory.rst | 6 +----- docsite/rst/intro_windows.rst | 4 +--- docsite/rst/playbooks_variables.rst | 4 +--- 7 files changed, 10 insertions(+), 20 deletions(-) create mode 100644 docsite/rst/ansible_ssh_changes_note.rst diff --git a/docsite/rst/ansible_ssh_changes_note.rst b/docsite/rst/ansible_ssh_changes_note.rst new file mode 100644 index 00000000000..ccc289d89db --- /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 ee6f5eacd6c..90b9a1cb09e 100644 --- a/docsite/rst/faq.rst +++ b/docsite/rst/faq.rst @@ -3,9 +3,6 @@ Frequently Asked Questions Here are some commonly-asked questions and their answers. -.. 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. .. _set_environment: @@ -25,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 8195b5e923e..5ad806e4e58 100644 --- a/docsite/rst/guide_rax.rst +++ b/docsite/rst/guide_rax.rst @@ -123,9 +123,7 @@ 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. -.. 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. +.. include:: ansible_ssh_changes_note.rst .. code-block:: yaml diff --git a/docsite/rst/guide_vagrant.rst b/docsite/rst/guide_vagrant.rst index 746448c9b62..2aad2f1a031 100644 --- a/docsite/rst/guide_vagrant.rst +++ b/docsite/rst/guide_vagrant.rst @@ -105,9 +105,7 @@ inventory file may look something like this: machine ansible_host=127.0.0.1 ansible_port=2222 -.. 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. +.. 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 diff --git a/docsite/rst/intro_inventory.rst b/docsite/rst/intro_inventory.rst index 2fb934ab329..0a9d4f0c9de 100644 --- a/docsite/rst/intro_inventory.rst +++ b/docsite/rst/intro_inventory.rst @@ -65,11 +65,7 @@ For numeric patterns, leading zeros can be included or removed, as desired. Rang db-[a:f].example.com -You can also select the connection type and user on a per host basis:: - -.. 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. +.. include:: ansible_ssh_changes_note.rst You can also select the connection type and user on a per host basis: diff --git a/docsite/rst/intro_windows.rst b/docsite/rst/intro_windows.rst index 1cfd1eaf2e5..64cd64b885a 100644 --- a/docsite/rst/intro_windows.rst +++ b/docsite/rst/intro_windows.rst @@ -154,9 +154,7 @@ Ansible's windows support relies on a few standard variables to indicate the use winserver1.example.com winserver2.example.com -.. 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. +.. include:: ansible_ssh_changes_note.rst In group_vars/windows.yml, define the following inventory variables:: diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index 021b640a1f1..cf4fd7fb696 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -735,9 +735,7 @@ a use for it. If multiple variables of the same name are defined in different places, they get overwritten in a certain order. -.. 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. +.. include:: ansible_ssh_changes_note.rst In 1.x the precedence is: