Requirements
The system on which you plan to install Rasa X / Enterprise must fulfill the following requirements:
Cluster Requirements
Cluster Orchestration Software
Installation on either a Kubernetes or OpenShift cluster is supported. You can get a managed cluster from a cloud provider like Google Cloud, DigitalOcean, Microsoft Azure, or Amazon EKS.
You can use Rasa Ephemeral Installer(REI) to set up a single-machine Kubernetes cluster for non-production deployments.
Resource Requirements
To install the Rasa X Helm chart, you need an existing Kubernetes cluster or OpenShift cluster.
The requirements of the single pods can vary. We recommend providing at least the following resources for the following required services:
Deployment | CPU | Memory |
---|---|---|
rasa-x | 1 | 1 GiB |
event-service | 2 | 1 GiB |
db-migration-service | 1 | 500 MiB |
The following services can either be disabled or can run as external services, not managed by the Rasa X Helm chart. For those which you choose to deploy using the Rasa X Helm chart, we recommend the following resources:
Deployment | CPU | Memory |
---|---|---|
nginx | 0.2 | 200 MiB |
app | 0.5 | 200 MiB |
duckling | 0.5 | 200 MiB |
postgresql | 1 | 250 MiB |
rabbit | 0.2 | 250 MiB |
redis | 0.2 | 250 MiB |
Deploying Rasa Open Source servers as part of the Rasa X Helm chart will be deprecated in the future.
If you are currently using this functionality, note that resource requirements for the rasa-production
and rasa-worker
deployments is highly dependent on the amount of training data, settings of the training config,
and the resulting size of the model being served. The resources below are suggestions to start out with only:
Deployment | CPU | Memory |
---|---|---|
rasa-production | 2 | 2 GiB |
rasa-worker | 4 | 4 GiB |
We recommend a size of 10 GiB for the Rasa X volume claim and 30 GiB for the database volume claim.
Database requirements
Supported Databases
The following databases are supported. Please note these requirements are only for the Rasa X / Enterprise database, see the Rasa Open Source docs for tracker store database options.
PostgreSQL 12.8 or newer
PostgreSQL comes bundled with an installation of Rasa X. As a replacement for the bundled database, you can also use an external PostgreSQL database (e.g. a Google Cloud managed instance, or AWS RDS).
For Rasa X < 1.0.0 installations PostgreSQL 11.7 was used as default version. In the migration guide, you can learn how to migrate from PostgreSQL 11 to 12.8.
Oracle 19
- A database connection with Oracle has to be initialised with UTF-8 encoding, e.g.
DB_URL=oracle+cx_oracle://${DB_USERNAME}:${DB_PASSWORD}@localhost:${DB_PORT}/${DB_NAME}?encoding=utf8
- A database connection with Oracle has to be initialised with UTF-8 encoding, e.g.
caution
Support for Oracle will be dropped in the future.
Database Permissions
Databases used by Rasa X / Enterprise or related services should be exclusive to these services. Do not make direct changes to the database, schemas, roles, or other objects except when following instructions in the documentation.
- By default, Rasa X / Enterprise uses the
public
schema. This can be changed by setting thePOSTGRESQL_SCHEMA
environment variable. - The database role used by Rasa X / Enterprise should be the owner of the target
schema, or it should have at least the
CREATE
privilege on the target schema. - The database role used by Rasa X / Enterprise should have the
LOGIN
,PASSWORD
andINHERIT
attributes. - Rasa X / Enterprise requires read access to tables in the system
catalog schema (
pg_catalog
). In most cases this won't need to be explicitly configured.
Supported Event Brokers
The following event brokers are supported:
- Kafka 2.6 or newer
- RabbitMQ 3.8.3 or newer
Subchart Version Requirements
The Rasa X Helm chart by default make use of three Bitnami subcharts, which pull the images in the table below. These are the versions of the subcharts and images we test against:
Subchart | Chart Version | Image | Image Version |
---|---|---|---|
redis | 10.5.14 | bitnami/redis | 5.0.8 |
rabbit | 6.19.2 | bitnami/rabbitmq | 3.8.3 |
postgresql | 8.6.13 | bitnami/postgresql | 11.7.0 |
If you choose to override the subchart defaults, or use external instances of them, you should verify in the relevant changelogs whether the versions you are using take different values than the ones listed below or on the Helm chart repo.
Supported Browsers
The Rasa X / Rasa Enterprise web interface aims to support browsers that meet the following criteria:
- 0.2% market share
- not Internet Explorer
- not Opera Mini