Pour instancier Road2, il est nécessaire de lui fournir un certain nombre d'informations. Pour cela, il y a différents JSON. Les fichiers que l'on va remplir vont dépendre de l'usage que l'on veut en faire. Nous allons présenter un usage complet. Ce dernier permettra de comprendre les autres usages.
Un usage complet des possibilités offertes par le projet Road2 est le suivant : on veut instancier, dès le démarrage, un administrateur et son service.
Dans ce cas là, nous aurons pour point d'entrée, le fichier administration.json.
Ce fichier va indiquer plusieurs informations et deux éléments :
- l'emplacement de la configuration des services : un service.json par services associés.
- un log4js.json pour les logs de l'administrateur
Chaque service.json va indiquer les éléments suivants :
- un log4js.json par service pour les logs,
- un cors.json par service si on souhaite spécifier une politique de CORS,
- le dossier des projections,
- les dossiers des ressources,
- les dossiers des sources.
Ce fichier indique quelques informations générales liées à l'instance d'administration. Son principal objectif est l'indication des logs et des services gérés.
On peut trouver un exemple de ce fichier et le modèle au format YAML.
Ce fichier indique quelques informations générales liées à l'instance d'un service. Son principal objectif est l'indication des logs, des sources et des ressources du serveur. Néanmoins, il permet de préciser beaucoup plus d'informations, comme les opérations ou les projections disponibles sur l'instance.
On peut trouver un exemple de ce fichier et le modèle au format YAML.
Ce fichier permet de spécifier le niveau des logs, l'emplacement des fichiers et le format de leur contenu. Il ne suit pas strictement la syntaxe des JSON employés pour configurer log4js.
Le format est celui d'un JSON qui contient deux objets mainConf et httpConf. Ces deux objets doivent être présents.
Le contenu de mainConf est un objet de configuration log4js. Le contenu de httpConf est un attribut level reprenant les niveaux proposés par log4js et un attribut format reprenant la syntaxe disponible pour log4js. Ces deux attributs doivent être présents.
On peut trouver un exemple de ce fichier au format JSON. C'est celui qui est utilisé dans les images docker.
Ce fichier permet d'indiquer la configuration que l'on veut appliquer à l'application en terme de CORS. Son contenu est lié à la configuration du module CORS de NodeJS. On peut trouver un exemple de ce fichier au format JSON. C'est celui qui est utilisé dans les images docker.
Le fichier service.json indique un dossier de projections. Ce dossier peut contenir plusieurs fichiers JSON. Ces fichiers seront lus, indépendamment de leur extension, pour obtenir les informations nécessaires permettant à PROJ4 d'effectuer des reprojections.
On peut trouver un exemple de ce fichier et le modèle au format YAML.
Dans les fichiers du type service.json, il est possible d'indiquer plusieurs dossiers sources. Chaque dossier sera lu et les fichiers *.source seront analysés par Road2. Chacun de ces fichiers représente une source pour Road2.
On peut trouver, dans {{ 'documentation/configuration/sources'.format(repo_url, repo_branch) }}, un exemple de ce genre de fichier pour chaque type de source disponible dans le code de Road2.
Dans les fichiers service.json, il peut également indiquer plusieurs dossiers resources. Chaque dossier sera lu et les fichiers *.resource seront analysés par Road2. Chacun de ces fichiers représente cette fois-ci une ressource pour Road2.
On peut trouver, dans ce {{ 'documentation/configuration/resources'.format(repo_url, repo_branch) }}, un exemple de ce genre de fichier pour chaque type de ressource disponible dans le code de Road2. Chaque type suit le même modèle YAML.
Afin de lire les données dans un base, il est nécessaire de fournir à Road2 un fichier qui lui donne les identifiants de connexion à la base. Cela est possible via un fichier json. Un exemple de ce fichier est fourni ici. Le contenu de ce fichier correspond aux options du module NodeJS pg.