majic-ansible-roles Changeset

Changeset - 734eb461396e

Parent rev.

Child rev.

[Not reviewed]

0 5 0

Branko Majic (branko) - 10 days ago 2024-09-09 14:24:49
branko@majic.rs

MAR-218: Document the passlib Python package requirement:

- The library is used for hashing the operating system user passwords
during account creation.

5 files changed with 12 insertions and 6 deletions:

docs/about.rst

docs/index.rst

docs/releasenotes.rst

docs/usage.rst

requirements.in

0 comments (0 inline, 0 general)

docs/about.rst

➞

Show inline comments

 supported releases, see :ref:`rolereference`.
 At the moment, the roles have been written for and tested against **Ansible
 .9.x**.
 The roles also utilise the ``ipv4/ipv6`` lookup plugins which require
 ``netaddr`` package to be installed. Make sure you have the packages
 available on controller machine.
 ``netaddr`` package to be installed. The ``passlib`` package is used
 for hashing the operating system passwords. Make sure you have the
 packages available on controller machine.
 Why were these roles created?
 -----------------------------
 For a long time I have had a couple of Internet-facing servers where I hosted

docs/index.rst

➞

Show inline comments

 supported releases, see :ref:`rolereference`.
 At the moment, the roles have been written for and tested against **Ansible
 .9.x**.
 The roles also utilise the ``ipv4/ipv6`` lookup plugins which require
 ``netaddr`` package to be installed. Make sure you have the packages
 available on controller machine.
 ``netaddr`` package to be installed. The ``passlib`` package is used
 for hashing the operating system passwords. Make sure you have the
 packages available on controller machine.
 Contents
 ========
 .. toctree::

docs/releasenotes.rst

➞

Show inline comments

@@ @@ -7,12 +7,13 @@ x.y.z @@
 **Breaking changes:**
 * All roles
   * Dropped support for Debian 11 (Bullseye).
   * ``passlib`` Python package is now required for using the roles.
 **New features/improvements**
 * ``backup_client`` role
   * Switched to using Paramiko + SFTP backend (instead of pexpect +

docs/usage.rst

➞

Show inline comments

    ::
      mkdir ~/mysite/
      mkvirtualenv -a ~/mysite/ mysite
      pip install -U pip setuptools
      pip install 'ansible~=10.3.0' netaddr
+     pip install 'ansible~=10.3.0' netaddr passlib
 .. warning::
    The ``netaddr`` package is needed for ``ipv4/ipv6`` lookup plugins
    which is used internally by some of the roles.
    which is used internally by some of the roles. The ``passlib``
    package is required in order to hash passwords when creating system
    users.
 Cloning the *Majic Ansible Roles*
 ---------------------------------
 With most of the software pieces in place, the only missing thing is the Majic

requirements.in

➞

Show inline comments

 # Ansible and role runtime.
 ansible~=10.3
 netaddr
 passlib
 python-ldap
 # Development and testing.
 ansible-lint
 defusedxml
 flake8

0 comments (0 inline, 0 general)