[None][infra] Add container notices and documentation #9185
Conversation
|
/bot run |
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
from
df42cda to
c5b49fc
Compare
📝 WalkthroughWalkthroughThese changes introduce automated Open Source Software (OSS) attribution generation into the Docker build pipeline. A new script generates NOTICE files containing OSS information during image builds, UCX source code is archived during installation, and documentation details container source locations. Changes
Sequence DiagramsequenceDiagram
participant Docker Build
participant generate_oss_attribution.sh
participant Filesystem
rect rgb(200, 220, 240)
Note over Docker Build,Filesystem: Devel Stage
Docker Build->>Docker Build: Copy generate_oss_attribution.sh to /tmp
Docker Build->>generate_oss_attribution.sh: Execute with mode="devel"
generate_oss_attribution.sh->>generate_oss_attribution.sh: Validate inputs
generate_oss_attribution.sh->>generate_oss_attribution.sh: Construct OSS URL
generate_oss_attribution.sh->>Filesystem: Write NOTICE.txt
Docker Build->>Docker Build: Remove generate_oss_attribution.sh
end
rect rgb(240, 200, 220)
Note over Docker Build,Filesystem: Release Stage
Docker Build->>Docker Build: Copy generate_oss_attribution.sh to /tmp
Docker Build->>generate_oss_attribution.sh: Execute with mode="release"
generate_oss_attribution.sh->>Filesystem: Write NOTICE.txt
Docker Build->>Docker Build: Remove generate_oss_attribution.sh
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (2)
CONTAINER_SOURCE.md (1)
3-3: Fix compound adjective hyphenation.Use "open-source" instead of "open source" when modifying "archive" as a compound adjective.
-A `NOTICES.txt` file containing a link to the open source archive for a given container can be found at `/` in both the `release` and `devel` images. +A `NOTICES.txt` file containing a link to the open-source archive for a given container can be found at `/` in both the `release` and `devel` images.docker/Dockerfile.multi (1)
185-189: Verify consistency between devel and release stage invocations.Both devel (line 94) and release (line 187) stages invoke the attribution script, but ensure the parameters and expected outputs are semantically consistent. The release stage should follow the same pattern as devel for maintainability and to avoid divergent behavior.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CONTAINER_SOURCE.md(1 hunks)docker/Dockerfile.multi(2 hunks)docker/common/install_ucx.sh(1 hunks)scripts/generate_oss_attribution.sh(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: farshadghodsian
Repo: NVIDIA/TensorRT-LLM PR: 7101
File: docs/source/blogs/tech_blog/blog9_Deploying_GPT_OSS_on_TRTLLM.md:36-36
Timestamp: 2025-08-21T00:16:56.457Z
Learning: TensorRT-LLM container release tags in documentation should only reference published NGC container images. The README badge version may be ahead of the actual published container versions.
📚 Learning: 2025-08-21T00:16:56.457Z
Learnt from: farshadghodsian
Repo: NVIDIA/TensorRT-LLM PR: 7101
File: docs/source/blogs/tech_blog/blog9_Deploying_GPT_OSS_on_TRTLLM.md:36-36
Timestamp: 2025-08-21T00:16:56.457Z
Learning: TensorRT-LLM container release tags in documentation should only reference published NGC container images. The README badge version may be ahead of the actual published container versions.
Applied to files:
CONTAINER_SOURCE.md
📚 Learning: 2025-08-06T13:58:07.506Z
Learnt from: galagam
Repo: NVIDIA/TensorRT-LLM PR: 6487
File: tests/unittest/_torch/auto_deploy/unit/singlegpu/test_ad_trtllm_bench.py:1-12
Timestamp: 2025-08-06T13:58:07.506Z
Learning: In TensorRT-LLM, test files (files under tests/ directories) do not require NVIDIA copyright headers, unlike production source code files. Test files typically start directly with imports, docstrings, or code.
Applied to files:
CONTAINER_SOURCE.mddocker/Dockerfile.multi
📚 Learning: 2025-08-20T15:04:42.885Z
Learnt from: dbari
Repo: NVIDIA/TensorRT-LLM PR: 7095
File: docker/Dockerfile.multi:168-168
Timestamp: 2025-08-20T15:04:42.885Z
Learning: In docker/Dockerfile.multi, wildcard COPY for benchmarks (${CPP_BUILD_DIR}/benchmarks/*Benchmark) is intentionally used instead of directory copy because the benchmarks directory contains various other build artifacts during C++ builds, and only specific benchmark executables should be copied to the final image.
Applied to files:
docker/Dockerfile.multi
📚 Learning: 2025-08-18T09:08:07.687Z
Learnt from: tongyuantongyu
Repo: NVIDIA/TensorRT-LLM PR: 6984
File: cpp/tensorrt_llm/CMakeLists.txt:297-299
Timestamp: 2025-08-18T09:08:07.687Z
Learning: In the TensorRT-LLM project, artifacts are manually copied rather than installed via `cmake --install`, so INSTALL_RPATH properties are not needed - only BUILD_RPATH affects the final artifacts.
Applied to files:
docker/Dockerfile.multi
📚 Learning: 2025-10-22T06:53:47.017Z
Learnt from: xinhe-nv
Repo: NVIDIA/TensorRT-LLM PR: 8534
File: scripts/format_test_list.py:1-6
Timestamp: 2025-10-22T06:53:47.017Z
Learning: The file `scripts/format_test_list.py` in the TensorRT-LLM repository does not require the NVIDIA Apache-2.0 copyright header.
Applied to files:
docker/Dockerfile.multi
🪛 LanguageTool
CONTAINER_SOURCE.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ICES.txt` file containing a link to the open source archive for a given container can be fo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Pre-commit Check
🔇 Additional comments (1)
docker/Dockerfile.multi (1)
91-95: Verify build-time variables are properly defined.Ensure that
TRT_LLM_VERis always provided as a build argument and thatTARGETARCHis available in the devel stage. Line 92 declaresTARGETARCHas a newARG, but confirm this automatic BuildKit variable is accessible at this point in both the devel and release stages.
|
PR_Github #24637 [ run ] triggered by Bot. Commit: |
|
PR_Github #24637 [ run ] completed with state |
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
2 times, most recently
from
5ca3876 to
ba09d3d
Compare
|
/bot run --stage-list "Build-Docker-Images" |
|
PR_Github #24694 [ run ] triggered by Bot. Commit: |
|
PR_Github #24694 [ run ] completed with state |
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
from
ba09d3d to
fe4d139
Compare
|
/bot run --stage-list "Build-Docker-Images" |
|
PR_Github #24799 [ run ] triggered by Bot. Commit: |
|
PR_Github #24799 [ run ] completed with state |
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
from
fe4d139 to
f46c78c
Compare
|
/bot run --stage-list "Build-Docker-Images" |
|
PR_Github #25077 [ run ] triggered by Bot. Commit: |
|
PR_Github #25079 [ run ] triggered by Bot. Commit: |
|
PR_Github #25077 [ run ] completed with state |
|
PR_Github #25079 [ run ] completed with state |
tburt-nv
requested review from
Funatiq and
MartinMarciniszyn
and removed request for
ruodil
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
2 times, most recently
from
0c087a8 to
6ac1d2f
Compare
|
/bot run --stage-list "Build-Docker-Images" |
|
PR_Github #26464 [ run ] triggered by Bot. Commit: |
|
PR_Github #26464 [ run ] completed with state |
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
2 times, most recently
from
41fd7b0 to
6db470b
Compare
|
/bot run --stage-list "Build-Docker-Images" |
|
PR_Github #26492 [ run ] triggered by Bot. Commit: |
|
PR_Github #26492 [ run ] completed with state |
Signed-off-by: Parker Drake <[email protected]>
Signed-off-by: Parker Drake <[email protected]>
Signed-off-by: Parker Drake <[email protected]>
Signed-off-by: Parker Drake <[email protected]>
Signed-off-by: Parker Drake <[email protected]>
pdrake-nv
force-pushed
the
user/pdrake-nv-container-notices
branch
from
6db470b to
7f6a1cf
Compare
|
/bot run --stage-list "Build-Docker-Images" |
|
PR_Github #26650 [ run ] triggered by Bot. Commit: |
|
PR_Github #26650 [ run ] completed with state |
|
/bot skip --comment "Verified container generation; Retriggered failed image scanning then passed; No need to update CI image tags" |
|
PR_Github #26853 [ skip ] triggered by Bot. Commit: |
|
PR_Github #26853 [ skip ] completed with state |
4 participants
Summary by CodeRabbit
Documentation
Chores
Description
Adds container notices to archives of open source code included within the container, and documents their location.
Test Coverage
PR Checklist
Please review the following before submitting your PR:
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
Update tava architecture diagram if there is a significant design change in PR.
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: Does NOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.