From 45ff6df1afd4742555e460554b9b850c6c866e31 Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Mon, 5 Nov 2018 11:08:13 -0600 Subject: [PATCH] Remove Deprecated configs 2.8 (#46825) * Removed deprecated ANSIBLE_HOSTS * Bump sudo/su configs to match deprecation version for cli and playbook args * Bump include configs to match deprecation version for 'include' --- docs/docsite/man/ansible-playbook.1.html | 31 --------- docs/docsite/man/ansible.1.html | 63 ------------------- .../installation_guide/intro_installation.rst | 4 -- docs/docsite/rst/plugins/inventory.rst | 2 +- .../rst/porting_guides/porting_guide_2.4.rst | 2 +- lib/ansible/config/base.yml | 33 ++++------ 6 files changed, 13 insertions(+), 122 deletions(-) delete mode 100644 docs/docsite/man/ansible-playbook.1.html delete mode 100644 docs/docsite/man/ansible.1.html diff --git a/docs/docsite/man/ansible-playbook.1.html b/docs/docsite/man/ansible-playbook.1.html deleted file mode 100644 index 7b41d80f14..0000000000 --- a/docs/docsite/man/ansible-playbook.1.html +++ /dev/null @@ -1,31 +0,0 @@ - - -ansible-playbook

Name

ansible-playbook — run an ansible playbook

Synopsis

ansible-playbook <filename.yml> … [options]

DESCRIPTION

Ansible playbooks are a configuration and multinode deployment -system. Ansible-playbook is the tool used to run them. See the -project home page (link below) for more information.

ARGUMENTS

-filename.yml -
-The names of one or more YAML format files to run as ansible playbooks. -

OPTIONS

--i PATH, --inventory=PATH -
-The PATH to the inventory hosts file, which defaults to /etc/ansible/hosts. -
--M DIRECTORY, --module-path=DIRECTORY -
-The DIRECTORY to load modules from. The default is /usr/share/ansible. -
--f NUM, --forks=NUM -
-Level of parallelism. NUM is specified as an integer, the default is 5. -
--k, --ask-pass -
-Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. -
--T SECONDS, --timeout=SECONDS -
-Connection timeout to use when trying to talk to hosts, in SECONDS. -

ENVIRONMENT

The following environment variables may specified.

ANSIBLE_HOSTS  — Override the default ansible hosts file

ANSIBLE_LIBRARY — Override the default ansible module library path

AUTHOR

Ansible was originally written by Michael DeHaan. See the AUTHORS file -for a complete list of contributors.

COPYRIGHT

Copyright © 2012, Michael DeHaan

Ansible is released under the terms of the GPLv3 License.

SEE ALSO

ansible(1)

Extensive documentation as well as IRC and mailing list info -is available on the ansible home page: https://ansible.github.com/

diff --git a/docs/docsite/man/ansible.1.html b/docs/docsite/man/ansible.1.html deleted file mode 100644 index 3191c5502c..0000000000 --- a/docs/docsite/man/ansible.1.html +++ /dev/null @@ -1,63 +0,0 @@ - - -ansible

Name

ansible — run a command somewhere else

Synopsis

ansible <host-pattern> [-f forks] [-m module_name] [-a args]

DESCRIPTION

Ansible is an extra-simple tool/framework/API for doing 'remote things' over -SSH.

ARGUMENTS

-host-pattern -
-A name of a group in the inventory file, a shell-like glob selecting -hosts in inventory file, or any combination of the two separated by -semicolons. -

OPTIONS

--i PATH, --inventory=PATH -
-The PATH to the inventory hosts file, which defaults to /etc/ansible/hosts. -
--f NUM, --forks=NUM -
-Level of parallelism. NUM is specified as an integer, the default is 5. -
--m NAME, --module-name=NAME -
-Execute the module called NAME. -
--M DIRECTORY, --module-path=DIRECTORY -
-The DIRECTORY to load modules from. The default is /usr/share/ansible. -
--a 'ARGUMENTS', --args='ARGUMENTS' -
-The ARGUMENTS to pass to the module. -
--k, --ask-pass -
-Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. -
--o, --one-line -
-Try to output everything on one line. -
--t DIRECTORY, --tree=DIRECTORY -
-Save contents in this output DIRECTORY, with the results saved in a -file named after each host. -
--T SECONDS, --timeout=SECONDS -
-Connection timeout to use when trying to talk to hosts, in SECONDS. -
--B NUM, --background=NUM -
-Run commands in the background, killing the task after NUM seconds. -
--P NUM, --poll=NUM -
-Poll a background job every NUM seconds. Requires -B. -
--u USERNAME, --remote-user=USERNAME -
-Use this remote USERNAME instead of root. -

INVENTORY

Ansible stores the hosts it can potentially operate on in an inventory -file. The syntax is one host per line. Groups headers are allowed and -are included on their own line, enclosed in square brackets.

FILES

/etc/ansible/hosts — Default inventory file

/usr/share/ansible/ — Default module library

ENVIRONMENT

The following environment variables may specified.

ANSIBLE_HOSTS  — Override the default ansible hosts file

ANSIBLE_LIBRARY — Override the default ansible module library path

AUTHOR

Ansible was originally written by Michael DeHaan. See the AUTHORS file -for a complete list of contributors.

COPYRIGHT

Copyright © 2012, Michael DeHaan

Ansible is released under the terms of the GPLv3 License.

SEE ALSO

ansible-playbook(1)

Extensive documentation as well as IRC and mailing list info -is available on the ansible home page: https://ansible.github.com/

diff --git a/docs/docsite/rst/installation_guide/intro_installation.rst b/docs/docsite/rst/installation_guide/intro_installation.rst index 3248eef456..82afc650b5 100644 --- a/docs/docsite/rst/installation_guide/intro_installation.rst +++ b/docs/docsite/rst/installation_guide/intro_installation.rst @@ -376,10 +376,6 @@ other than /etc/ansible/hosts: $ echo "127.0.0.1" > ~/ansible_hosts $ export ANSIBLE_INVENTORY=~/ansible_hosts -.. note:: - - ANSIBLE_INVENTORY is available starting at 1.9 and substitutes the deprecated ANSIBLE_HOSTS - You can read more about the inventory file in later parts of the manual. Now let's test things with a ping command: diff --git a/docs/docsite/rst/plugins/inventory.rst b/docs/docsite/rst/plugins/inventory.rst index 198a57e147..7b867e8e84 100644 --- a/docs/docsite/rst/plugins/inventory.rst +++ b/docs/docsite/rst/plugins/inventory.rst @@ -61,7 +61,7 @@ The ``auto`` inventory plugin is enabled by default and works by using the ``plu | |--ec2-98-765-432-10.compute-1.amazonaws.com |--@ungrouped: -You can set the default inventory path (via ``inventory`` in the `ansible.cfg` [defaults] section or the :envvar:`ANSIBLE_HOSTS` environment variable) to your inventory source(s). Now running ``ansible-inventory --graph`` should yield the same output as when you passed your YAML configuration source(s) directly. You can add custom inventory plugins to your plugin path to use in the same way. +You can set the default inventory path (via ``inventory`` in the `ansible.cfg` [defaults] section or the :envvar:`ANSIBLE_INVENTORY` environment variable) to your inventory source(s). Now running ``ansible-inventory --graph`` should yield the same output as when you passed your YAML configuration source(s) directly. You can add custom inventory plugins to your plugin path to use in the same way. Your inventory source might be a directory of inventory configuration files. The constructed inventory plugin only operates on those hosts already in inventory, so you may want the constructed inventory configuration parsed at a particular point (such as last). Ansible parses the directory recursively, alphabetically. You cannot configure the parsing approach, so name your files to make it work predictably. Inventory plugins that extend constructed features directly can work around that restriction by adding constructed options in addition to the inventory plugin options. Otherwise, you can use ``-i`` with multiple sources to impose a specific order, e.g. ``-i demo.aws_ec2.yml -i clouds.yml -i constructed.yml``. diff --git a/docs/docsite/rst/porting_guides/porting_guide_2.4.rst b/docs/docsite/rst/porting_guides/porting_guide_2.4.rst index 1ebd12fe4a..e77a3f5e35 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_2.4.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_2.4.rst @@ -54,7 +54,7 @@ Specifying Inventory sources ----------------------------- Use of ``--inventory-file`` on the command line is now deprecated. Use ``--inventory`` or ``-i``. -The associated ini configuration key, ``hostfile``, and environment variable, :envvar:`ANSIBLE_HOSTS`, +The associated ini configuration key, ``hostfile``, and environment variable, ``ANSIBLE_HOSTS``, are also deprecated. Replace them with the configuration key ``inventory`` and environment variable :envvar:`ANSIBLE_INVENTORY`. Use of multiple tags diff --git a/lib/ansible/config/base.yml b/lib/ansible/config/base.yml index 188fb7c465..816496297b 100644 --- a/lib/ansible/config/base.yml +++ b/lib/ansible/config/base.yml @@ -392,7 +392,7 @@ DEFAULT_ASK_SUDO_PASS: default: False deprecated: why: In favor of Ansible Become, which is a generic framework. See become_ask_pass. - version: "2.8" + version: "2.9" alternatives: become description: - This controls whether an Ansible playbook should prompt for a sudo password. @@ -405,7 +405,7 @@ DEFAULT_ASK_SU_PASS: default: False deprecated: why: In favor of Ansible Become, which is a generic framework. See become_ask_pass. - version: "2.8" + version: "2.9" alternatives: become description: - This controls whether an Ansible playbook should prompt for a su password. @@ -632,7 +632,7 @@ DEFAULT_HANDLER_INCLUDES_STATIC: type: boolean deprecated: why: include itself is deprecated and this setting will not matter in the future - version: "2.8" + version: "2.12" alternatives: none as its already built into the decision between include_tasks and import_tasks DEFAULT_HASH_BEHAVIOUR: name: Hash merge behaviour @@ -656,20 +656,9 @@ DEFAULT_HOST_LIST: default: /etc/ansible/hosts description: Comma separated list of Ansible inventory sources env: - - name: ANSIBLE_HOSTS - deprecated: - why: The variable is misleading as it can be a list of hosts and/or paths to inventory sources - version: "2.8" - alternatives: ANSIBLE_INVENTORY - name: ANSIBLE_INVENTORY expand_relative_paths: True ini: - - key: hostfile - section: defaults - deprecated: - why: The key is misleading as it can also be a list of hosts, a directory or a list of paths - version: "2.8" - alternatives: "[defaults]\ninventory=/path/to/file|dir" - key: inventory section: defaults type: pathlist @@ -1074,7 +1063,7 @@ DEFAULT_SUDO: default: False deprecated: why: In favor of Ansible Become, which is a generic framework - version: "2.8" + version: "2.9" alternatives: become description: 'Toggle the use of "sudo" for tasks.' env: [{name: ANSIBLE_SUDO}] @@ -1086,7 +1075,7 @@ DEFAULT_SUDO_EXE: default: sudo deprecated: why: In favor of Ansible Become, which is a generic framework. See become_exe. - version: "2.8" + version: "2.9" alternatives: become description: 'specify an "sudo" executable, otherwise it relies on PATH.' env: [{name: ANSIBLE_SUDO_EXE}] @@ -1097,7 +1086,7 @@ DEFAULT_SUDO_FLAGS: default: '-H -S -n' deprecated: why: In favor of Ansible Become, which is a generic framework. See become_flags. - version: "2.8" + version: "2.9" alternatives: become description: 'Flags to pass to "sudo"' env: [{name: ANSIBLE_SUDO_FLAGS}] @@ -1108,7 +1097,7 @@ DEFAULT_SUDO_USER: default: deprecated: why: In favor of Ansible Become, which is a generic framework. See become_user. - version: "2.8" + version: "2.9" alternatives: become description: 'User you become when using "sudo", leaving it blank will use the default configured on the target (normally root)' env: [{name: ANSIBLE_SUDO_USER}] @@ -1119,7 +1108,7 @@ DEFAULT_SU_EXE: default: su deprecated: why: In favor of Ansible Become, which is a generic framework. See become_exe. - version: "2.8" + version: "2.9" alternatives: become description: 'specify an "su" executable, otherwise it relies on PATH.' env: [{name: ANSIBLE_SU_EXE}] @@ -1130,7 +1119,7 @@ DEFAULT_SU_FLAGS: default: '' deprecated: why: In favor of Ansible Become, which is a generic framework. See become_flags. - version: "2.8" + version: "2.9" alternatives: become description: 'Flags to pass to su' env: [{name: ANSIBLE_SU_FLAGS}] @@ -1145,7 +1134,7 @@ DEFAULT_SU_USER: - {key: su_user, section: defaults} deprecated: why: In favor of Ansible Become, which is a generic framework. See become_user. - version: "2.8" + version: "2.9" alternatives: become DEFAULT_SYSLOG_FACILITY: name: syslog facility @@ -1166,7 +1155,7 @@ DEFAULT_TASK_INCLUDES_STATIC: version_added: "2.1" deprecated: why: include itself is deprecated and this setting will not matter in the future - version: "2.8" + version: "2.12" alternatives: None, as its already built into the decision between include_tasks and import_tasks DEFAULT_TERMINAL_PLUGIN_PATH: name: Terminal Plugins Path