8000 docs: cdi isn't experimental by ArthurFlag · Pull Request #6162 · docker/cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: cdi isn't experimental #6162

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: cdi isn't experimental #6162

wants to merge 1 commit into from
+1 −2

Conversation

ArthurFlag
Copy link
@ArthurFlag ArthurFlag commented Jul 3, 2025 •
< 8000 summary class="btn-link no-underline color-fg-muted js-notice">
edited by thaJeztah
Loading

- What I did

Removed a note stating CDI is experimental. Closes docker/docs#22926.

- A picture of a cute animal (not mandatory but encouraged)

@ArthurFlag ArthurFlag requested review from thaJeztah and a team as code owners July 3, 2025 08:41
@codecov-commenter
Copy link
codecov-commenter commented Jul 3, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.82%. Comparing base (74a896f) to head (c69acc2).
Report is 8 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #6162      +/-   ##
==========================================
- Coverage   54.83%   54.82%   -0.01%     
==========================================
  Files         364      364              
  Lines       30467    30467              
==========================================
- Hits        16706    16703       -3     
- Misses      12786    12789       +3     
  Partials      975      975
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@thaJeztah
Copy link
Member

Thank you for contributing! It appears your commit message is missing a DCO sign-off,
causing the DCO check to fail.

We require all commit messages to have a Signed-off-by line with your name
and e-mail (see "Sign your work"
in the CONTRIBUTING.md in this repository), which looks something like:

Signed-off-by: YourFirsName YourLastName <yourname@example.org>

There is no need to open a new pull request, but to fix this (and make CI pass),
you need to amend the commit(s) in this pull request, and "force push" the amended
commit.

Unfortunately, it's not possible to do so through GitHub's web UI, so this needs
to be done through the git commandline.

You can find some instructions in the output of the DCO check (which can be found
in the "checks" tab on this pull request), as well as in the Moby contributing guide.

Steps to do so "roughly" come down to:

  1. Set your name and e-mail in git's configuration:

    git config --global user.name "YourFirstName YourLastName"
git config --global user.email "yourname@e
8000
xample.org"

    (Make sure to use your real name (not your GitHub username/handle) and e-mail)

  2. Clone your fork locally

  3. Check out the branch associated with this pull request

  4. Sign-off and amend the existing commit(s)

    git commit --amend --no-edit --signoff

    If your pull request contains multiple commits, either squash the commits (if
    needed) or sign-off each individual commit.

  5. Force push your branch to GitHub (using the --force or --force-with-lease flags) to update the pull request.

Sorry for the hassle (I wish GitHub would make this a bit easier to do), and let me know if you need help or more detailed instructions!

@thaJeztah
Copy link
Member

(sorry for the canned reply above; saves me some writing 😂)

Thanks! I think there's some more changes needed.

Perhaps we should consider removing the NOTE for this, and describe it as part of the body text; there's at least two notes near each-other now, and too many notes adds noise, and reduces their relevance.

Screenshot 2025-07-03 at 12 05 46

For the daemon, we should update the description for the daemon config.
https://github.com/docker/cli/blob/84038691220e7ba3329a177e4e3357b4ee0e3a52/docs/reference/dockerd.md#enable-cdi-devices

  • It currently uses a heading how to enable CDI, but now that it's enabled by default, we should probably consider using a heading like "Configure CDI devices"
  • That section to describe the customizations that can be made (which mostly is configuring custom locations)
  • ☝️ we should still mention the defaults, and mention what happens when configuring custom locations (are the added to the defaults, or replace the defaults?)
  • 👉 steps could outline how to verify if the config took effect (I don't recall from the top of my head if we allow re-configuring without restarting the daemon (SIGHUP / systemctl reload docker))

The current example shows how to enable CDI;

  "features": {
     "cdi": true
  }

We kept support for the option to disable CDI for situations where it's not desirable (moby/moby#49963)

  • so we could add a sub-header describing how to disable CDI support
  • possibly a short mention that it's enabled by default since Docker Engine 28.3.0 (although probably we should have some description how to verify if CDI is supported (from docker info)).
 CDI spec directories:
  /etc/cdi
  /var/run/cdi
 Discovered Devices:
  cdi: docker.com/gpu=webgpu

@thaJeztah thaJeztah added this to the 28.3.2 milestone Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thaJeztah thaJeztah Awaiting requested review from thaJeztah thaJeztah is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
kind/docs status/3-docs-review
Projects
None yet
Milestone
28.3.2
Development

Successfully merging this pull request may close these issues.

CDI docs update
3 participants
@ArthurFlag @codecov-commenter @thaJeztah
0