refactor(structure): deploy and tools #377
Conversation
Signed-off-by: JaredforReal <[email protected]>
👥 vLLM Semantic Team NotificationThe following members have been identified for the changed files in this PR and have been automatically assigned: 📁
|
✅ Deploy Preview for vllm-semantic-router ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: JaredforReal <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR restructures runtime and tooling assets to improve repository organization by relocating Docker Compose files and cleaning up unused assets. The goal is to separate production deployment artifacts from local development utilities and provide clearer separation between tracing and observability tooling.
- Moved main docker-compose.yml from root to deploy/docker-compose/ directory
- Relocated observability and tracing compose files to tools/ directory for development separation
- Updated documentation and scripts to reference new file paths
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/troubleshooting/network-tips.md | Updated references to relocated docker-compose.yml path |
| website/docs/troubleshooting/container-connectivity.md | Updated comment to reflect new compose file location |
| tools/tracing/docker-compose.tracing.yaml | New tracing compose file relocated from deploy/ |
| tools/tracing/README.md | New documentation for tracing development stack |
| tools/observability/scripts/stop-observability.sh | Updated compose file paths |
| tools/observability/scripts/start-observability.sh | Updated compose file paths |
| tools/observability/docker-compose.obs.yml | Updated volume mount paths to be relative to new location |
| tools/observability/README.md | Added tracing stack documentation |
| tools/make/observability.mk | Updated compose file paths in Make targets |
| tools/make/docker.mk | Enhanced docker compose targets with rebuild functionality |
| deploy/tracing/README.md | Removed obsolete tracing documentation |
| deploy/llm-router-dashboard.json | Removed duplicate Grafana dashboard file |
| deploy/docker-compose/docker-compose.yml | Main compose file relocated with updated relative paths |
| deploy/docker-compose/README.md | New documentation for main compose stack |
| deploy/docker-compose.tracing.yaml | Removed obsolete tracing compose file |
Comments suppressed due to low confidence (1)
tools/make/docker.mk:115
- Missing
-f deploy/docker-compose/docker-compose.ymlflag to specify the relocated compose file path.
docker-compose-down:
@$(LOG_TARGET)
@echo "Stopping docker-compose services..."
@docker compose down
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: JaredforReal <[email protected]>
|
@rootfs it‘s ready for merge now |
| This directory contains the primary `docker-compose.yml` used to run the semantic-router stack (router + envoy + optional mock-vllm + observability). | ||
|
|
||
| ## Path Layout | ||
| Because this file lives under `deploy/docker-compose/`, all relative paths to repository resources go two levels up (../../) back to repo root. |
There was a problem hiding this comment.
deploy/docker-compose/ maybe -> deploy/docker-compose ?
There was a problem hiding this comment.
Do u mean moving the docker-compose.yml out of the dir? I just wanted to keep 3 deployments parallel.
There was a problem hiding this comment.
no. What I mean is, can we remove the '/' at the end? It seems a bit counterintuitive,
but it's just a suggestion. Don't pay too much attention to it.
| @@ -0,0 +1,54 @@ | |||
| version: '3.8' | |||
There was a problem hiding this comment.
Docker Compose no longer requires a version tag. This is outdated and we can remove it.
refer: https://docs.docker.com/reference/compose-file/version-and-name/
* refactor deploy and tools Signed-off-by: JaredforReal <[email protected]> * add rebuild option Signed-off-by: JaredforReal <[email protected]> * add path Signed-off-by: JaredforReal <[email protected]> --------- Signed-off-by: JaredforReal <[email protected]> Co-authored-by: Huamin Chen <[email protected]>
4 participants
What type of PR is this?
refactor(chore/structure): relocate compose stacks, clean up unused assets, add tracing & observability separation
What this PR does / why we need it:
This PR restructures runtime and tooling assets to make the repository layout clearer and reduce ambiguity between production deployment artifacts and local developer utilities.
Summary of Changes:
Moved root
docker-compose.ymltodeploy/docker-compose/docker-compose.ymlMoved local observability compose file to
tools/observability/docker-compose.obs.yml(from root)Moved tracing compose from
deploy/docker-compose.tracing.yaml→tools/tracing/docker-compose.tracing.yamlAdded
docker-compose-tracing-up/docker-compose-tracing-downtargetsRemoved unused
llm-router-dashboard.json(duplicate of existing Grafana provisioning JSON under observability)Adjusted docs:
network & connectivitytroubleshooting pages to reflect new compose path