Skip to content
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.

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

CRI documentation improvements #4573

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

nekwar
Copy link
Contributor

@nekwar nekwar commented Jun 7, 2024

Description

  • Add clarification on dynamic containerd configuration
  • Update nvidia-container-runtime section with up-to-date instructions

Fixes # (issue)
#4558

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

- Add clarification on dynamic containerd configuration
- Update nvidia-container-runtime section with up-to-date instructions

Signed-off-by: Roman Kuzmin <[email protected]>
@nekwar nekwar requested a review from a team as a code owner June 7, 2024 14:43
@nekwar nekwar requested review from twz123 and juanluisvaladas June 7, 2024 14:43
@dvirassamy
Copy link

I had a similar confusion.

You start reading about changing containerd.toml and removing the magic flag.

However the next paragraph provides the better solution, as from 1.27, where you can use the reconciler. which is a better solution as containerd.toml is still managed by k0s but you can extend it or customize it with side configs.

If there is not a good reason to modify containerd.toml, I would suggest to push to the top of the documentation the recommendation solution which uses the reconciler.

docs/runtime.md Outdated Show resolved Hide resolved
@nekwar nekwar force-pushed the docs/nvidia-gpu-operator-docs branch from f39639a to 43b480f Compare June 17, 2024 09:29
@twz123 twz123 merged commit 61a70f1 into k0sproject:main Jun 25, 2024
7 checks passed
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.

4 participants