OwlBoard/timetable-mgr
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
Formerly mq-client. Manages the timetable data in the database, fetching, updating and purging old services. https://owlboard.info
56 Commits 2 Branches 1 Tag 8.3 MiB
Go 99%
Dockerfile 1%
2f5868e743
Go to file
Fred Boniface 2f5868e743 Implement shared logic between CORPUS and CIF packages. 
Begin implementation of shared logic between CIF and VSTP packages.
2024-03-29 13:45:58 +00:00
src Implement shared logic between CORPUS and CIF packages. 2024-03-29 13:45:58 +00:00
.dockerignore Tidy temporary message log format 2023-07-19 14:22:29 +01:00
.gitignore Tidy temporary message log format 2023-07-19 14:22:29 +01:00
Dockerfile Complete and test Dockerfile 2023-07-25 12:49:06 +01:00
LICENSE Initial commit 2023-07-15 20:15:33 +01:00
README.md Update Markdown format 2024-03-23 11:58:20 +00:00

README.md

timetable-mgr

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 Description
OWL_VSTP_ON /owl/conf/vstp/on on Enable/Disable VSTP Updates 1
OWL_NROD_USER /owl/conf/nrod/user Network Rail NROD Username
OWL_NROD_PASS /owl/conf/nrod/pass Network Rail NROD Password
OWL_DB_HOST /owl/conf/db/host localhost MongoDB Host
OWL_DB_PORT /owl/conf/db/port 27017 MongoDB Port
OWL_DB_USER /owl/conf/db/user MongoDB Username
OWL_DB_PASS /owl/conf/db/pass MondoDB Password

1 Set to 'off' to disable VSTP Updates. Useful in testing as you cannot have two clients connected.