Installation avec Docker
Voici les différentes façon d'installer le projet RASA dans Docker. Vous devez avoir au préalable installé Docker. Pour l'installation Docker, voir Logiciel - Docker - Installation.
Installation de Rasa X avec Docker Compose
Le Rasa X est destiné à être déployé sur un serveur et non sur une machine personnelle/locale. Le déploiement sur un serveur est recommandé car Rasa X est conçu pour rester opérationnel en permanence et ne pas être fréquemment arrêté ou redémarré.
Exigences matérielles et système d'exploitation
Voici les spécifications matérielles minimales et recommandées et la configuration système requise :
| Spécification | Description |
|---|---|
| Système d'exploitation | Linux (Ubuntu 16.04, Ubuntu 18.04, Ubuntu 19.10, Debian 9, Debian 10, CentOS 7, CentOS 8, RHEL 8,...), Windows (Windows 10, Windows Server 2019,...) |
| Microprocesseur | Minimum du 2 coeurs de microprocesseur. Il est recommandé d'avoir entre 2 et 6 coeurs. |
| Mémoire vive | 4 Go de RAM, recommandé 8 Go de RAM |
| Espace disque | Recommandé 100 Go d'espace de disponible |
Exigences du port réseau
Lors de la création du serveur, assurez-vous que les ports réseaux suivants sont ouverts (par exemple sous AWS avec le Security Group) :
| Port | Service | Description |
|---|---|---|
| 22 | SSH | Accès en SSH. |
| 80 | HTTP | Accès d'application Web. |
| 443 | HTTPS | Accès d'application Web par HTTPS sécurisé (optionnel) |
Installation de Docker Compose sous Linux
Sous les distributions Linux, télécharger le script d'installation :
| curl -sSL -o install.sh https://storage.googleapis.com/rasa-x-releases/0.34.0/install.sh |
Pour installer tous les fichiers dans le dossier par défaut, /etc/rasa, exécutez la commande suivante :
| sudo bash ./install.sh |
Vous serez invité à accepter les termes et conditions de licence. Lisez les conditions, puis appuyez sur la touche Enter pour continuer.
Pour choisir votre propre dossier d'installation au lieu de /etc/rasa, définissez la variable d'environnement RASA_HOME de la manière suivante :
|
export RASA_HOME=~/rasa/dir sudo -E bash ./install.sh # -E conservera la variable d'environnement que vous avez définie |
Si vous chez le répertoire par défaut, vous devez remplacer /etc/rasa par ${RASA_HOME} dans d'autres commandes.
Ensuite, démarrez Rasa X et attendez que tous les conteneurs soient en cours d'exécution (le paramètre -d exécutera Rasa X en arrière-plan) :
|
cd /etc/rasa sudo docker-compose up -d |
Définissez votre mot de passe administrateur :
|
cd /etc/rasa sudo python rasa_x_commands.py create --update admin me PASSWORD |
Finalement, accédé au nom d'hôte ou à l'adresse IP où votre serveur est accessible et connectez-vous à l'aide de votre nouveau mot de passe.
Installation de Docker Compose sous Windows
Assurez-vous que python, docker et docker-compose sont installés sur votre système d'exploitation Windows. Vous devriez pouvoir exécuter la ou les commandes suivantes :
|
python --version docker -v docker-compose -v |
Assurez-vous que vous pouvez exécuter des conteneurs Linux avec la commande suivante :
| docker run hello-world:linux |
Notez que votre version de Python doit être supérieure à 3.6 pour utiliser Rasa et Rasa X.
D'abord, définisé le numéro du répertoire du projet et créer le répertoire du projet avec les commandes PowerShell suivantes :
|
New-Item C:\etc\rasa -ItemType Directory Set-Location -Path C:\etc\rasa |
Télécharger les fichiers docker-compose et commandes de Rasa X :
|
Invoke-WebRequest -OutFile docker-compose.yml -Uri https://storage.googleapis.com/rasa-x-releases/0.34.0/docker-compose.ce.yml Invoke-WebRequest -OutFile rasa_x_commands.py -Uri https://storage.googleapis.com/rasa-x-releases/0.34.0/rasa_x_commands.py |
Créez le fichier d'environnement docker .env dans le répertoire de votre projet (soit dans C:\etc\rasa dans notre exemple) avec le contenu suivant (en choisissant un RASA_VERSION compatible avec votre RASA_X_VERSION :
|
RASA_X_VERSION=rasa_x_version RASA_VERSION=rasa_version RASA_TOKEN=random_string RASA_X_TOKEN=random_string PASSWORD_SALT=random_string JWT_SECRET=random_string RABBITMQ_PASSWORD=random_string DB_PASSWORD=random_string REDIS_PASSWORD=random_string RASA_TELEMETRY_ENABLED=false |
Utiliser le tableau suivant pour trouver les versions compatibles :
| Rasa X | Rasa Open Source | Rasa SDK |
|---|---|---|
| 0.35.x | 2.2.x | 2.2.x |
| 0.35.0 | 2.2.4 | 2.2.0 |
| 0.34.0 | 2.1.2 | 2.1.2 |
| 0.33.0 | 2.0.2 | 2.0.2 |
| 0.32.2 | 1.10.14 | 1.10.2 |
| 0.31.5 | 1.10.10 | 1.10.2 |
| 0.30.1 | 1.10.8 | 1.10.2 |
| 0.29.3 | 1.10.7 | 1.10.2 |
| 0.28.6 | 1.10.2 | 1.10.1 |
| 0.27.8 | 1.9.7 | 1.9.0 |
| 0.26.4 | 1.8.3 | 1.8.1 |
| 0.25.3 | 1.7.4 | 1.7.0 |
| 0.24.8 | 1.6.2 | 1.6.1 |
| 0.23.6 | 1.5.3 | 1.5.2 |
| 0.22.2 | 1.4.6 | 1.4.0 |
| 0.21.5 | 1.3.10 | 1.3.3 |
| 0.20.5 | 1.2.9 | 1.2.0 |
| ... | ... | ... |
Pour random_string, veuillez utiliser une séquence de caractères sécurisée distincte, générée aléatoirement pour chaque variable. Un moyen pratique de générer des chaînes de caractères aléatoires consiste à utiliser openssl :
| openssl rand -base64 16 |
Le PASSWORD_SALT est utilisé pour hacher les mots de passe. Si vous modifiez cette variable après l'avoir définie, vous devrez créer de nouvelles connexions pour chacun de vos utilisateurs.
Créez un fichier d'informations d'identification credentials.yml dans le répertoire de votre projet contenant :
|
rasa: url: ${RASA_X_HOST}/api |
Ce sont les informations d'identification utilisées pour la messagerie avec le bot via l'interface utilisateur de Rasa X. Vous pouvez également ajouter des informations d'identification pour d'autres canaux de messagerie et vocaux tels que votre connecteur personnalisé ou le canal d'entrée REST.
Créez un fichier endpoints.yml dans le répertoire de votre projet contenant :
|
models: url: ${RASA_MODEL_SERVER} token: ${RASA_X_TOKEN} wait_time_between_pulls: ${RASA_MODEL_PULL_INTERVAL} tracker_store: type: sql dialect: "postgresql" url: ${DB_HOST} port: ${DB_PORT} username: ${DB_USER} password: ${DB_PASSWORD} db: ${DB_DATABASE} login_db: ${DB_LOGIN_DB} lock_store: type: "redis" url: ${REDIS_HOST} port: ${REDIS_PORT} password: ${REDIS_PASSWORD} db: ${REDIS_DB} event_broker: type: "pika" url: ${RABBITMQ_HOST} username: ${RABBITMQ_USERNAME} password: ${RABBITMQ_PASSWORD} queues: - ${RABBITMQ_QUEUE} action_endpoint: url: ${RASA_USER_APP}/webhook token: "" |
Créez un fichier d'environnements sur environments.yml dans le répertoire de votre projet contenant :
|
rasa: production: url: http://rasa-production:5005 token: ${RASA_TOKEN} worker: url: http://rasa-worker:5005 token: ${RASA_TOKEN} |
Créez quelques dossiers vides que nous monterons dans les conteneurs :
|
New-Item -ItemType Directory C:\etc\rasa\auth New-Item -ItemType Directory C:\etc\rasa\certs New-Item -ItemType Directory C:\etc\rasa\credentials New-Item -ItemType Directory C:\etc\rasa\models New-Item -ItemType Directory C:\etc\rasa\logs New-Item -ItemType Directory C:\etc\rasa\terms |
Sous Windows, vous ne créez pas de répertoire local pour la persistance de la base de données Postgres. Au lieu de cela, vous définirez un volume docker dans un fichier docker-compose.override.yml.
Lisez les termes Rasa X. Pour accepter les conditions, créez un fichier d'accord dans le dossier des conditions :
| New-Item -ItemType file C:\etc\rasa\terms\agree.txt |
Sous Windows, un docker volume est utilisé pour l'entreposage persistant de la base de données Postgres. Pour éviter que vos modifications dans le fichier docker-compose soient écrasées lors de la prochaine mise à jour, vous ne devez pas appliquer vos modifications à docker-compose.yml. À la place, créez un nouveau fichier appelé docker-compose.override.yml et appliquez-y vos modifications. Le Docker prendra automatiquement ce fichier en compte et remplacera tous les attributs de docker-compose.yml avec les modifications du fichier de remplacement. Le contenu de docker-compose.override.yml dans le répertoire de votre projet :
|
version: "3.4" services: db: volumes: - db-volume:/bitnami/postgresql volumes: db-volume: name: db-volume |
Si vous ne souhaitez pas encore configurer d'actions personnalisées, assurez-vous d'ajouter cette variable à votre .env pour utiliser l'image app de démonstration :
| RASA_X_DEMO_VERSION=rasa_x_version |
Démarrez Rasa X et attendez que tous les conteneurs soient en cours d'exécution (-d exécutera Rasa X en arrière-plan) :
| docker-compose up -d |
Définissez votre mot de passe de l'utilisateur admin avec cette commande à partir du répertoire de votre projet :
| python rasa_x_commands.py create --update admin me PASSWORD |
Accédez au nom d'hôte ou à l'adresse IP où votre serveur est accessible et connectez-vous à l'aide de votre nouveau mot de passe.
Installation Play with Docker
Il est possible d'exécuter RASA NLU dans le Labs de Play with Docker (https://labs.play-with-docker.com/) avec la commande suivante :
| docker run -it -p 5000:5000 rasa/rasa_nlu:latest-full run bash |
Résolution de problème d'installation
Si vous avez une erreur ressemblant à ceci, c'est que vous avez mal définit le chemin d'installation de RASA, il doit probablement chercher le contenu du projet dans un dossier comme «/etc/rasa» et vous lui avez définit un chemin différent comme par exemple /user/gladir/rasa (installer le projet dans /etc/rasa à la place) :
| rasa-x_1 | WARNING:rasax.community.database.utils:Unable to get database revision heads. |
Si vous avez le message suivant, votre machine, et non pas Docker, n'a pas assez de mémoire vive (RAM), vous devez avoir minimum 4 Go de mémoire vive (RAM) et idéalement plus de 8 Go :
| MemoryError |
Si vous avez le message suivant, c'est que vous omettez d'exécuter d'abord le script d'installation :
| ERROR: Invalid interpolation format for "environment" option in service "rasa-worker": "${RASA_X_PASSWORD:-}" |
Si vous installez une version trop récente ou incompatible de Python, il affichera le message suivant :
|
ERROR: Could not find a version that satisfies the requirement tensorflow-addons<0.8.0,>=0.7.1 (from rasa) (from versions: 0.10.0, 0.11.0, 0.11.1, 0.11.2) ERROR: No matching distribution found for tensorflow-addons<0.8.0,>=0.7.1 (from rasa) |
Si votre mot de passe n'est pas reconnu par l'application dorsale (Back-End de Rasa X) c'est qu'il y assez souvent un problème de version incompatible entre les variables RASA_X_VERSION et RASA_VERSION.
Si vous avez des retours d'appel 404 lors d'appel d'API dans votre clavardage, assurez-vous que le dossier /actions soit présents dans le dossier racine de votre projet, soit généralement «/etc/rasa/actions». De plus, les fichiers «actions.py» et «__init__.py» devrait être présent dans ce dossier.