The only dependencies for running the project are Docker and Docker Compose. It was tested with the following versions:
Docker Desktop: 4.29.0 (145265)
Docker Engine: 26.0.0
Docker Compose: v2.26.1-desktop.1
Lower versions should work too.
To start the system with minimum configuration, run the following command:
docker compose --build -d
This command will pull and build all the necessary images required for the system.
By default, the system is not started with telemetry. To run it with telemetry, use the following command:
docker compose -f ./docker-compose.yml -f ./docker-compose.override.telemetry.yml up --build -d
This command includes telemetry to the base definition, ensuring that any changes made to the base configuration are reflected here as well.
If you have the build-deploy-services.sh
script, use the following commands to execute the script:
chmod +x build-deploy-services.sh
./build-deploy-services.sh
This script will:
- Build Docker images for each subdirectory.
- Run
docker-compose up -d
to start the services.
If you want to start specific services, use the following commands:
-
Consul Service:
docker-compose -f consul_compose.yml up -d
-
Telemetry Service:
docker-compose -f docker-compose.override.telemetry.yml up -d
-
MySQL Database:
docker-compose -f mysql-compose.yml up -d
-
RabbitMQ Service:
docker-compose -f rabbit-compose.yml up -d
To check whether your services are running, use the following command:
docker ps
To stop the services, run:
docker-compose down