Skip to content

fix(deployment): Use container user's home directory as the base for the AWS config path (fixes #1524).#1525

Merged
junhaoliao merged 1 commit into
y-scope:mainfrom
junhaoliao:aws-dir-map
Oct 30, 2025
Merged

fix(deployment): Use container user's home directory as the base for the AWS config path (fixes #1524).#1525
junhaoliao merged 1 commit into
y-scope:mainfrom
junhaoliao:aws-dir-map

Conversation

@junhaoliao
Copy link
Copy Markdown
Member

@junhaoliao junhaoliao commented Oct 30, 2025

Description

This PR fixes where AWS credentials are mounted and looked up inside our containers after #1413 changes the in-container $HOME from / to /opt/clp.

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

task
cd build/clp-package

# configure s3 archives & stream output storages as s3 with `profile` auth type: https://docs.yscope.com/clp/main/user-docs/guides-using-object-storage/clp-config.html

./sbin/start-clp.sh
./sbin/compress-from-s3.sh --timestamp-key=timestamp s3-object https://<redacted>/postgresql.jsonl
# observed compression was successful

# launched the webui, performed a search with string `1`, observed results returned
# clicked on the result's link which brought up the log viewer displaying the log context

Summary by CodeRabbit

  • Chores
    • Updated AWS configuration directory path in deployment configurations. AWS credentials are now resolved from the application home directory instead of the system root across all containerized services. Users deploying this version should verify AWS configuration file placement is updated accordingly.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 30, 2025

Walkthrough

The PR updates AWS configuration directory paths from root-relative paths (/.aws) to CLP home-relative paths (/opt/clp/.aws) across Python configuration and Docker Compose deployment files, affecting where AWS credentials are mounted and accessed within containers.

Changes

Cohort / File(s) Summary
Python Configuration
components/clp-py-utils/clp_py_utils/clp_config.py
Updated the public constant CONTAINER_AWS_CONFIG_DIRECTORY from /.aws to CLP_HOME/.aws, making AWS config directory resolution dependent on CLP home instead of root filesystem.
Docker Compose Deployment
tools/deployment/package/docker-compose.base.yaml
Changed AWS config volume mount paths from /.aws to /opt/clp/.aws across multiple services (compression-scheduler, compression-worker, webui, garbage-collector).
Docker Compose Query Worker
tools/deployment/package/docker-compose.yaml
Updated host-to-container bind mount path for AWS config directory in query-worker service from /./.aws to /opt/clp/.aws.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Homogeneous path replacement pattern across files
  • No logic or control flow changes
  • Configuration-only modifications

Areas to verify:

  • Confirm /opt/clp is the correct CLP home directory value in all container contexts
  • Ensure consistency across all service configurations in docker-compose files
  • Validate that the Python constant change aligns with Docker Compose mount paths

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "fix(deployment): Use container user's home directory as the base for the AWS config path (fixes #1524)" directly and accurately describes the main change in the changeset. The modifications across all three files (clp_config.py, docker-compose.base.yaml, and docker-compose.yaml) consistently update AWS config paths from using / or /.aws to using /opt/clp/.aws (the container user's home directory). The title is concise, specific, and clearly communicates both the nature of the fix (deployment-related) and the specific change (AWS config path now uses container home directory as base). A developer scanning the project history would immediately understand this is about correcting AWS credential mount locations following a prior change to the container home directory.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 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 merged commit f2da1db into y-scope:main Oct 30, 2025
22 checks passed
@kirkrodrigues kirkrodrigues changed the title fix(deployment): Use container user’s home directory as the base for the AWS config path (fixes #1524). fix(deployment): Use container user's home directory as the base for the AWS config path (fixes #1524). Nov 10, 2025
@junhaoliao junhaoliao deleted the aws-dir-map 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