build: cdi manual#23069

Merged

crazy-max merged 1 commit intodocker:mainfrom

crazy-max:build-cdi

Jul 21, 2025

Member

crazy-max commented Jul 11, 2025 •

edited

Loading

Description

Adds CDI page to build section.

Related issues or tickets

Reviews

Technical review
Editorial review
Product review

github-actions bot added the area/build label

netlify bot commented Jul 11, 2025 •

edited

Loading

✅ Deploy Preview for docsdocker ready!

Name	Link
🔨 Latest commit	`2944e33`
🔍 Latest deploy log	https://app.netlify.com/projects/docsdocker/deploys/687dfe2438aeb60008489e20
😎 Deploy Preview	https://deploy-preview-23069--docsdocker.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

crazy-max force-pushed the build-cdi branch 5 times, most recently from 5465608 to 4ef0c39 Compare

July 11, 2025 11:43

crazy-max requested review from aevesdocker, colinhemmings, sarahsanders-docker, thompson-shaun and tonistiigi

July 11, 2025 11:51

crazy-max marked this pull request as ready for review

July 11, 2025 11:51

crazy-max requested a review from ArthurFlag as a code owner

July 11, 2025 11:51

Contributor

ArthurFlag commented Jul 11, 2025

Could you edit this line to

SECRETS_SCAN_OMIT_PATHS = "public/contribute/file-conventions/index.html,public/content/manuals/build/building/cdi.html"

?

github-actions bot added the area/release label

ArthurFlag suggested changes

View reviewed changes

netlify.toml Outdated Show resolved Hide resolved

crazy-max force-pushed the build-cdi branch from 548a489 to d78b285 Compare

July 11, 2025 12:52

Member Author

crazy-max commented Jul 11, 2025 •

edited

Loading

Thanks looks good now but do you know why it is happening? Looking at the logs: https://app.netlify.com/projects/docsdocker/deploys/6870f8f33387050008ca7b11

1:45:06 PM: ❯ Scanning complete. 8540 file(s) scanned. Secrets scanning found 0 instance(s) of secrets and 1 instance(s) of likely secrets in build output or repo code.
1:45:06 PM: 
1:45:06 PM: "LS0t***" detected as a likely secret:
1:45:06 PM:   found value at line 719 in public/build/building/cdi/index.html
1:45:06 PM: 
1:45:06 PM: To prevent exposing secrets, the build will fail until these likely secret values are not found in build output or repo files.
1:45:06 PM: 
1:45:06 PM: If these are expected, use SECRETS_SCAN_SMART_DETECTION_OMIT_VALUES, or SECRETS_SCAN_SMART_DETECTION_ENABLED to prevent detecting.
1:45:06 PM: 
1:45:06 PM: For more information on secrets scanning, see the Netlify Docs: https://ntl.fyi/configure-secrets-scanning
1:45:06 PM: 
1:45:06 PM: Secrets scanning detected secrets in files during build.      
1:45:06 PM: ────────────────────────────────────────────────────────────────

It says cdi page contains LS0t*** as secret but I don't have any occurrence like this.

thompson-shaun approved these changes

View reviewed changes

crazy-max force-pushed the build-cdi branch from d78b285 to b56f0e5 Compare

July 11, 2025 14:47

Contributor

ArthurFlag commented Jul 11, 2025

The LST0 issue is the one we had a few weeks ago: it comes from codeblocks that we convert into Base64 for the copy button, so one of your codeblocks contains that string once converted 🙃

Member Author

crazy-max commented Jul 11, 2025

The LST0 issue is the one we had a few weeks ago: it comes from codeblocks that we convert into Base64 for the copy button, so one of your codeblocks contains that string once converted 🙃

Ah I see but still wonder why just file-conventions and cdi pages are affected and not others using codeblocks?

crazy-max force-pushed the build-cdi branch 2 times, most recently from b0fd26d to 3153d21 Compare

July 11, 2025 16:09

Member

thaJeztah commented Jul 11, 2025

Ah I see but still wonder why just file-conventions and cdi pages are affected and not others using codeblocks?

I guess just "luck" if the script base64 encodes the content of the codeblock (before styling).

Member

thaJeztah commented Jul 11, 2025

Did a quick check; LS0t is --- (base64 encoded)

thaJeztah reviewed

View reviewed changes

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

ArthurFlag suggested changes

View reviewed changes

Contributor

ArthurFlag left a comment

Great stuff. The troubleshooting in the middle of it will be super useful for AI scrapers 👍

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

crazy-max force-pushed the build-cdi branch from 3153d21 to bdc31c9 Compare

July 14, 2025 10:22

crazy-max force-pushed the build-cdi branch from bdc31c9 to 919a4ca Compare

July 14, 2025 10:22

crazy-max requested a review from ArthurFlag

July 14, 2025 10:24

ArthurFlag approved these changes

View reviewed changes

thaJeztah reviewed

View reviewed changes

Member

thaJeztah left a comment

Looks like I started writing some comments that I didn't submit yet 😂

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

content/manuals/build/building/cdi.md

+              cdiVersion: "0.6.0"
+              kind: "vendor1.com/device"
+              devices:
+              - name: foo

Member

thaJeztah Jul 14, 2025

Perhaps we could use some name like my-device instead of foo (probably also for the filename and env-var)

content/manuals/build/building/cdi.md

Comment on lines +75 to +95

+              GC Policy rule#0:
+               All:            false
+               Filters:        type==source.local,type==exec.cachemount,type==source.git.checkout
+               Keep Duration:  48h0m0s
+               Max Used Space: 658.9MiB
+              GC Policy rule#1:
+               All:            false
+               Keep Duration:  1440h0m0s
+               Reserved Space: 4.657GiB
+               Max Used Space: 953.7MiB
+               Min Free Space: 2.794GiB
+              GC Policy rule#2:
+               All:            false
+               Reserved Space: 4.657GiB
+               Max Used Space: 953.7MiB
+               Min Free Space: 2.794GiB
+              GC Policy rule#3:
+               All:            true
+               Reserved Space: 4.657GiB
+               Max Used Space: 953.7MiB
+               Min Free Space: 2.794GiB

Member

thaJeztah Jul 14, 2025

Perhaps we should omit these in the example output, as they're not really relevant for this manual, e.g.;

Suggested change

      
            GC Policy rule#0:
          
             All:            false
          
             Filters:        type==source.local,type==exec.cachemount,type==source.git.checkout
          
             Keep Duration:  48h0m0s
          
             Max Used Space: 658.9MiB
          
            GC Policy rule#1:
          
             All:            false
          
             Keep Duration:  1440h0m0s
          
             Reserved Space: 4.657GiB
          
             Max Used Space: 953.7MiB
          
             Min Free Space: 2.794GiB
          
            GC Policy rule#2:
          
             All:            false
          
             Reserved Space: 4.657GiB
          
             Max Used Space: 953.7MiB
          
             Min Free Space: 2.794GiB
          
            GC Policy rule#3:
          
             All:            true
          
             Reserved Space: 4.657GiB
          
             Max Used Space: 953.7MiB
          
             Min Free Space: 2.794GiB
          
            # ...

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

content/manuals/build/building/cdi.md Show resolved Hide resolved

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

content/manuals/build/building/cdi.md

+              Now let's create a container builder named `gpubuilder` using Buildx:
+              ```console
+              $ docker buildx create --name gpubuilder --driver-opt "image=crazymax/buildkit:v0.23.2-ubuntu-nvidia" --bootstrap

Member

thaJeztah Jul 14, 2025

We probably want to have this somewhere more "official" I guess (not a blocker); how complicated is this image to build? Would it be an option to add the Dockerfile here (if it's just 2 .. 3 steps)?

Member Author

crazy-max Jul 15, 2025

Yes it will be in the future, this is tracked in moby/buildkit#5944.

Would it be an option to add the Dockerfile here (if it's just 2 .. 3 steps)?

It's the BuildKit Dockerfile so not an option 😅

Member

thaJeztah Jul 15, 2025

Gotcha! I was hoping it could be some COPY --from=buildkit-bin ... to compose the image, but based on a different base image.

Definitely not a blocker!

content/manuals/build/building/cdi.md Outdated Show resolved Hide resolved

content/manuals/build/building/cdi.md

+              title: Container Device Interface (CDI)
+              weight: 60
+              description: Using CDI to access GPUs and other devices in your builds
+              keywords: build, buildkit, buildx, guide, tutorial, cdi, device, gpu, nvidia, cuda, amd, rocm

Member

thaJeztah Jul 14, 2025

Looks like vale may need to be taught some of these acronyms (nvidia, coda ..) or would it be because they're lowercase here?

Member Author

crazy-max Jul 15, 2025 •

edited

Loading

I think keywords should be excluded from Vale analysis or at least don't check casing

Member

usha-mandya Jul 16, 2025

We need to revisit our Vale configuration to include a few more terms to the "allowlist". Yea, excluding metadata could be a good option.

crazy-max force-pushed the build-cdi branch 2 times, most recently from 19103b6 to 266606a Compare

July 18, 2025 12:03

crazy-max commented

View reviewed changes

content/manuals/build/building/cdi.md Outdated

Comment on lines 215 to 219

+              > [!NOTE]
+              > If you are creating a container builder on WSL, you need to ensure that
+              > [Docker Desktop](../../desktop/_index.md) is installed and [WSL 2 GPU Paravirtualization](../../desktop/features/gpu.md#prerequisites)
+              > is enabled. Buildx v0.26+ is also required to mount the WSL libraries in the
+              > container.

Member Author

crazy-max Jul 18, 2025

Added this section related to docker/buildx#3320

Member Author

crazy-max Jul 21, 2025

Removed this part for now as this will happen in the next 0.27 milestone.


          build: cdi manual

2944e33

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>

crazy-max force-pushed the build-cdi branch from 266606a to 2944e33 Compare

July 21, 2025 08:45

crazy-max merged commit 284b194 into docker:main

14 of 15 checks passed

crazy-max deleted the build-cdi branch

July 21, 2025 09:12

crazy-max mentioned this pull request

build: cdi page fixes #23123

Merged

3 tasks

crazy-max mentioned this pull request

build: note about cdi usage in WSL #23304

Merged

3 tasks

aevesdocker pushed a commit that referenced this pull request


          build: note about cdi usage in WSL (#23304)

e1c9465

follow-up
#23069 (comment)

## Related issues or tickets

* docker/buildx#3320

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

thaJeztah thaJeztah left review comments

usha-mandya usha-mandya left review comments

tonistiigi Awaiting requested review from tonistiigi

aevesdocker Awaiting requested review from aevesdocker

colinhemmings Awaiting requested review from colinhemmings

sarahsanders-docker Awaiting requested review from sarahsanders-docker

+2 more reviewers

ArthurFlag ArthurFlag approved these changes

thompson-shaun thompson-shaun approved these changes

Labels

area/build area/release