You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docsite/rst/installation_guide/installation_distros.rst
+57-46Lines changed: 57 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,82 +3,90 @@
3
3
Installing Ansible on specific operating systems
4
4
================================================
5
5
6
-
.. note:: These instructions are provided by their respective communities. Any bugs/issues should be filed with that community to update these instructions. Ansible maintains only the ``pip install`` instructions.
6
+
.. note::
7
+
These instructions come from their respective communities.
8
+
If you encounter bugs or issues, file them with that community to update these instructions.
9
+
Ansible maintains only the ``pip install`` instructions.
7
10
8
-
The ``ansible`` package can always be :ref:`installed from PyPI using pip <intro_installation_guide>` on most systems but it is also packaged and maintained by the community for a variety of Linux distributions.
11
+
You can always :ref:`install the ansible package from PyPI using pip <intro_installation_guide>` on most systems.
12
+
The community also packages and maintains Ansible for various Linux distributions.
9
13
10
-
This document guides you through installing Ansible from different distribution's package repositories.
14
+
This guide shows you how to install Ansible from different distribution package repositories.
11
15
12
-
To add instructions for another distribution to this guide, package maintainers **must** do the following:
16
+
Requirements for adding new distributions
17
+
-----------------------------------------
13
18
14
-
* Ensure the distribution provides a reasonably up-to-date version of ``ansible``.
15
-
* Ensure that ``ansible-core`` and ``ansible`` versions are kept in sync to the extent that the build system allows.
16
-
* Provide a way to contact the distribution maintainers as part of the instructions. Distribution maintainers are also encouraged to join the `Ansible Packaging <https://matrix.to/#/#packaging:ansible.com>`_ Matrix room.
19
+
Package maintainers who want to add instructions for another distribution to this guide must meet the following requirements:
20
+
21
+
* Ensure the distribution provides a reasonably up-to-date version of ``ansible``.
22
+
* Keep ``ansible-core`` and ``ansible`` versions synchronized to the extent that the build system allows.
23
+
* Provide a way to contact the distribution maintainers as part of the instructions.
24
+
* Distribution maintainers are also encouraged to join and monitor the `Ansible Packaging <https://matrix.to/#/#packaging:ansible.com>`_ Matrix room.
17
25
18
26
.. contents::
19
27
:local:
20
28
21
29
Installing Ansible on Fedora Linux
22
30
----------------------------------
23
31
24
-
To install the full ``ansible`` package run:
32
+
Fedora Linux provides both the full Ansible package and the minimal ansible-core package through the standard repositories.
33
+
34
+
Install the full ``ansible`` package:
25
35
26
36
.. code-block:: bash
27
37
28
38
$ sudo dnf install ansible
29
39
30
-
To install the minimal ``ansible-core`` package run:
40
+
Install the minimal ``ansible-core`` package:
31
41
32
42
.. code-block:: bash
33
43
34
44
$ sudo dnf install ansible-core
35
45
36
-
Several Ansible collections are also available from the Fedora repositories as
37
-
standalone packages that users can install alongside ``ansible-core``.
38
-
For example, to install the ``community.general`` collection run:
46
+
Fedora repositories include several Ansible collections as standalone packages that you can install alongside ``ansible-core``.
47
+
For example, install the ``community.general`` collection:
After `enabling the EPEL repository <https://docs.fedoraproject.org/en-US/epel/#_quickstart>`_,
59
-
users can use the same ``dnf`` commands as for Fedora Linux.
62
+
If you use CentOS Stream, Almalinux, Rocky Linux, or related distributions, you can install ``ansible`` or Ansible collections from the community-maintained `EPEL <https://docs.fedoraproject.org/en-US/epel/>`_ (Extra Packages for Enterprise Linux) repository:
60
63
61
-
Please `file a bug <https://bugzilla.redhat.com/enter_bug.cgi>`_ against the
62
-
``Fedora EPEL`` product in Red Hat Bugzilla to reach the package maintainers.
64
+
1. `Enable the EPEL repository <https://docs.fedoraproject.org/en-US/epel/#_quickstart>`_.
65
+
2. Use the same ``dnf`` commands as for Fedora Linux.
63
66
67
+
Contact the package maintainers by `filing a bug <https://bugzilla.redhat.com/enter_bug.cgi>`_ against the ``Fedora EPEL`` product in Red Hat Bugzilla.
64
68
65
69
Installing Ansible on OpenSUSE Tumbleweed/Leap
66
70
----------------------------------------------
67
71
72
+
OpenSUSE provides Ansible packages through the standard package manager.
73
+
68
74
.. code-block:: bash
69
75
70
76
$ sudo zypper install ansible
71
77
72
-
See `OpenSUSE Support Portal <https://en.opensuse.org/Portal:Support>`_ for additional help with Ansible on OpenSUSE.
78
+
See the `OpenSUSE Support Portal <https://en.opensuse.org/Portal:Support>`_ for additional help with Ansible on OpenSUSE.
73
79
74
80
.. _from_apt:
75
81
76
82
Installing Ansible on Ubuntu
77
83
----------------------------
78
84
85
+
Ubuntu provides Ansible packages through a Personal Package Archive (PPA) that contains more recent versions than the standard repositories.
86
+
79
87
Ubuntu builds are available `in a PPA here <https://launchpad.net/~ansible/+archive/ubuntu/ansible>`_.
80
88
81
-
To configure the PPA on your system and install Ansible run these commands:
89
+
Configure the PPA on your system and install Ansible:
82
90
83
91
.. code-block:: bash
84
92
@@ -87,17 +95,22 @@ To configure the PPA on your system and install Ansible run these commands:
.. note:: On older Ubuntu distributions, "software-properties-common" is called "python-software-properties". You may want to use ``apt-get`` rather than ``apt`` in older versions. Also, be aware that only newer distributions (that is, 18.04, 18.10, and later) have a ``-u`` or ``--update`` flag. Adjust your script as needed.
98
+
.. note::
99
+
On older Ubuntu distributions, "software-properties-common" is called "python-software-properties".
100
+
You may want to use ``apt-get`` rather than ``apt`` in older versions.
101
+
Also, only newer distributions (18.04, 18.10, and later) have a ``-u`` or ``--update`` flag.
102
+
Adjust your script as needed.
91
103
92
104
File any issues in `the PPA's issue tracker <https://github.com/ansible-community/ppa/issues>`_.
93
105
94
-
95
106
Installing Ansible on Debian
96
107
----------------------------
97
108
98
-
While Ansible is available from the `main Debian repository <https://packages.debian.org/stable/ansible>`_, it can be out of date.
109
+
Debian users can choose between the standard repository or the Ubuntu PPA for more recent versions.
110
+
111
+
While Ansible is available from the `main Debian repository <https://packages.debian.org/stable/ansible>`_, this version can be outdated.
99
112
100
-
To get a more recent version, Debian users can use the Ubuntu PPA according to the following table:
113
+
For a more recent version, Debian users can use the Ubuntu PPA according to the following table:
101
114
102
115
.. list-table::
103
116
:header-rows: 1
@@ -119,10 +132,10 @@ To get a more recent version, Debian users can use the Ubuntu PPA according to t
119
132
- Ubuntu 18.04 (Bionic)
120
133
- ``bionic``
121
134
122
-
In the following example, we assume that you have wget and gpg already installed (``sudo apt install wget gpg``).
135
+
The following example assumes that you already have ``wget`` and ``gpg`` installed.
123
136
124
-
Run the following commands to add the repository and install Ansible.
125
-
Set ``UBUNTU_CODENAME=...`` based on the table above (we use ``jammy`` in this example).
137
+
Add the repository and install Ansible.
138
+
Set ``UBUNTU_CODENAME=...`` based on the table above (we use ``jammy`` in this example):
126
139
127
140
.. code-block:: bash
128
141
@@ -131,39 +144,37 @@ Set ``UBUNTU_CODENAME=...`` based on the table above (we use ``jammy`` in this e
131
144
$ echo"deb [signed-by=/usr/share/keyrings/ansible-archive-keyring.gpg] http://ppa.launchpad.net/ansible/ansible/ubuntu $UBUNTU_CODENAME main"| sudo tee /etc/apt/sources.list.d/ansible.list
132
145
$ sudo apt update && sudo apt install ansible
133
146
134
-
Note: the " " around the keyserver URL are important.
135
-
Around the "echo deb" it is important to use " " rather than ' '.
147
+
.. note::
148
+
Use double quotes around the keyserver URL and in the "echo deb" command like in the example above.
136
149
137
150
These commands download the signing key and add an entry to apt's sources pointing to the PPA.
138
151
139
152
Previously, you may have used ``apt-key add``.
140
-
This is now `deprecated <https://manpages.debian.org/testing/apt/apt-key.8.en.html>`_
141
-
for security reasons (on Debian, Ubuntu, and elsewhere).
142
-
For more details, see `this AskUbuntu post <https://askubuntu.com/a/1307181>`_.
143
-
Also note that, for security reasons, we do NOT add the key to ``/etc/apt/trusted.gpg.d/``
144
-
nor to ``/etc/apt/trusted.gpg`` where it would be allowed to sign releases from ANY repository.
153
+
The ``apt-key add`` approach is now `deprecated <https://askubuntu.com/a/1307181>`_ for security reasons (on Debian, Ubuntu, and elsewhere).
154
+
155
+
As such, we do NOT add the key to ``/etc/apt/trusted.gpg.d/`` or to ``/etc/apt/trusted.gpg`` where the key would be allowed to sign releases from ANY repository.
145
156
146
157
Installing Ansible on Arch Linux
147
158
--------------------------------
148
159
149
-
To install the full ``ansible`` package run:
160
+
Arch Linux provides both the full Ansible package and ansible-core through the standard package repositories.
161
+
162
+
Install the full ``ansible`` package:
150
163
151
164
.. code-block:: bash
152
165
153
166
$ sudo pacman -S ansible
154
167
155
-
To install the minimal ``ansible-core`` package run:
168
+
Install the minimal ``ansible-core`` package:
156
169
157
170
.. code-block:: bash
158
171
159
172
$ sudo pacman -S ansible-core
160
173
161
-
Several Ansible ecosystem packages are also available from the Arch Linux repositories as
162
-
standalone packages that users can install alongside ``ansible-core``.
163
-
See the `Arch Linux Packages index <https://archlinux.org/packages/?sort=&q=ansible>`_
164
-
for a full list of Ansible packages in Arch Linux.
174
+
Arch Linux repositories include several Ansible ecosystem packages as standalone packages that you can install alongside ``ansible-core``.
175
+
See the `Arch Linux Packages index <https://archlinux.org/packages/?sort=&q=ansible>`_ for a complete list of Ansible packages in Arch Linux.
165
176
166
-
Please `open an issue <https://gitlab.archlinux.org/archlinux/packaging/packages>`_ in the related package GitLab repository to reach the package maintainers.
177
+
Contact the package maintainers by `opening an issue <https://gitlab.archlinux.org/archlinux/packaging/packages>`_ in the related package GitLab repository.
0 commit comments