Skip to content

fix(clp-package): Remove unused staged-streams volume mount from the api-server service (fixes #1810).#1947

Merged
junhaoliao merged 2 commits into
y-scope:mainfrom
junhaoliao:issue-1810
Feb 9, 2026
Merged

fix(clp-package): Remove unused staged-streams volume mount from the api-server service (fixes #1810).#1947
junhaoliao merged 2 commits into
y-scope:mainfrom
junhaoliao:issue-1810

Conversation

@junhaoliao

@junhaoliao junhaoliao commented Feb 2, 2026

Copy link
Copy Markdown
Member

Description

Remove the staged-streams volume mount from the api-server service in docker-compose-all.yaml. The API server does not read or write staged streams; only the query-worker requires this mount.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

0. Build CLP package

Command:

task

Build completed successfully.

1. Start CLP and verify container mounts

Configured clp-config.yaml with S3 storage for stream_output to
exercise the staged-streams path:

stream_output:
  storage:
    type: "s3"
    staging_directory: "var/data/staged-streams"
    s3_config:
      region_code: "us-east-2"
      bucket: "yscope-junhao-test"
      key_prefix: "/"
      aws_authentication:
        type: "credentials"
        credentials: ...

Command:

./sbin/start-clp.sh

All containers started and passed health checks.

API server mounts (docker inspect --format '{{range .Mounts}}...'):

/var/log
/var/data/streams
/etc/clp-config.yaml

No staged-streams mount on the API server.

Query-worker mounts:

/var/log
/var/data/archives
/opt/clp/.aws
/var/data/staged-streams
/var/data/streams
/etc/clp-config.yaml

The query-worker retains /var/data/staged-streams.

2. Compress data and query via the API server

Compressed sample data (./sbin/compress.sh), then submitted a search query and fetched results directly from the API server's /query_results SSE endpoint:

# Submit search
curl http://<api-server>:3001/query -X POST \
    -H "Content-Type: application/json" \
    -d '{"query_string":"SELECT","dataset":"default","max_num_results":10}'
# => {"query_results_uri":"/query_results/5"}

# Fetch results (API server reads from S3, not staged-streams)
curl -N http://<api-server>:3001/query_results/5
# => data: {"timestamp":"2023-03-27 00:26:41.483","pid":7845,...,"ps":"SELECT",...}
#    data: {"timestamp":"2023-03-27 00:26:46.201","pid":7854,...,"ps":"SELECT",...}
#    ...  (10 results streamed successfully)

The API server successfully read query results from S3 without the staged-streams mount.

3. Stop CLP

2026-02-02T01:23:44.400 INFO [controller] Stopped CLP.

Summary by CodeRabbit

  • Chores
    • Removed a volume mapping from the api-server service in the Docker Compose configuration, which may affect access to staged-streams data within the container.

✏️ Tip: You can customize this high-level summary in your review settings.

@junhaoliao junhaoliao requested a review from a team as a code owner February 2, 2026 01:30
@junhaoliao junhaoliao requested a review from hoophalab February 2, 2026 01:30
@junhaoliao junhaoliao added this to the Mid-February 2026 milestone Feb 2, 2026
@coderabbitai

coderabbitai Bot commented Feb 2, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

A volume mapping is removed from the api-server service in the Docker Compose configuration file. The staged-streams directory mount from the host is no longer included in the container's volume definitions.

Changes

Cohort / File(s) Summary
Docker Compose Configuration
tools/deployment/package/docker-compose-all.yaml
Removed volume mapping ${CLP_STAGED_STREAM_OUTPUT_DIR_HOST:-empty}:/var/data/staged-streams from api-server service; may impact access to staged-streams data within the container.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: removing an unused volume mount from the api-server service in docker-compose-all.yaml, with reference to the related issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@junhaoliao junhaoliao requested review from hoophalab and removed request for hoophalab February 5, 2026 18:40
@junhaoliao junhaoliao merged commit dbbfba9 into y-scope:main Feb 9, 2026
21 checks passed
@junhaoliao junhaoliao deleted the issue-1810 branch May 7, 2026 19:46
junhaoliao added a commit to junhaoliao/clp that referenced this pull request May 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants