From 734eb461396e85abfc6a9cac6acdf71a50a05e9b 2024-09-09 14:24:49
From: Branko Majic <branko@majic.rs>
Date: 2024-09-09 14:24:49
Subject: [PATCH] MAR-218: Document the passlib Python package requirement:

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

---

diff --git a/docs/about.rst b/docs/about.rst
index 515f83e9cce7cc226164c1176279c90302c59833..ffbf0ee8afab7cbe114d64aa32665013a1d03a1d 100644
--- a/docs/about.rst
+++ b/docs/about.rst
@@ -18,8 +18,9 @@ At the moment, the roles have been written for and tested against **Ansible
 2.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?
diff --git a/docs/index.rst b/docs/index.rst
index f0d299c57e70a610661fb44203375853d00b5c2d..0d936768089bf415b0e629b18b5d4bc8fb2450bc 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,8 +18,9 @@ At the moment, the roles have been written for and tested against **Ansible
 2.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
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
index 36c71a5bff9f7978b074f23389522dbdbfeb84bd..8d5d0ab00c20b24d1983cd971149529d1645414e 100644
--- a/docs/releasenotes.rst
+++ b/docs/releasenotes.rst
@@ -10,6 +10,7 @@ x.y.z
 * All roles
 
   * Dropped support for Debian 11 (Bullseye).
+  * ``passlib`` Python package is now required for using the roles.
 
 **New features/improvements**
 
diff --git a/docs/usage.rst b/docs/usage.rst
index bf0806d72f906ad90a5f8f1e8e6fc150b42b33e9..80294233d797c81de50f575d2b81ec5dcf689f89 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -135,11 +135,13 @@ packages, and to prepare the environment a bit on the Ansible server:
      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*
diff --git a/requirements.in b/requirements.in
index 55881d393d216e533accde3ea4fc53352bef6c8f..d65319405eb2847fa57fdca0e7502bef1c50fe3f 100644
--- a/requirements.in
+++ b/requirements.in
@@ -1,6 +1,7 @@
 # Ansible and role runtime.
 ansible~=10.3
 netaddr
+passlib
 python-ldap
 
 # Development and testing.