Service Configuration (docker compose)
- Seweryn Niedzielski
Analytics
Service Configuration in build_solution.py (docker compose)
Overview
The script supports Docker service configuration through a service.json file. This allows defining service dependencies, environment files, and Compose YAML file structures. The script generates compose.yml as output, ensuring correct Docker service configuration.
service.json Structure
The service.json file should be structured as an array of service definitions, where each entry contains:
path: The Compose YAML file path.env_file: A list of environment files required for the service.
Example service.json
[
{
"path": "compose.base.yml",
"env_file": [
".env",
".env.redis",
".env.openSearch"
]
},
{
"path": "compose.${DB_DEFAULT:-postgresql}.yml",
"env_file": [
".env.database"
]
},
{
"path": "compose.openSearch.yml",
"env_file": []
},
{
"path": "compose.cache.yml",
"env_file": [
".env",
".env.redis"
]
}
]compose.yml Output
After processing service.json, the script generates compose.yml, ensuring correct formatting and indentation.
Example generated-services.yml
include:
- path: compose.base.yml
env_file:
- .env
- .env.redis
- .env.openSearch
- path: compose.${DB_DEFAULT:-postgresql}.yml
env_file:
- .env.database
- path: compose.openSearch.yml
env_file: []
- path: compose.cache.yml
env_file:
- .env
- .env.redisHow It Works
Reads
service.json– Extracts service definitions, includingpathandenv_file.Formats the data – Ensures proper indentation and list formatting for YAML output.
Generates
compose.yml– Writes the structured YAML file for Docker Compose.
Running the Script
Ensure service.json is present, then execute:
python build_solution.pyThis will generate generated-services.yml in the same directory.
Did you encounter a problem or do you have a suggestion?
Please contact our Service Desk
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. https://creativecommons.org/licenses/by-sa/4.0/