Skip to content

refactor(deployment): Move supporting docker-compose YAML scripts into etc/docker-compose. #1632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
junhaoliao wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor(deployment): Move supporting docker-compose YAML scripts into etc/docker-compose. #1632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f8311d
refactor(deployment): Move supporting docker-compose YAML scripts int…
junhaoliao Nov 19, 2025
9a47fe4
Merge branch 'main' into move-docker-compose
junhaoliao Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/clp-package-utils/clp_package_utils/controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,7 @@ def _get_docker_file_name(self) -> str:
"""
deployment_type = self._clp_config.get_deployment_type()
if deployment_type == DeploymentType.BASE:
return "docker-compose-base.yaml"
return "etc/docker-compose/docker-compose-base.yaml"
return "docker-compose.yaml"


Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/admin-tools/archive-manager.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/../.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.archive_manager \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/admin-tools/dataset-manager.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/../.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.dataset_manager \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/compress-from-s3.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.compress_from_s3 \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/compress.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.compress \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/decompress.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.decompress \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/search.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.search \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/start-clp.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.start_clp \
Expand Down
2 changes: 1 addition & 1 deletion components/package-template/src/sbin/stop-clp.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ common_env_path="$script_dir/.common-env.sh"
# shellcheck source=.common-env.sh
source "$common_env_path"

docker compose -f "$CLP_HOME/docker-compose.runtime.yaml" \
docker compose -f "$CLP_HOME/etc/docker-compose/docker-compose.runtime.yaml" \
run --rm "${CLP_COMPOSE_RUN_EXTRA_FLAGS[@]}" clp-runtime \
python3 \
-m clp_package_utils.scripts.stop_clp \
Expand Down
32 changes: 16 additions & 16 deletions tools/deployment/package/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,80 +1,80 @@
name: "clp-package"

include:
- "docker-compose.utils.yaml"
- "etc/docker-compose/docker-compose.utils.yaml"

services:
database:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "database"

db-table-creator:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "db-table-creator"

queue:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "queue"

redis:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "redis"

results-cache:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "results-cache"

results-cache-indices-creator:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "results-cache-indices-creator"

compression-scheduler:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "compression-scheduler"

compression-worker:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "compression-worker"

webui:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "webui"

garbage-collector:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "garbage-collector"

query-scheduler:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "query-scheduler"

query-worker:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "query-worker"

reducer:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "reducer"

mcp-server:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "mcp-server"

api-server:
extends:
file: "docker-compose-all.yaml"
file: "etc/docker-compose/docker-compose-all.yaml"
service: "api-server"
30 changes: 15 additions & 15 deletions ...eployment/package/docker-compose-all.yaml → ...tc/docker-compose/docker-compose-all.yaml
View file
Open in desktop
Copy link
Member Author

@junhaoliao junhaoliao Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as @sitaowang1998 pointed out previously, the paths are now relative to $CLP_HOME/etc/docker-compose/ rather than simply $CLP_HOME. If desired, we can keep docker-compose-all.yaml at $CLP_HOME/ to avoid the relative path changes.

Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ x-healthcheck-defaults: &healthcheck_defaults
x-volume-definitions:
clp-config-readonly: &volume_clp_config_readonly
type: "bind"
source: "${CLP_LOGS_DIR_HOST:-./var/log}/.clp-config.yaml"
source: "${CLP_LOGS_DIR_HOST:-../../var/log}/.clp-config.yaml"
target: "/etc/clp-config.yaml"
read_only: true
clp-logs: &volume_clp_logs
type: "bind"
source: "${CLP_LOGS_DIR_HOST:-./var/log}"
source: "${CLP_LOGS_DIR_HOST:-../../var/log}"
target: "/var/log"

services:
Expand All @@ -57,14 +57,14 @@ services:
target: 3306
volumes:
- type: "bind"
source: "${CLP_DB_CONF_LOGGING_FILE_HOST:-./etc/mysql/conf.d/logging.cnf}"
source: "${CLP_DB_CONF_LOGGING_FILE_HOST:-../../etc/mysql/conf.d/logging.cnf}"
target: "/etc/mysql/conf.d/logging.cnf"
read_only: true
- type: "bind"
source: "${CLP_DB_DATA_DIR_HOST:-./var/data/database}"
source: "${CLP_DB_DATA_DIR_HOST:-../../var/data/database}"
target: "/var/lib/mysql"
- type: "bind"
source: "${CLP_DB_LOGS_DIR_HOST:-./var/log/database}"
source: "${CLP_DB_LOGS_DIR_HOST:-../../var/log/database}"
target: "/var/log/mysql"
healthcheck:
<<: *healthcheck_defaults
Expand Down Expand Up @@ -112,7 +112,7 @@ services:
target: 5672
volumes:
- type: "bind"
source: "${CLP_QUEUE_LOGS_DIR_HOST:-./var/log/queue}"
source: "${CLP_QUEUE_LOGS_DIR_HOST:-../../var/log/queue}"
target: "/var/log/rabbitmq"
healthcheck:
<<: *healthcheck_defaults
Expand All @@ -132,14 +132,14 @@ services:
target: 6379
volumes:
- type: "bind"
source: "${CLP_REDIS_CONF_FILE_HOST:-./etc/redis/redis.conf}"
source: "${CLP_REDIS_CONF_FILE_HOST:-../../etc/redis/redis.conf}"
target: "/usr/local/etc/redis/redis.conf"
read_only: true
- type: "bind"
source: "${CLP_REDIS_DATA_DIR_HOST:-./var/data/redis}"
source: "${CLP_REDIS_DATA_DIR_HOST:-../../var/data/redis}"
target: "/data"
- type: "bind"
source: "${CLP_REDIS_LOGS_DIR_HOST:-./var/log/redis}"
source: "${CLP_REDIS_LOGS_DIR_HOST:-../../var/log/redis}"
target: "/var/log/redis"
command: [
"redis-server",
Expand Down Expand Up @@ -168,14 +168,14 @@ services:
target: 27017
volumes:
- type: "bind"
source: "${CLP_RESULTS_CACHE_CONF_FILE_HOST:-./etc/mongo/mongod.conf}"
source: "${CLP_RESULTS_CACHE_CONF_FILE_HOST:-../../etc/mongo/mongod.conf}"
target: "/etc/mongo/mongod.conf"
read_only: true
- type: "bind"
source: "${CLP_RESULTS_CACHE_DATA_DIR_HOST:-./var/data/results_cache}"
source: "${CLP_RESULTS_CACHE_DATA_DIR_HOST:-../../var/data/results_cache}"
target: "/data/db"
- type: "bind"
source: "${CLP_RESULTS_CACHE_LOGS_DIR_HOST:-./var/log/results_cache}"
source: "${CLP_RESULTS_CACHE_LOGS_DIR_HOST:-../../var/log/results_cache}"
target: "/var/log/mongodb"
command: [
"--config", "/etc/mongo/mongod.conf",
Expand Down Expand Up @@ -259,7 +259,7 @@ services:
- "${CLP_LOGS_INPUT_DIR_HOST:-empty}:${CLP_LOGS_INPUT_DIR_CONTAINER:-/mnt/logs}"
- "${CLP_STAGED_ARCHIVE_OUTPUT_DIR_HOST:-empty}:/var/data/staged-archives"
- type: "bind"
source: "${CLP_TMP_DIR_HOST:-./var/tmp}"
source: "${CLP_TMP_DIR_HOST:-../../var/tmp}"
target: "/var/tmp"
command: [
"python3",
Expand Down Expand Up @@ -295,11 +295,11 @@ services:
- "${CLP_AWS_CONFIG_DIR_HOST:-empty}:/opt/clp/.aws:ro"
- "${CLP_STREAM_OUTPUT_DIR_HOST:-empty}:/var/data/streams"
- type: "bind"
source: "./var/www/webui/client/settings.json"
source: "../../var/www/webui/client/settings.json"
target: "/opt/clp/var/www/webui/client/settings.json"
read_only: true
- type: "bind"
source: "./var/www/webui/server/dist/settings.json"
source: "../../var/www/webui/server/dist/settings.json"
target: "/opt/clp/var/www/webui/server/dist/settings.json"
read_only: true
depends_on:
Expand Down
0 ...ployment/package/docker-compose-base.yaml → ...c/docker-compose/docker-compose-base.yaml
View file
Open in desktop
File renamed without changes.
0 ...yment/package/docker-compose.runtime.yaml → ...ocker-compose/docker-compose.runtime.yaml
View file
Open in desktop
File renamed without changes.
0 ...loyment/package/docker-compose.utils.yaml → .../docker-compose/docker-compose.utils.yaml
View file
Open in desktop
File renamed without changes.
Loading