To initialize the odyssey submodule run git submodule update --init
Setup angular-client and scylla-server:
Once you've sucessfully setup Scylla and the Client, you can either run them separately, or follow the docker commands below to run them together.
The argos.sh can be used on POSIX compliant OSes to quickly get up and running without worrying about profiles. Its syntax is ./argos.sh <profile> <cmd> where profile could be router, tpu, scylla-dev, or client-dev and the cmd is the normal argument passed into docker compose, such as up -d to start the process and fork to background. Make sure to down with the same profile that you used up with!
The base docker compose (compose.yml) contains some important features to note. However, it is useless standalone. Please read the profile customization selection below before using the base compose.
- It matches the number of CPUs as the router to roughly simulate router CPU (your CPU is still faster)
- It persists the database between
downcommands via a volume calledargos_db-data. Delete it withdocker volume rm argos_db-datato start with a new database nextup. - It weighs the CPU usage of siren higher, so it is prioritized in CPU starvation scenarios.
- It limits memory according to the capacity of the router.
This project uses docker compose overrides to secify configurations. Therefore there are multiple "profiles" to choose from when running in production, and there are some profiles for development testing. Also, there are fragment files for siren and client in siren-base and angular-client respectively, as they are services only used in certain cases. These profiles are specified via the command line on top of the base compose.yml file as follows.
docker compose -f compose.yml -f <override_file_name> <your command here>
Additionally if you need to create your own options, you can create a compose.override.yml file in this directory and specify what settings should be changed, which is ignored by git. If you think the override would become useful, document it here and name it compose.<name>.yml. Here is the current list of overrides, designed so only one is used at any given time:
scylla-dev*: Testing the client and interactions of scylla (scylla prod, siren local, client pt local)client-dev*: Testing the client development using the scylla mock data mode (scylla mock, client pt local)router: For production deployment to the base gateway node (scylla prod, siren local, client pt 192.168.100.1)tpu: Production deployment to the TPU on the car (no client, no siren, scylla pt siren external)
***Note that since client settings are changed via rebuild, overrides with a * must be rebuilt via docker compose -f compose.yml -f compose.<override>.yml build client. Further, a build should be done when reverting to profiles without stars. **
Examples:
Router deploy and send to background: docker compose -f compose.yml -f compose.router.yml up -d
Using the above profiles, one can build the app. Then, with correct permissions, you can push the app then pull it elsewhere for usage. Note that you must push and pull on the same architecture, so you cannot use for example a dell laptop to build for the router! To get push permissions, create a PAT here and copy the token into this command:
sudo docker login ghcr.io -u <gh username> -p <token>
Now you can update the image on a remote server. Note to save time you can just specify which service to upload, like scylla-server or client.
sudo docker compose -f compose.yml -f compose.router.yml build && sudo docker compose -f compose.yml -f compose.router.yml push
Server protobuf generation is automatic. See below for client protobuf generation.
brew install protobuf@3
brew link --overwrite protobuf@3
npm run build:proto
The configuration for the Mosquitto MQTT server on the router is in the siren-base folder. Note that the configuration is used in the docker compose file, but the configuration on the TPU is stored in Odysseus.