Version imprimable multipages. Cliquer ici pour imprimer.

Docker Compose

Utiliser docker compose pour un déploiement sur un seul nœud

Le projet OSRD inclut un fichier docker-compose.yml conçu pour faciliter le déploiement d’un environnement OSRD pleinement fonctionnel. Exclusivement destiné à des fins de développement, cette configuration Docker Compose pourrait être adaptée pour des déploiements rapides sur un seul nœud.

Avertissement

Cette configuration est prévue seulement à des fins de développement. Par exemple, aucune authentification n’est prise en charge et le front-end est déployé en mode développement (reconstruit à la volée). Si vous souhaitez déployer une version d’OSRD dédiée à un environment de production, veuillez suivre le déploiement via Kubernetes

Prérequis

Avant de procéder au déploiement, assurez-vous que vous avez installé :

Docker
Docker Compose

Vue d’ensemble de la configuration

Le fichier docker-compose.yml définit les services suivants :

PostgreSQL : Une base de données PostgreSQL avec l’extension PostGIS.
Valkey : Un serveur Valkey pour le cache.
Core : Le service central OSRD.
Front : Le service front-end pour OSRD.
Editoast : Un service OSRD responsable de diverses fonctions d’édition.
Gateway : Sert de passerelle pour les services OSRD.
Wait-Healthy : Un service utilitaire pour s’assurer que tous les services sont sains avant de procéder.

Chaque service est configuré avec des contrôles de santé, des montages de volumes et les variables d’environnement nécessaires.

Étapes du déploiement

Cloner le dépôt : Tout d’abord, clonez le dépôt OSRD sur votre machine locale.
Configuration : La configuration par défaut nécessite le renseignement d’une variable d’environnement pour le service Editoast: ROOT_URL. Il faut lui donner la valeur de l’URL qui pointe vers le service Editoast par la gateway. Par exemple “http://your-domain.com/api". Vous pouvez également ajuster d’autres variables d’environnement si nécessaire.
Construire et exécuter : Naviguez vers le répertoire contenant docker-compose.yml et exécutez :

docker-compose up --build

Cette commande construit les images et démarre les services définis dans le fichier Docker Compose.

Accès aux services

Bien que tous les services HTTP soient utilisés via la passerelle (http://localhost:4000), vous pouvez accéder directement à chaque service en utilisant leurs ports exposés :

PostgreSQL : Accessible sur localhost:5432.
Valkey : Accessible sur localhost:6379.
Service Core : Accessible sur localhost:8080.
Front-End : Accessible sur localhost:3000.
Editoast : Accessible sur localhost:8090.

Notes et considérations

Cette configuration est conçue pour le développement et les déploiements rapides. Pour les environnements de production, des considérations supplémentaires en matière de sécurité, de scalabilité et de fiabilité doivent être abordées.
Assurez-vous que le POSTGRES_PASSWORD et d’autres identifiants sensibles sont gérés en toute sécurité, en particulier dans les déploiements de production.