Skip to content

docs(clp-package): Document default container configurations in the package Docker image. #1530

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(clp-package): Document default container configurations in the package Docker image. #1530

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2665244
docs(clp-package): Document default container configurations in the p…
junhaoliao Oct 30, 2025
7328954
grammar - Apply suggestions from code review
junhaoliao Oct 31, 2025
3ed81bb
Merge branch 'main' into docker-image-docs
junhaoliao Nov 4, 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
14 changes: 14 additions & 0 deletions docs/src/dev-docs/tooling-containers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,20 @@ An image containing the CLP package.
tools/docker-images/clp-package
```

### Default Configurations

While not intended for direct end-user deployment, the container includes these configurations for
debugging purposes:
Comment on lines +144 to +145
Copy link
Contributor

@sitaowang1998 sitaowang1998 Oct 30, 2025

Choose a reason for hiding this comment

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

I don't think these configurations are really for debugging.

Copy link
Member Author

@junhaoliao junhaoliao Oct 31, 2025

Choose a reason for hiding this comment

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

Technically we don't have to create users in the image and any env var overrides can be specified only in the docker compose yamls. That said, practically we can clean up the duplicated specifications from the docker compose files now they are specified in the image

If we don't clean up, until we make the Package docker image standalone runnable, the non root user and the env vars are to help debugging the Package runtime environment


| Setting | Related Env Var | Value | Purpose |
Copy link
Member

@kirkrodrigues kirkrodrigues Nov 5, 2025

Choose a reason for hiding this comment

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

I think some of these deserve more explanation. I'll come back to this PR after the release.

|-----------------|-------------------|--------------------------------------------------------|--------------------------------------------------|
| Executable path | `PATH` | `${CLP_HOME}/sbin`<br>`:${CLP_HOME}/bin`<br>`:${PATH}` | CLP executables in system path |
| Home directory | `CLP_HOME` | `/opt/clp` | User's home directory; shell sessions start here |
| Library path | `LD_LIBRARY_PATH` | `${CLP_HOME}/lib` | Shared library search path |
| Python path | `PYTHONPATH` | `${CLP_HOME}/lib/python3/site-packages` | Python module search path |
| Shell | `SHELL` | `/bin/bash` | Default shell |
| User | `USER` | `clp-user` (UID: `1000`) | Non-root user for secure operations |

[core-deps-centos-stream-9]: https://github.com/y-scope/clp/pkgs/container/clp%2Fclp-core-dependencies-x86-centos-stream-9
[core-deps-manylinux_2_28-x86_64]: https://github.com/y-scope/clp/pkgs/container/clp%2Fclp-core-dependencies-x86-manylinux_2_28
[core-deps-musllinux_1_2-x86_64]: https://github.com/y-scope/clp/pkgs/container/clp%2Fclp-core-dependencies-x86-musllinux_1_2
Expand Down