This is documentation for Rasa X/Enterprise Documentation v1.0.x, which is no longer actively maintained.
For up-to-date documentation, see the latest version (1.2.x).
This page contains detailed instructions for installing Rasa X in a scalable cluster environment using OpenShift or Kubernetes (K8S).
Rasa X is available as a Helm Chart for a cluster setup. If you are not using Helm in your cluster, you can still use the following instructions to generate the Kubernetes or OpenShift object configurations via the Helm command-line interface, and install those configurations manually.
If you’re installing Rasa Enterprise, please follow the Rasa Enterprise instructions where given. If a step does not have separate instructions, the step applies to both Rasa X and Rasa Enterprise.
The support for the Rasa Open Source server deployment in the Rasa X Helm chart will be dropped in the future.
It's recommended to use the Rasa Helm chart to deploy Rasa Open Source, more info you can find in the docs.
1. Create Namespace
We recommend installing Rasa X in a separate namespace to avoid interfering with existing cluster deployments. To create a new namespace run the following command:
2. Create Values File
Prepare an empty file called
values.yml which will include all your custom
configuration for the installation with Helm.
3. Configure Credentials
To configure the credentials, copy the section below into the
file and replace each
<safe credential> marker with a different alphanumeric
string. Please use safe credentials to avoid data breaches.
4. Specify Rasa X and Rasa Open Source Versions
You can install the latest stable Rasa X version and the latest Rasa Open
Source version by specifying the following in your
To install the latest edge release of Rasa X instead, set the
latest tag for Rasa X:
You can also choose any compatible Rasa X and Rasa Open source versions according to the Compatibility Matrix.
5. Optional: Configure Custom Action Server
See these instructions to configure a custom action server.
If you are following the Using Helm to Generate Object Configurations guide, stop here and continue with the latter.
6. Deploy Rasa X
Run the following commands:
OpenShift only: OpenShift requires additional settings related to the security context, in the Rasa X Helm chart repository, you can find an example values file with settings for OpenShift.
Then wait until the deployment is ready. If you want to check on its status, the following command will block until the Rasa X deployment is ready:
Alternatively you can also monitor the pods directly. Note that the deployment process can involve containers restarting until everything is ready (e.g. if the database container is not ready yet).
7. Access Rasa X
By default the Rasa X deployment is exposed via the
nginx service. You can get
the IP address using this command:
You can then access the deployment on
- Rasa X
- Rasa Enterprise
Note: Depending on the used cluster / cloud provider this might not work. Please refer
to the cloud provider’s documentation / administrator what the recommended way
for exposing the
nginx service is. We are also happy to help you with any
issues in the Rasa Forum.
8. Optional: Activate Rasa Enterprise
Rasa X can be upgraded to Rasa Enterprise by uploading a valid license. To learn how to do this, please visit the Product Activation section.Go to Next Steps
This section describes how to retrieve secrets from your running deployment. You have the option to retrieve the following secrets:
|description||default secret name|
|PostgreSQL database password|
|Redis lock store and cache password|
|RabbitMQ event broker password|
Run the following command, replacing
<secret name> with one of the values in the
<your namespace> and
<your release name> with your namespace and
the name of your release:
If you’re not sure what namespace or release name your deployment runs under, you can use the following commands to find out. To list the available namespaces, run:
And to list the releases under a particular namespace namespace, run:
This section describes how to get logs from the running containers.
Get the name of the pod which you want to get the logs of.
kubectl --namespace <your namespace> \get pods# The output should be similar to this:# NAME READY STATUS RESTARTS AGE# rasa-app-58d476497-ktkqn 1/1 Running 0 45m# rasa-duckling-7696b7f474-km6dx 1/1 Running 0 45m# rasa-event-service-7657b6b489-96drn 1/1 Running 1 45m# rasa-nginx-64b6b464f6-p9bmb 1/1 Running 0 45m# rasa-postgresql-0 1/1 Running 0 45m# rasa-rabbit-0 1/1 Running 0 45m# rasa-rasa-production-c86fbf7f7-q9pp5 1/1 Running 0 45m# rasa-rasa-worker-5d49485976-6z2kj 1/1 Running 0 45m# rasa-rasa-x-5788cddbb7-5zf86 1/1 Running 0 45m# rasa-redis-master-0 1/1 Running 0 45m
rasa-rasa-x-5788cddbb7-5zf86is for example the name of the Rasa X container.
To get the logs of the container run:
kubectl --namespace <your namespace> \logs <name of the pod>
Using Helm to Generate Object Configurations
If you don’t want or cannot use Helm to install Rasa X in your cluster, you can still use Helm to generate the Kubernetes / OpenShift resource files.
Follow the installation instructions until the deployment part.
Run the following command to generate the Kubernetes / OpenShift resource files and write them in a file
helm repo add rasa-x https://rasahq.github.io/rasa-x-helmhelm repo updatehelm template \--namespace <your namespace> \--values values.yml \<your release name> \rasa-x/rasa-x > rasa-x-deployment.yml
- Using Docker
You can then deploy these manually by running:
kubectl --namespace <your namespace> \create -f rasa-x-deployment.yml
Connect a Custom Action Server if you are using custom actions.
Set up Integrated Version Control to connect your Rasa X instance to a remote Git repository.
Deploy your assistant using Rasa X.
Configure SSL if you’d like to run your Rasa X server on HTTPS.