diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 692be27da5cd78a7e345b351989cb0b0c5c714ff..03e197ef3c2488b552fe9cef69655de766108db0 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -272,23 +272,21 @@ The role implements the following: upgrades on daily basis. Mails are delivered to local ``root`` account, and can be redirected elsewhere via aliases. If using ``mail_forwarder`` or ``mail_server`` roles on the same server, aliases can be set-up through them. -* Sets-up system for performing checks on pip requirements - files. Roles that want their requirements files checked should - create a sub-directory inside of - ``/etc/pip_check_requirements_upgrades`` (for Python 2 - applications), or ``/etc/pip_check_requirements_upgrades-py3`` (for - Python 3 applications), and place ``.txt`` and ``.in`` files inside - (with same base name). The ``.txt`` files should be standard - requirements files with fixed versions (the ones installed by the - role). The ``.in`` files should contain only the top-level packages - (no dependencies). Avoid hard-coding versions in the ``.in`` file - unless really needed. For packages where you want to stick to - stable/LTS version branch, you should be able to use ``~=`` operator - (for example ``django~=1.8.0``. Checks are implemented via - `pip-tools `_ and a custom - script that outputs diffs if upgrades are available. Script is run - via cronjob on daily basis, and any output will be delivered to - local ``root`` user. +* Sets-up system for performing checks on pip requirements files. Only + Python 3 is supported. Roles that want their requirements files + checked should create a sub-directory inside of + ``/etc/pip_check_requirements_upgrades``, and place ``.txt`` and + ``.in`` files inside (with same base name). The ``.txt`` files + should be standard requirements files with fixed versions (the ones + installed by the role). The ``.in`` files should contain only the + top-level packages (no dependencies). Avoid hard-coding versions in + the ``.in`` file unless really needed. For packages where you want + to stick to stable/LTS version branch, you should be able to use + ``~=`` operator (for example ``django~=1.8.0``. Checks are + implemented via `pip-tools `_ + and a custom script that outputs diffs if upgrades are + available. Script is run via cronjob on daily basis, and any output + will be delivered to local ``root`` user. * Optionally configures time synchronisation using NTP (if ``ntp_servers`` parameter is set). @@ -417,32 +415,16 @@ Parameters - "3.debian.pool.ntp.org" **pip_check_requirements_in** (list, optional, ``[pip, pip-tools, setuptools, wheel]``) - List of Python package requirements inputs to use for checking for - package upgrades for the Python 2 virtual environment used to run - the check itself. For Python 3, see the dedicated parameter - ``pip_check_requirements_py3`` below. - -**pip_check_requirements** (list, optional, ``[click==7.1.2, pip-tools==5.5.0, pip==20.3.4, setuptools==44.1.1, wheel==0.37.1]``) - List of Python package requirements to install in Python 2 virtual - environment in order to be able to run the ``pip-tools`` - applications as part of pip requirements upgrade checks. This list - needs to be updated from time to time as the new releases of - ``pip-tools`` and related packages are coming out. For Python 3, see - the dedicated parameter ``pip_check_requirements_py3`` below. - -**pip_check_requirements_py3_in** (list, optional, ``[pip, pip-tools, setuptools, wheel]``) List of Python package requirements inputs to use for checking for package upgrades for the Python 3 virtual environment used to run - the check itself. For Python 2, see the dedicated parameter - ``pip_check_requirements`` above. + the check itself. -**pip_check_requirements_py3** (list, optional, ``see below``) +**pip_check_requirements** (list, optional, ``see below``) List of Python package requirements to install in Python 3 virtual environment in order to be able to run the ``pip-tools`` applications as part of pip requirements upgrade checks. This list needs to be updated from time to time as the new releases of - ``pip-tools`` and related packages are coming out. For Python 2, see - the dedicated parameter ``pip_check_requirements`` above. + ``pip-tools`` and related packages are coming out. Default value is: