Skip to content

Commit 38850eb

Browse files
patchback[bot]samccannAndersson007
authored
Styleguide update for installation_distros.rst - AI-assisted (#2855) (#2897)
* cursor-ai assisted style edits * ai-assist - clarified sections * Apply suggestions from code review * Apply suggestion from @Andersson007 --------- (cherry picked from commit 8b3818d) Co-authored-by: Sandra McCann <[email protected]> Co-authored-by: Andrew Klychkov <[email protected]>
1 parent 33ea044 commit 38850eb

File tree

1 file changed

+57
-46
lines changed

1 file changed

+57
-46
lines changed

docs/docsite/rst/installation_guide/installation_distros.rst

Lines changed: 57 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,82 +3,90 @@
33
Installing Ansible on specific operating systems
44
================================================
55

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.
710

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.
913

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.
1115

12-
To add instructions for another distribution to this guide, package maintainers **must** do the following:
16+
Requirements for adding new distributions
17+
-----------------------------------------
1318

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.
1725

1826
.. contents::
1927
:local:
2028

2129
Installing Ansible on Fedora Linux
2230
----------------------------------
2331

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:
2535

2636
.. code-block:: bash
2737
2838
$ sudo dnf install ansible
2939
30-
To install the minimal ``ansible-core`` package run:
40+
Install the minimal ``ansible-core`` package:
3141

3242
.. code-block:: bash
3343
3444
$ sudo dnf install ansible-core
3545
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:
3948

4049
.. code-block:: bash
4150
4251
$ sudo dnf install ansible-collection-community-general
4352
4453
See the `Fedora Packages index <https://packages.fedoraproject.org/search?query=ansible-collection>`_
45-
for a full list of Ansible collections packaged in Fedora.
54+
for a complete list of Ansible collections packaged in Fedora.
4655

47-
Please `file a bug <https://bugzilla.redhat.com/enter_bug.cgi>`_ against the
48-
``Fedora`` product in Red Hat Bugzilla to reach the package maintainers.
56+
Contact the package maintainers by `filing a bug <https://bugzilla.redhat.com/enter_bug.cgi>`_ against the ``Fedora`` product in Red Hat Bugzilla.
4957

5058
Installing Ansible from EPEL
5159
----------------------------
5260

53-
Users of CentOS Stream, Almalinux, Rocky Linux, and related distributions
54-
can install ``ansible`` or Ansible collections from the community maintained
55-
`EPEL <https://docs.fedoraproject.org/en-US/epel/>`_
56-
(Extra Packages for Enterprise Linux) repository.
5761

58-
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:
6063

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.
6366

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.
6468

6569
Installing Ansible on OpenSUSE Tumbleweed/Leap
6670
----------------------------------------------
6771

72+
OpenSUSE provides Ansible packages through the standard package manager.
73+
6874
.. code-block:: bash
6975
7076
$ sudo zypper install ansible
7177
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.
7379

7480
.. _from_apt:
7581

7682
Installing Ansible on Ubuntu
7783
----------------------------
7884

85+
Ubuntu provides Ansible packages through a Personal Package Archive (PPA) that contains more recent versions than the standard repositories.
86+
7987
Ubuntu builds are available `in a PPA here <https://launchpad.net/~ansible/+archive/ubuntu/ansible>`_.
8088

81-
To configure the PPA on your system and install Ansible run these commands:
89+
Configure the PPA on your system and install Ansible:
8290

8391
.. code-block:: bash
8492
@@ -87,17 +95,22 @@ To configure the PPA on your system and install Ansible run these commands:
8795
$ sudo add-apt-repository --yes --update ppa:ansible/ansible
8896
$ sudo apt install ansible
8997
90-
.. 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.
91103

92104
File any issues in `the PPA's issue tracker <https://github.com/ansible-community/ppa/issues>`_.
93105

94-
95106
Installing Ansible on Debian
96107
----------------------------
97108

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.
99112

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:
101114

102115
.. list-table::
103116
:header-rows: 1
@@ -119,10 +132,10 @@ To get a more recent version, Debian users can use the Ubuntu PPA according to t
119132
- Ubuntu 18.04 (Bionic)
120133
- ``bionic``
121134

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.
123136

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):
126139

127140
.. code-block:: bash
128141
@@ -131,39 +144,37 @@ Set ``UBUNTU_CODENAME=...`` based on the table above (we use ``jammy`` in this e
131144
$ 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
132145
$ sudo apt update && sudo apt install ansible
133146
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.
136149

137150
These commands download the signing key and add an entry to apt's sources pointing to the PPA.
138151

139152
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.
145156

146157
Installing Ansible on Arch Linux
147158
--------------------------------
148159

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:
150163

151164
.. code-block:: bash
152165
153166
$ sudo pacman -S ansible
154167
155-
To install the minimal ``ansible-core`` package run:
168+
Install the minimal ``ansible-core`` package:
156169

157170
.. code-block:: bash
158171
159172
$ sudo pacman -S ansible-core
160173
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.
165176

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.
167178

168179
.. _from_windows:
169180

0 commit comments

Comments
 (0)