Ansible maintains only installation via pip although other installation ways are possible e.g. via apt packages. Installing Ansible — Ansible Community Documentation
Installing Ansible via pip
To install it via pip we first need to check that we have Python installed:
$ which python
/home/bojan/anaconda3/bin/python
Next is checking whether pip is installed:
$ python3 -m pip -V
pip 20.1.1 from /home/bojan/anaconda3/lib/python3.8/site-packages/pip (python 3.8)
To install Ansible:
$ python3 -m pip install --user ansible
Collecting ansible
Downloading ansible-6.7.0-py3-none-any.whl (42.8 MB)
42.8 MB 5.4 MB/s
Collecting ansible-core~=2.13.7
Downloading ansible_core-2.13.13-py3-none-any.whl (2.1 MB)
2.1 MB 8.8 MB/s
Requirement already satisfied: cryptography in /home/bojan/anaconda3/lib/python3.8/site-packages (from ansible-core~=2.13.7->ansible) (2.9.2)
Requirement already satisfied: packaging in /home/bojan/anaconda3/lib/python3.8/site-packages (from ansible-core~=2.13.7->ansible) (20.4)
Collecting resolvelib<0.9.0,>=0.5.3
Downloading resolvelib-0.8.1-py2.py3-none-any.whl (16 kB)
Requirement already satisfied: PyYAML>=5.1 in /home/bojan/anaconda3/lib/python3.8/site-packages (from ansible-core~=2.13.7->ansible) (5.3.1)
Collecting jinja2>=3.0.0
Downloading Jinja2-3.1.3-py3-none-any.whl (133 kB)
133 kB 12.6 MB/s
Requirement already satisfied: six>=1.4.1 in /home/bojan/anaconda3/lib/python3.8/site-packages (from cryptography->ansible-core~=2.13.7->ansible) (1.15.0)
Requirement already satisfied: cffi!=1.11.3,>=1.8 in /home/bojan/anaconda3/lib/python3.8/site-packages (from cryptography->ansible-core~=2.13.7->ansible) (1.14.0)
Requirement already satisfied: pyparsing>=2.0.2 in /home/bojan/anaconda3/lib/python3.8/site-packages (from packaging->ansible-core~=2.13.7->ansible) (2.4.7)
Collecting MarkupSafe>=2.0
Downloading MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (26 kB)
Requirement already satisfied: pycparser in /home/bojan/anaconda3/lib/python3.8/site-packages (from cffi!=1.11.3,>=1.8->cryptography->ansible-core~=2.13.7->ansible) (2.20)
Installing collected packages: resolvelib, MarkupSafe, jinja2, ansible-core, ansible
Successfully installed MarkupSafe-2.1.5 ansible-6.7.0 ansible-core-2.13.13 jinja2-3.1.3 resolvelib-0.8.1
Installation via apt package maanger
On a host we want to use as Ansible control node execute:
$ sudo apt update
$ sudo apt install ansible
To verify its install location:
$ which ansible
/usr/bin/ansible
/usr/bin/ansible
To verify installation, let's check Ansible version:
$ ansible --version
ansible 2.9.6
config file = /etc/ansible/ansible.cfg
configured module search path = ['/home/bojan/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
ansible python module location = /usr/lib/python3/dist-packages/ansible
executable location = /usr/bin/ansible
python version = 3.8.10 (default, Mar 15 2022, 12:22:08) [GCC 9.4.0]
We can also check out Ansible Help Command:
$ ansible --help
usage: ansible [-h] [--version] [-v] [-b] [--become-method BECOME_METHOD]
[--become-user BECOME_USER] [-K] [-i INVENTORY] [--list-hosts]
[-l SUBSET] [-P POLL_INTERVAL] [-B SECONDS] [-o] [-t TREE] [-k]
[--private-key PRIVATE_KEY_FILE] [-u REMOTE_USER]
[-c CONNECTION] [-T TIMEOUT]
[--ssh-common-args SSH_COMMON_ARGS]
[--sftp-extra-args SFTP_EXTRA_ARGS]
[--scp-extra-args SCP_EXTRA_ARGS]
[--ssh-extra-args SSH_EXTRA_ARGS] [-C] [--syntax-check] [-D]
[-e EXTRA_VARS] [--vault-id VAULT_IDS]
[--ask-vault-pass | --vault-password-file VAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
[-a MODULE_ARGS] [-m MODULE_NAME]
pattern
Define and run a single task 'playbook' against a set of hosts
positional arguments:
pattern host pattern
optional arguments:
--ask-vault-pass ask for vault password
--list-hosts outputs a list of matching hosts; does not execute
anything else
--playbook-dir BASEDIR
Since this tool does not use playbooks, use this as a
substitute playbook directory.This sets the relative
path for many features including roles/ group_vars/
etc.
--syntax-check perform a syntax check on the playbook, but do not
execute it
--vault-id VAULT_IDS the vault identity to use
--vault-password-file VAULT_PASSWORD_FILES
vault password file
--version show program's version number, config file location,
configured module search path, module location,
executable location and exit
-B SECONDS, --background SECONDS
run asynchronously, failing after X seconds
(default=N/A)
-C, --check don't make any changes; instead, try to predict some
of the changes that may occur
-D, --diff when changing (small) files and templates, show the
differences in those files; works great with --check
-M MODULE_PATH, --module-path MODULE_PATH
prepend colon-separated path(s) to module library (def
ault=~/.ansible/plugins/modules:/usr/share/ansible/plu
gins/modules)
-P POLL_INTERVAL, --poll POLL_INTERVAL
set the poll interval if using -B (default=15)
-a MODULE_ARGS, --args MODULE_ARGS
module arguments
-e EXTRA_VARS, --extra-vars EXTRA_VARS
set additional variables as key=value or YAML/JSON, if
filename prepend with @
-f FORKS, --forks FORKS
specify number of parallel processes to use
(default=5)
-h, --help show this help message and exit
-i INVENTORY, --inventory INVENTORY, --inventory-file INVENTORY
specify inventory host path or comma separated host
list. --inventory-file is deprecated
-l SUBSET, --limit SUBSET
further limit selected hosts to an additional pattern
-m MODULE_NAME, --module-name MODULE_NAME
module name to execute (default=command)
-o, --one-line condense output
-t TREE, --tree TREE log output to this directory
-v, --verbose verbose mode (-vvv for more, -vvvv to enable
connection debugging)
Privilege Escalation Options:
control how and which user you become as on target hosts
--become-method BECOME_METHOD
privilege escalation method to use (default=sudo), use
`ansible-doc -t become -l` to list valid choices.
--become-user BECOME_USER
run operations as this user (default=root)
-K, --ask-become-pass
ask for privilege escalation password
-b, --become run operations with become (does not imply password
prompting)
Connection Options:
control as whom and how to connect to hosts
--private-key PRIVATE_KEY_FILE, --key-file PRIVATE_KEY_FILE
use this file to authenticate the connection
--scp-extra-args SCP_EXTRA_ARGS
specify extra arguments to pass to scp only (e.g. -l)
--sftp-extra-args SFTP_EXTRA_ARGS
specify extra arguments to pass to sftp only (e.g. -f,
-l)
--ssh-common-args SSH_COMMON_ARGS
specify common arguments to pass to sftp/scp/ssh (e.g.
ProxyCommand)
--ssh-extra-args SSH_EXTRA_ARGS
specify extra arguments to pass to ssh only (e.g. -R)
-T TIMEOUT, --timeout TIMEOUT
override the connection timeout in seconds
(default=10)
-c CONNECTION, --connection CONNECTION
connection type to use (default=smart)
-k, --ask-pass ask for connection password
-u REMOTE_USER, --user REMOTE_USER
connect as this user (default=None)
Some modules do not make sense in Ad-Hoc (include, meta, etc)
usage: ansible [-h] [--version] [-v] [-b] [--become-method BECOME_METHOD]
[--become-user BECOME_USER] [-K] [-i INVENTORY] [--list-hosts]
[-l SUBSET] [-P POLL_INTERVAL] [-B SECONDS] [-o] [-t TREE] [-k]
[--private-key PRIVATE_KEY_FILE] [-u REMOTE_USER]
[-c CONNECTION] [-T TIMEOUT]
[--ssh-common-args SSH_COMMON_ARGS]
[--sftp-extra-args SFTP_EXTRA_ARGS]
[--scp-extra-args SCP_EXTRA_ARGS]
[--ssh-extra-args SSH_EXTRA_ARGS] [-C] [--syntax-check] [-D]
[-e EXTRA_VARS] [--vault-id VAULT_IDS]
[--ask-vault-pass | --vault-password-file VAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
[-a MODULE_ARGS] [-m MODULE_NAME]
pattern
Define and run a single task 'playbook' against a set of hosts
positional arguments:
pattern host pattern
optional arguments:
--ask-vault-pass ask for vault password
--list-hosts outputs a list of matching hosts; does not execute
anything else
--playbook-dir BASEDIR
Since this tool does not use playbooks, use this as a
substitute playbook directory.This sets the relative
path for many features including roles/ group_vars/
etc.
--syntax-check perform a syntax check on the playbook, but do not
execute it
--vault-id VAULT_IDS the vault identity to use
--vault-password-file VAULT_PASSWORD_FILES
vault password file
--version show program's version number, config file location,
configured module search path, module location,
executable location and exit
-B SECONDS, --background SECONDS
run asynchronously, failing after X seconds
(default=N/A)
-C, --check don't make any changes; instead, try to predict some
of the changes that may occur
-D, --diff when changing (small) files and templates, show the
differences in those files; works great with --check
-M MODULE_PATH, --module-path MODULE_PATH
prepend colon-separated path(s) to module library (def
ault=~/.ansible/plugins/modules:/usr/share/ansible/plu
gins/modules)
-P POLL_INTERVAL, --poll POLL_INTERVAL
set the poll interval if using -B (default=15)
-a MODULE_ARGS, --args MODULE_ARGS
module arguments
-e EXTRA_VARS, --extra-vars EXTRA_VARS
set additional variables as key=value or YAML/JSON, if
filename prepend with @
-f FORKS, --forks FORKS
specify number of parallel processes to use
(default=5)
-h, --help show this help message and exit
-i INVENTORY, --inventory INVENTORY, --inventory-file INVENTORY
specify inventory host path or comma separated host
list. --inventory-file is deprecated
-l SUBSET, --limit SUBSET
further limit selected hosts to an additional pattern
-m MODULE_NAME, --module-name MODULE_NAME
module name to execute (default=command)
-o, --one-line condense output
-t TREE, --tree TREE log output to this directory
-v, --verbose verbose mode (-vvv for more, -vvvv to enable
connection debugging)
Privilege Escalation Options:
control how and which user you become as on target hosts
--become-method BECOME_METHOD
privilege escalation method to use (default=sudo), use
`ansible-doc -t become -l` to list valid choices.
--become-user BECOME_USER
run operations as this user (default=root)
-K, --ask-become-pass
ask for privilege escalation password
-b, --become run operations with become (does not imply password
prompting)
Connection Options:
control as whom and how to connect to hosts
--private-key PRIVATE_KEY_FILE, --key-file PRIVATE_KEY_FILE
use this file to authenticate the connection
--scp-extra-args SCP_EXTRA_ARGS
specify extra arguments to pass to scp only (e.g. -l)
--sftp-extra-args SFTP_EXTRA_ARGS
specify extra arguments to pass to sftp only (e.g. -f,
-l)
--ssh-common-args SSH_COMMON_ARGS
specify common arguments to pass to sftp/scp/ssh (e.g.
ProxyCommand)
--ssh-extra-args SSH_EXTRA_ARGS
specify extra arguments to pass to ssh only (e.g. -R)
-T TIMEOUT, --timeout TIMEOUT
override the connection timeout in seconds
(default=10)
-c CONNECTION, --connection CONNECTION
connection type to use (default=smart)
-k, --ask-pass ask for connection password
-u REMOTE_USER, --user REMOTE_USER
connect as this user (default=None)
Some modules do not make sense in Ad-Hoc (include, meta, etc)
We can peek into the Ansible configuration file:
$ vi /etc/ansible/ansible.cfg
/etc/ansible/ansible.cfg:
# config file for ansible -- https://ansible.com/
# ===============================================
# nearly all parameters can be overridden in ansible-playbook
# or with command line flags. ansible will read ANSIBLE_CONFIG,
# ansible.cfg in the current working directory, .ansible.cfg in
# the home directory or /etc/ansible/ansible.cfg, whichever it
# finds first
[defaults]
# some basic default values...
#inventory = /etc/ansible/hosts
#library = /usr/share/my_modules/
#module_utils = /usr/share/my_module_utils/
#remote_tmp = ~/.ansible/tmp
#local_tmp = ~/.ansible/tmp
#plugin_filters_cfg = /etc/ansible/plugin_filters.yml
#forks = 5
#poll_interval = 15
#sudo_user = root
#ask_sudo_pass = True
#ask_pass = True
#transport = smart
#remote_port = 22
#module_lang = C
#module_set_locale = False
# ===============================================
# nearly all parameters can be overridden in ansible-playbook
# or with command line flags. ansible will read ANSIBLE_CONFIG,
# ansible.cfg in the current working directory, .ansible.cfg in
# the home directory or /etc/ansible/ansible.cfg, whichever it
# finds first
[defaults]
# some basic default values...
#inventory = /etc/ansible/hosts
#library = /usr/share/my_modules/
#module_utils = /usr/share/my_module_utils/
#remote_tmp = ~/.ansible/tmp
#local_tmp = ~/.ansible/tmp
#plugin_filters_cfg = /etc/ansible/plugin_filters.yml
#forks = 5
#poll_interval = 15
#sudo_user = root
#ask_sudo_pass = True
#ask_pass = True
#transport = smart
#remote_port = 22
#module_lang = C
#module_set_locale = False
...
Version of the Ansible package available at apt package manager is much older than the latest Ansible release: Ubuntu – Package Search Results shows version 2.9.6 (for Ubuntu Focal, 20.04) while the latest Ansible release ( Releases and maintenance — Ansible Documentation) at time of publishing this article is 5.
To uninstall Ansible installed via default apt package repository:
$ dpkg --list | grep ansible
ii ansible 2.9.6+dfsg-1 all Configuration management, deployment, and task execution system
$ sudo apt purge ansible
To install the most recent version of Ansible built for your/given Ubuntu version we can use ppa:ansible/ansible:
$ sudo apt update
$ sudo apt install software-properties-common
$ sudo add-apt-repository --yes --update ppa:ansible/ansible
$ sudo apt install ansible
$ dpkg --list | grep ansible
ii ansible 5.10.0-1ppa~focal all batteries-included package providing a curated set of Ansible collections in addition to ansible-core
ii ansible-core 2.12.7-1ppa~focal all Ansible IT Automation
Note that this recent version separates ansible and ansible-core packages and their versions.
---
Troubleshooting Ansible Installation
I had the situation where:
$ ansible
Traceback (most recent call last):
File "/home/bojan/.local/bin/ansible", line 5, in <module>
from ansible.cli.adhoc import main
File "/home/bojan/.local/lib/python3.10/site-packages/ansible/cli/__init__.py", line 73, in <module>
jinja2_version = version('jinja2')
File "/usr/lib/python3.10/importlib/metadata/__init__.py", line 996, in version
return distribution(distribution_name).version
File "/usr/lib/python3.10/importlib/metadata/__init__.py", line 969, in distribution
return Distribution.from_name(distribution_name)
File "/usr/lib/python3.10/importlib/metadata/__init__.py", line 548, in from_name
raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: No package metadata was found for jinja2
$ which ansible
/home/bojan/.local/bin/ansible
/home/bojan/.local/bin/ansible
Reinstalling Ansible fixed the problem:
$ python3 -m pip install --user ansible
Collecting ansible
Downloading ansible-10.0.0-py3-none-any.whl (53.8 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.8/53.8 MB 5.4 MB/s eta 0:00:00
Collecting ansible-core~=2.17.0
Downloading ansible_core-2.17.0-py3-none-any.whl (2.2 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.5 MB/s eta 0:00:00
Requirement already satisfied: resolvelib<1.1.0,>=0.5.3 in /home/bojan/.local/lib/python3.10/site-packages (from ansible-core~=2.17.0->ansible) (0.5.4)
Requirement already satisfied: packaging in /home/bojan/.local/lib/python3.10/site-packages (from ansible-core~=2.17.0->ansible) (23.1)
Requirement already satisfied: PyYAML>=5.1 in /usr/lib/python3/dist-packages (from ansible-core~=2.17.0->ansible) (5.4.1)
Collecting jinja2>=3.0.0
Downloading jinja2-3.1.4-py3-none-any.whl (133 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.3/133.3 KB 10.0 MB/s eta 0:00:00
Requirement already satisfied: cryptography in /usr/lib/python3/dist-packages (from ansible-core~=2.17.0->ansible) (3.4.8)
Requirement already satisfied: MarkupSafe>=2.0 in /usr/lib/python3/dist-packages (from jinja2>=3.0.0->ansible-core~=2.17.0->ansible) (2.0.1)
Installing collected packages: jinja2, ansible-core, ansible
Attempting uninstall: ansible-core
Found existing installation: ansible-core 2.15.0
Uninstalling ansible-core-2.15.0:
Successfully uninstalled ansible-core-2.15.0
Successfully installed ansible-10.0.0 ansible-core-2.17.0 jinja2-3.1.4
Collecting ansible
Downloading ansible-10.0.0-py3-none-any.whl (53.8 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.8/53.8 MB 5.4 MB/s eta 0:00:00
Collecting ansible-core~=2.17.0
Downloading ansible_core-2.17.0-py3-none-any.whl (2.2 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.5 MB/s eta 0:00:00
Requirement already satisfied: resolvelib<1.1.0,>=0.5.3 in /home/bojan/.local/lib/python3.10/site-packages (from ansible-core~=2.17.0->ansible) (0.5.4)
Requirement already satisfied: packaging in /home/bojan/.local/lib/python3.10/site-packages (from ansible-core~=2.17.0->ansible) (23.1)
Requirement already satisfied: PyYAML>=5.1 in /usr/lib/python3/dist-packages (from ansible-core~=2.17.0->ansible) (5.4.1)
Collecting jinja2>=3.0.0
Downloading jinja2-3.1.4-py3-none-any.whl (133 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.3/133.3 KB 10.0 MB/s eta 0:00:00
Requirement already satisfied: cryptography in /usr/lib/python3/dist-packages (from ansible-core~=2.17.0->ansible) (3.4.8)
Requirement already satisfied: MarkupSafe>=2.0 in /usr/lib/python3/dist-packages (from jinja2>=3.0.0->ansible-core~=2.17.0->ansible) (2.0.1)
Installing collected packages: jinja2, ansible-core, ansible
Attempting uninstall: ansible-core
Found existing installation: ansible-core 2.15.0
Uninstalling ansible-core-2.15.0:
Successfully uninstalled ansible-core-2.15.0
Successfully installed ansible-10.0.0 ansible-core-2.17.0 jinja2-3.1.4
Verification:
$ ansible --version
ansible [core 2.17.0]
config file = /home/bojan/dev/github/ansible-demo/ansible.cfg
configured module search path = ['/home/bojan/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
ansible python module location = /home/bojan/.local/lib/python3.10/site-packages/ansible
ansible collection location = /home/bojan/.ansible/collections:/usr/share/ansible/collections
executable location = /home/bojan/.local/bin/ansible
python version = 3.10.12 (main, Nov 20 2023, 15:14:05) [GCC 11.4.0] (/usr/bin/python3)
jinja version = 3.1.4
libyaml = True
References:
Installing Ansible on specific operating systems — Ansible Documentation
No comments:
Post a Comment