From eef53ea2b60ed310af75135d40b224fa46203dd4 Mon Sep 17 00:00:00 2001 From: Fred Boniface Date: Sat, 23 Mar 2024 11:26:24 +0000 Subject: [PATCH] Update readme --- README.md | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c615f65..73d3ed8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,31 @@ -# mq-client +# timetable-mgr -Client for these message queue feeds: - - - VSTP Schedule data \ No newline at end of file +timetable-mgr is the new name for mq-client. + +It has been extended to manage all timetable management aspects within OwlBoard: + - Periodic fetch of CORPUS Location Data + - Daily fetch of Network Rail timetable files + - Subscribe to VSTP Messages from the MQ Feed + - Update the database with new timetable data + - Clean old services from the database + +The configuration options have also been changed to support simple files, this allows support for Docker Secrets as well as the mounting of secrets within a Kubernetes cluster in addition to the existing method of configuring via environment variables. + +## Configuration + +The application requires the following configuration values to be set. + +The preferred method of configuration in Kubernetes is mapping secrets to environment variables, and in Docker is to mount the secrets to a file - one value per file. This is the simplest method and provides an acceptable level of security - provided you have configured secret management within Kubernetes. + +Docker Swarm has secret support built-in, for Docker Standalone/Podman you will need to manage secrets yourself. + +See the table below for the environment variable name, the configuration file path. Some values have defaults which will be used if the variable is not set and the file path does not exist. In cases where the file path exists and the environment variable also exists, the environment variable will be used. All values without a default are required,timetable-mgr will exit if it cannot load a value. + +| Variable Name | File Path | Default Value | +| :------------ | :------------------ | :------------ | +| OWL_NROD_USER | /owl/conf/nrod/user | | +| OWL_NROD_PASS | /owl/conf/nrod/pass | | +| OWL_DB_HOST | /owl/conf/db/host | localhost | +| OWL_DB_PORT | /owl/conf/db/port | 27017 | +| OWL_DB_USER | /owl/conf/db/user | | +| OWL_DB_PASS | /owl/conf/db/pass | | \ No newline at end of file