Changeset - bb3c9551c694
[Not reviewed]
0 1 0
Branko Majic (branko) - 5 years ago 2021-01-17 19:48:54
branko@majic.rs
MAR-151: Minor fix for wsgi_website role reference documentation:

- List paths for both Python 2 and Python 3 pip requirements upgrade
check directories.
1 file changed with 9 insertions and 6 deletions:
0 comments (0 inline, 0 general)
docs/rolereference.rst
Show inline comments
 
@@ -1927,30 +1927,33 @@ Parameters
 
**wsgi_requirements** (list, optional, ``[ futures==3.3.0, gunicorn==19.10.0 ]``)
 
  Complete list of pip requirements used for deploying Gunicorn. If
 
  specified, this list will be used to create requirements file and
 
  install Gunicorn and its dependencies from that one. This allows to
 
  have pinned packages for both Gunicorn, futures, and their
 
  dependencies. The ``futures`` package is required by Gunicorn when
 
  using Python 2.7.
 

	
 
  It should be noted that this installation method is meant primarily in case of
 
  roles that want to take advantage of upgrade checks for pip requirements
 
  files, and that employ `pip-tools <https://github.com/jazzband/pip-tools>`_.
 

	
 
  In addition to change of installation method, when this parameter is specified
 
  the role will deploy necessary files for running the pip requirements upgrade
 
  check (see the ``common`` role for description). For this a directory is
 
  created under ``/etc/pip_check_requirements_upgrades/FQDN``. The same
 
  directory should be used by dependant roles to deploy their own ``.in`` and
 
  ``.txt`` files. Make sure the file ownership is set to ``root:pipreqcheck``.
 
  In addition to change of installation method, when this parameter is
 
  specified the role will deploy necessary files for running the pip
 
  requirements upgrade check (see the ``common`` role for
 
  description). For this a directory is created under
 
  ``/etc/pip_check_requirements_upgrades/FQDN`` for Python 2 or
 
  ``/etc/pip_check_requirements_upgrades-py3/FQDN`` for Python 3. The same
 
  directory should be used by dependant roles to deploy their own
 
  ``.in`` and ``.txt`` files. Make sure the file ownership is set to
 
  ``root:pipreqcheck``.
 

	
 
  Should you need to utilise the requirements file in some manner (other than
 
  checking for its upgrades), it will be also stored (and made accessible to
 
  application user/admin)) in application's home directory under the name
 
  ``.wsgi_requirements.txt``.
 

	
 
  To create complete requirements list, it is recommended to use `pip-tools
 
  <https://github.com/jazzband/pip-tools>`_ (the ``pip-compile`` utility) with
 
  ``gunicorn`` and ``futures`` in the ``.in.`` file.
 

	
 
**wsgi_requirements_in** (list, optional, ``[ futures, gunicorn ]``)
 
  List of top level packages to use when performing the pip
0 comments (0 inline, 0 general)