diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst index d15411ae55ed2e89413a793ef9aa6c7196c4311a..cc0cc10f6ef9f1917d8b37ab3f6e0acfc4eeebc0 100644 --- a/docs/releasenotes.rst +++ b/docs/releasenotes.rst @@ -70,6 +70,12 @@ Breaking changes: dropped. This could introduce incompatibility with older clients trying to connect to the server. +* ``wsgi_website`` role + + * Parameters ``gunicorn_version`` and ``futures_version`` have been + deprecated and removed. Existing roles should be updated to + utilise the ``wsgi_requirements`` parameter instead. + * ``xmpp_server`` role * Use 2048-bit Diffie-Hellman parameters for relevant TLS diff --git a/docs/rolereference.rst b/docs/rolereference.rst index d2fd1ed45f2dfc0e42cac399aafecde15ec8c013..d6533036d645a4279c6886532bc37b42dd91ea7e 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1812,14 +1812,6 @@ Parameters for calculating the user/group name for dedicated website user, as well as home directory of the website user (where data/code should be stored at). -**futures_version** (string, optional, ``3.2.0``) - Version of ``futures`` package to deploy in virtual environment. Required by - Gunicorn when using Python 2.7. Default version is tested with the test site. - -**gunicorn_version** (string, optional, ``19.9.0``) - Version of Gunicorn to deploy in virtual environment for running the WSGI - application. Default version is tested with the test site. - **https_tls_certificate** (string, mandatory) X.509 certificate used for TLS for HTTPS service. The file will be stored in directory ``/etc/ssl/certs/`` under name ``{{ fqdn }}_https.pem``. @@ -1880,11 +1872,13 @@ Parameters noted that in either case the value should be specsified relative to the ``code`` sub-directory. I.e. don't use full paths. -**wsgi_requirements** (list, optional, ``[]``) - 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. +**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 @@ -1937,8 +1931,6 @@ running a bare Django project): DJANGO_SETTINGS_MODULE: "django_example_com.settings.production" https_tls_key: "{{ lookup('file', inventory_dir + '/tls/wsgi.example.com_https.key') }}" https_tls_certificate: "{{ lookup('file', inventory_dir + '/tls/wsgi.example.com_https.pem') }}" - futures_version: 3.0.5 - gunicorn_version: 19.6.0 additional_nginx_config: - comment: Use custom page for forbidden files. value: error_page 403 /static/403.html;