Merge pull request RasaHQ#5566 from RasaHQ/1.9.x

merge 1.9.x into master

Author: ricwo

CHANGELOG.rst

@@ -17,6 +17,35 @@ This project adheres to `Semantic Versioning`_ starting with version 1.0.
 
 .. towncrier release notes start
 
+[1.9.5] - 2020-04-01
+^^^^^^^^^^^^^^^^^^^^
+
+Improvements
+------------
+- `#5533 <https://github.com/rasahq/rasa/issues/5533>`_: Support for
+  `PostgreSQL schemas <https://www.postgresql.org/docs/11/ddl-schemas.html>`_ in
+  :ref:`sql-tracker-store`. The ``SQLTrackerStore``
+  accesses schemas defined by the ``POSTGRESQL_SCHEMA`` environment variable if
+  connected to a PostgreSQL database.
+
+  The schema is added to the connection string option's ``-csearch_path`` key, e.g.
+  ``-options=-csearch_path=<SCHEMA_NAME>`` (see
+  `<https://www.postgresql.org/docs/11/contrib-dblink-connect.html>`_ for more details).
+  As before, if no ``POSTGRESQL_SCHEMA`` is defined, Rasa uses the database's default
+  schema (``public``).
+
+  The schema has to exist in the database before connecting, i.e. it needs to have been
+  created with
+
+  .. code-block:: postgresql
+
+    CREATE SCHEMA schema_name;
+
+Bugfixes
+--------
+- `#5547 <https://github.com/rasahq/rasa/issues/5547>`_: Fixed ambiguous logging in ``DIETClassifier`` by adding the name of the calling class to the log message.
+
+
 [1.9.4] - 2020-03-30
 ^^^^^^^^^^^^^^^^^^^^
 

docs/user-guide/docker/deploying-in-docker-compose.rst

@@ -48,6 +48,8 @@ REST channel, uncomment this section in the ``credentials.yml``:
 The REST channel will open your bot up to incoming requests at the ``/webhooks/rest/webhook`` endpoint.
 
 
+.. _running-multiple-services:
+
 Using Docker Compose to Run Multiple Services
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -101,7 +103,7 @@ an action server image, see :ref:`building-an-action-server-image`.
           command:
             - run
         app:
-          image: <your action server image>
+          image: <image:tag>
           expose: 5055
 
 The ``expose: 5005`` is what allows the ``rasa`` service to reach the ``app`` service on that port.
@@ -127,106 +129,6 @@ corresponds to a :ref:`configured channel <docker-compose-configuring-channels>`
        -H "Content-type: application/json" \
        -d '{"sender": "test", "message": "hello"}'
 
-.. _building-an-action-server-image:
-
-Building an Action Server Image
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you build an image that includes your action code and store it in a container registry, you can run it locally
-or as part of your deployment, without having to move code between servers.
-In addition, you can add any additional dependencies of systems or Python libraries
-that are part of your action code but not included in the base ``rasa/rasa-sdk`` image.
-
-This documentation assumes you are pushing your images to `DockerHub <https://hub.docker.com/>`_.
-DockerHub will let you host multiple public repositories and
-one private repository for free. Be sure to first `create an account <https://hub.docker.com/signup/>`_
-and `create a repository <https://hub.docker.com/signup/>`_ to store your images. You could also push images to
-a different Docker registry, such as `Google Container Registry <https://cloud.google.com/container-registry>`_,
-`Amazon Elastic Container Registry <https://aws.amazon.com/ecr/>`_, or
-`Azure Container Registry <https://azure.microsoft.com/en-us/services/container-registry/>`_.
-
-To create your image:
-
-  #. Move your actions code to a folder ``actions`` in your project directory.
-     Make sure to also add an empty ``actions/__init__.py`` file:
-
-      .. code-block:: bash
-
-          mkdir actions
-          mv actions.py actions/actions.py
-          touch actions/__init__.py  # the init file indicates actions.py is a python module
-          
-     The ``rasa/rasa-sdk`` image will automatically look for the actions in ``actions/actions.py``.
-
-  #. If your actions have any extra dependencies, create a list of them in a file,
-     ``actions/requirements-actions.txt``.
-  #. Create a file named ``Dockerfile`` in your project directory,
-     in which you'll extend the official SDK image, copy over your code, and add any custom dependencies (if necessary).
-     For example:
-
-      .. parsed-literal::
-
-         # Extend the official Rasa SDK image
-         FROM rasa/rasa-sdk:\ |version|.0
-
-         # Use subdirectory as working directory
-         WORKDIR /app
-
-         # Copy any additional custom requirements
-         COPY actions/requirements-actions.txt ./
-
-         # Change back to root user to install dependencies
-         USER root
-
-         # Install extra requirements for actions code, if necessary (otherwise comment this out)
-         RUN pip install -r requirements-actions.txt
-
-         # Copy actions folder to working directory
-         COPY ./actions /app/actions
-
-         # By best practices, don't run the code with root user
-         USER 1001
-
-You can then build the image via the following command:
-
-      .. code-block:: bash
-
-        docker build . -t <account_username>/<repository_name>:<custom_image_tag>
-
-The ``<custom_image_tag>`` should reference how this image will be different from others. For
-example, you could version or date your tags, as well as create different tags that have different code for production
-and development servers. You should create a new tag any time you update your code and want to re-deploy it.
-
-If you are using Docker Compose locally, you can use this image directly in your
-``docker-compose.yml``:
-
-      .. code-block:: yaml
-
-         version: '3.0'
-         services:
-           app:
-             image: <account_username>/<repository_name>:<custom_image_tag>
-
-If you're building this image to make it available from another server,
-for example a Rasa X or Rasa Enterprise deployment, you should push the image to a cloud repository.
-You can push the image to DockerHub via:
-
-      .. code-block:: bash
-
-        docker login --username <account_username> --password <account_password>
-        docker push <account_username>/<repository_name>:<custom_image_tag>
-
-To authenticate and push images to a different container registry, please refer to the documentation of
-your chosen container registry.
-
-Then, reference the new image tag in your ``docker-compose.override.yml``:
-
-      .. code-block:: yaml
-
-         version: '3.0'
-         services:
-           app:
-             image: <account_username>/<repository_name>:<custom_image_tag>
 
 Configuring a Tracker Store
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/user-guide/how-to-deploy.rst

@@ -90,3 +90,103 @@ Rasa Assistant locally or in Docker. Then you can deploy your model in Docker Co
    Building a Rasa Assistant Locally <rasa-tutorial>
    docker/building-in-docker
    docker/deploying-in-docker-compose
+
+
+Deploying Your Action Server
+----------------------------
+
+.. _building-an-action-server-image:
+
+Building an Action Server Image
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you build an image that includes your action code and store it in a container registry, you can run it
+as part of your deployment, without having to move code between servers.
+In addition, you can add any additional dependencies of systems or Python libraries
+that are part of your action code but not included in the base ``rasa/rasa-sdk`` image.
+
+To create your image:
+
+  #. Move your actions code to a folder ``actions`` in your project directory.
+     Make sure to also add an empty ``actions/__init__.py`` file:
+
+      .. code-block:: bash
+
+          mkdir actions
+          mv actions.py actions/actions.py
+          touch actions/__init__.py  # the init file indicates actions.py is a python module
+
+     The ``rasa/rasa-sdk`` image will automatically look for the actions in ``actions/actions.py``.
+
+  #. If your actions have any extra dependencies, create a list of them in a file,
+     ``actions/requirements-actions.txt``.
+
+  #. Create a file named ``Dockerfile`` in your project directory,
+     in which you'll extend the official SDK image, copy over your code, and add any custom dependencies (if necessary).
+     For example:
+
+      .. parsed-literal::
+
+         # Extend the official Rasa SDK image
+         FROM rasa/rasa-sdk:\ |version|.0
+
+         # Use subdirectory as working directory
+         WORKDIR /app
+
+         # Copy any additional custom requirements, if necessary (uncomment next line)
+         # COPY actions/requirements-actions.txt ./
+
+         # Change back to root user to install dependencies
+         USER root
+
+         # Install extra requirements for actions code, if necessary (uncomment next line)
+         # RUN pip install -r requirements-actions.txt
+
+         # Copy actions folder to working directory
+         COPY ./actions /app/actions
+
+         # By best practices, don't run the code with root user
+         USER 1001
+
+You can then build the image via the following command:
+
+      .. code-block:: bash
+
+        docker build . -t <account_username>/<repository_name>:<custom_image_tag>
+
+The ``<custom_image_tag>`` should reference how this image will be different from others. For
+example, you could version or date your tags, as well as create different tags that have different code for production
+and development servers. You should create a new tag any time you update your code and want to re-deploy it.
+
+
+Using your Custom Action Server Image
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you're building this image to make it available from another server,
+for example a Rasa X or Rasa Enterprise deployment, you should push the image to a cloud repository.
+
+This documentation assumes you are pushing your images to `DockerHub <https://hub.docker.com/>`_.
+DockerHub will let you host multiple public repositories and
+one private repository for free. Be sure to first `create an account <https://hub.docker.com/signup/>`_
+and `create a repository <https://hub.docker.com/signup/>`_ to store your images. You could also push images to
+a different Docker registry, such as `Google Container Registry <https://cloud.google.com/container-registry>`_,
+`Amazon Elastic Container Registry <https://aws.amazon.com/ecr/>`_, or
+`Azure Container Registry <https://azure.microsoft.com/en-us/services/container-registry/>`_.
+
+You can push the image to DockerHub via:
+
+      .. code-block:: bash
+
+        docker login --username <account_username> --password <account_password>
+        docker push <account_username>/<repository_name>:<custom_image_tag>
+
+To authenticate and push images to a different container registry, please refer to the documentation of
+your chosen container registry.
+
+How you reference the custom action image will depend on your deployment. Pick the relevant documentation for
+your deployment:
+
+    - `One-Line Deployment <https://rasa.com/docs/rasa-x/installation-and-setup/one-line-deploy-script/#customizing-the-script>`_
+    - `Kubernetes or Openshift <https://rasa.com/docs/rasa-x/installation-and-setup/openshift-kubernetes/#adding-a-custom-action-server>`_
+    - `Docker Compose <https://rasa.com/docs/rasa-x/installation-and-setup/docker-compose-script/#connect-a-custom-action-server>`_
+    - :ref:`Rasa Open Source Only <running-multiple-services>`

pyproject.toml

@@ -9,7 +9,7 @@ exclude = "((.eggs | .git | .pytype | .pytest_cache | build | dist))"
 
 [tool.poetry]
 name = "rasa"
-version = "1.9.4"
+version = "1.9.5"
 description = "Open source machine learning framework to automate text- and voice-based conversations: NLU, dialogue management, connect to Slack, Facebook, and more - Create chatbots and voice assistants"
 authors = [ "Rasa Technologies GmbH <[email protected]>",]
 maintainers = [ "Tom Bocklisch <[email protected]>",]

rasa/core/constants.py

@@ -65,3 +65,11 @@
 
 # RabbitMQ message property header added to events published using `rasa export`
 RASA_EXPORT_PROCESS_ID_HEADER_NAME = "rasa-export-process-id"
+
+# Name of the environment variable defining the PostgreSQL schema to access. See
+# https://www.postgresql.org/docs/9.1/ddl-schemas.html for more details.
+POSTGRESQL_SCHEMA = "POSTGRESQL_SCHEMA"
+
+# Names of the environment variables defining PostgreSQL pool size and max overflow
+POSTGRESQL_POOL_SIZE = "SQL_POOL_SIZE"
+POSTGRESQL_MAX_OVERFLOW = "SQL_MAX_OVERFLOW"