Commit Graph

417 Commits

Author SHA1 Message Date
Swagat Bora
88b4cc659a address review comments
Signed-off-by: Swagat Bora <sbora@amazon.com>
2024-04-02 20:40:55 +00:00
Swagat Bora
f20c49311d Update tracing documentation to add details about manual instrumentation
Signed-off-by: Swagat Bora <sbora@amazon.com>
2024-04-02 20:40:55 +00:00
Arash Haghighat
ea681afbaa
docs: fix typo
Signed-off-by: Arash Haghighat <arash@linja.pro>
2024-03-26 16:45:12 +01:00
Austin Vazquez
413fbe82c7
Fix unpacker link in remote snapshotter docs
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-02-10 16:42:24 -08:00
Akihiro Suda
b466b7ef85
Merge pull request #9747 from AkihiroSuda/revert-9713
Revert "cri: make read-only mounts recursively read-only"
2024-02-08 10:29:03 +00:00
Akihiro Suda
1f58a53a61
Merge pull request #8048 from profnandaa/docs/windows-setup
docs: add step to include binaries in the $env:Path
2024-02-08 08:18:59 +00:00
Anthony Nandaa
9ef94fe528 fix(docs): fix cp and add step to include binaries in the $env:Path
This commit adds an extra (optional) step for the Windows
installation/set-up to include the containerd binaries in
the $env:Path so that later executions especially
for `ctr.exe` if needed, do not require to specify the full path.

It also further fixes the previous steps to be absolute and
also work with re-installations and upgrades.

Signed-off-by: Anthony Nandaa <profnandaa@gmail.com>
2024-02-05 11:41:45 +03:00
Krisztian Litkey
fe24b918f6
pkg/nri, docs: enable NRI by default.
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
2024-02-04 11:41:56 +02:00
Akihiro Suda
6670695836
Revert "cri: make read-only mounts recursively read-only"
Revert PR 9713, as it appeared to break the compatibility too much
https://github.com/kubernetes/enhancements/pull/3858#issuecomment-1925441072

This reverts commit b2f254fff0.

> Conflicts:
>	internal/cri/opts/spec_linux_opts.go

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-02-04 01:17:14 +09:00
Akihiro Suda
b2f254fff0
cri: make read-only mounts recursively read-only
Prior to this commit, `readOnly` volumes were not recursively read-only and
could result in compromise of data;
e.g., even if `/mnt` was mounted as read-only, its submounts such as
`/mnt/usbstorage` were not read-only.

This commit utilizes runc's "rro" bind mount option to make read-only bind
mounts literally read-only. The "rro" bind mount options is implemented by
calling `mount_setattr(2)` with `MOUNT_ATTR_RDONLY` and `AT_RECURSIVE`.

The "rro" bind mount options requires kernel >= 5.12, with runc >= 1.1 or
a compatible runtime such as crun >= 1.4.

When the "rro" bind mount options is not available, containerd falls back
to the legacy non-recursive read-only mounts by default.

The behavior is configurable via `/etc/containerd/config.toml`:
```toml
version = 2
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
  # treat_ro_mounts_as_rro ("Enabled"|"IfPossible"|"Disabled")
  # treats read-only mounts as recursive read-only mounts.
  # An empty string means "IfPossible".
  # "Enabled" requires Linux kernel v5.12 or later.
  # This configuration does not apply to non-volume mounts such as "/sys/fs/cgroup".
  treat_ro_mounts_as_rro = ""
```

Replaces:
- kubernetes/enhancements issue 3857
- kubernetes/enhancements PR 3858

Note: this change does not affect non-CRI clients such as ctr, nerdctl, and Docker/Moby.
RRO mounts have been supported since nerdctl v0.14 (containerd/nerdctl PR 511)
and Docker v25 (moby/moby PR 45278).

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-02-01 09:39:36 +09:00
谭九鼎
87a9835f16
docs: fix typo
Signed-off-by: 谭九鼎 <109224573@qq.com>
2024-01-31 21:37:48 +08:00
Akihiro Suda
ebbce74230
rm docs/cri/installation.md
The file was replaced with the "Please update your bookmark" page on
Apr 1, 2022 (PR 6758).

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-01-31 05:04:54 +09:00
Samuel Karp
22e1a2e65c
Merge pull request #9675 from yanggangtony/clean-indent-for-containerd-config.toml
Clean plugin indent in containerd-config.toml.5.md
2024-01-28 09:01:11 +00:00
Akhil Mohan
b608c6f73d
doc: fix package import path in sample code
fix package import path that was changed as part of v2 in sample code
snippets.

Signed-off-by: Akhil Mohan <akhilerm@gmail.com>
2024-01-26 11:41:30 +05:30
Evan Lezar
ad869e9053 Use tags.cncf.io CDI url in config.md
Signed-off-by: Evan Lezar <elezar@nvidia.com>
2024-01-24 14:53:15 +01:00
yanggang
7eccde5d03
Clean plugin indent in containerd-config.toml.5.md
Signed-off-by: yanggang <gang.yang@daocloud.io>
2024-01-23 07:02:07 +00:00
Ed Bartosh
c8e8a093ce config: enable CDI by default
Signed-off-by: Ed Bartosh <eduard.bartosh@intel.com>
2024-01-12 09:31:39 +02:00
Derek McGowan
2c8a996330
Merge pull request #9495 from jamesorlakin/chore/hosts-documentation-ns
Document `ns` query string added to mirror requests
2023-12-15 19:54:00 +00:00
James Lakin
6bb81ee577
Document ns query string added to mirror requests
This also adds clarification to the `server` field being used as a fallback.

Signed-off-by: James Lakin <james@jameslakin.co.uk>
2023-12-11 13:44:39 +00:00
Maksym Pavlenko
bfa651c69f Fix broken links
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2023-12-09 13:09:39 -08:00
Austin Vazquez
1af0cba1a8 Update documentation for containerd v2.0 packages
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2023-11-16 00:40:21 +00:00
Avi Deitcher
76049170b8 document runtime and shim configuration and selection
Signed-off-by: Avi Deitcher <avi@deitcher.net>
2023-11-06 08:59:36 +02:00
Alex Rodriguez
124d3a20a6
Sync ops.md, update CLI --help output to be consistent in descriptions
Signed-off-by: Alex Rodriguez <alexrodriguez@ibm.com>
2023-10-30 08:54:29 -07:00
Maksym Pavlenko
e62cacc4d6
Merge pull request #9147 from bryantbiggs/docs/transfer-service
docs: Update `transfer` service docs to reflect completed implementations for `1.7`
2023-09-27 12:30:44 -07:00
Akihiro Suda
9ca6fd9e6e
Merge pull request #9117 from kinvolk/rata/userns-chown-opt-in
Require opt-in for rootfs chown when idmap mounts is not supported
2023-09-28 02:34:41 +09:00
Bryant Biggs
bf4fbe4e87 docs: Update transfer service docs to reflect completed implementations for 1.7
Signed-off-by: Bryant Biggs <bryantbiggs@gmail.com>
2023-09-26 12:31:19 -04:00
Rodrigo Campos
f1070c4e18 docs/userns: Clarify requirements for k8s 1.25/1.26
crun 1.4.3 as well as runc 1.1 both support to open bind-mounts before
dropping privileges, as they are inaccessible after switching to the
user namespace. So that is the minimum version to use with containerd
1.7.

Also, since containerd 2.0 we use idmap mounts for files mounted in the
container created by containerd (like etc/hostname, etc/hosts, etc.), so
in that case we require newer OCI runtimes too. However, as the kubelet
doesn't request idmap mounts for kube volumes, we can lower the kernel
version.

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2023-09-22 15:52:38 +02:00
Rodrigo Campos
46d3094aa3 docs/userns: Fix small typo
Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2023-09-19 16:37:40 +02:00
Rodrigo Campos
d008d64a8f docs/userns: Clarify containerd 1.7 limitations
Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2023-09-19 16:37:40 +02:00
Rodrigo Campos
e379082000 docs/userns: Document the need to opt-in for a slow chown
Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2023-09-19 16:37:40 +02:00
Derek McGowan
31b6cdfd10
Merge pull request #8493 from DataDog/image-verifier-bindir-plugin
Add image verifier transfer service plugin system based on a binary directory
2023-09-14 06:37:17 -07:00
Rodrigo Campos
967313049f doc: Add documentation about CRI user namespaces
Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2023-09-13 23:37:47 +02:00
Ethan Lowman
ac1d556b92
Add image verifier transfer service plugin system based on a binary directory
Signed-off-by: Ethan Lowman <ethan.lowman@datadoghq.com>
2023-09-07 18:45:02 -04:00
VERNOU Cédric
4bc0b26602
Revert the removal of the parameter Container
Signed-off-by: VERNOU Cédric <1659796+vernou@users.noreply.github.com>
2023-09-06 14:56:21 +02:00
VERNOU Cédric
ef6b91947e
fix(docs): fix on the windows installation script
Modify the parameter `-Path` to reference a folder, so `Copy-Item` create the destination folder.
Remove "-Container:$false" that flatten the hierarchy folder.

Signed-off-by: VERNOU Cédric <1659796+vernou@users.noreply.github.com>
2023-09-02 13:19:50 +02:00
Danny Canter
de4c338ab5 Docs: Document proxy plugin diff support
Document that differs can be proxy plugins now.

Signed-off-by: Danny Canter <danny@dcantah.dev>
2023-08-18 17:55:54 -07:00
Amir M. Ghazanfari
fd8778fba3
delete checkout branch in doc
branch "pr/proto/draft" in NRI doesn't exist anymore it's better to delete this line 

Signed-off-by: Amir M. Ghazanfari <a.m.ghazanfari76@gmail.com>
2023-08-04 22:46:33 +03:30
Markus Lehtonen
c62abcb146 docs: document CRI cgroup driver auto detection
Document the user visible changes related to the new RuntimeConfig RPC.

Signed-off-by: Markus Lehtonen <markus.lehtonen@intel.com>
2023-08-04 09:48:29 +03:00
Kazuyoshi Kato
45d78fb1f1
Merge pull request #8582 from chschumacher1994/patch-1
fix(docs): minor fix on the windows installation steps
2023-05-31 17:42:53 -07:00
Kazuyoshi Kato
3ad032e9d0
Merge pull request #8606 from adisky/remove-conf-template-deprecation
Remove cni conf_template deprecation
2023-05-31 09:47:21 -07:00
Aditi Sharma
3ca5b4437e Remove cni conf_template deprecation
As discussed in the issue
https://github.com/containerd/containerd/issues/8596
It is a helpful feature at many places and no replacement
readily available

Signed-off-by: Aditi Sharma <adi.sky17@gmail.com>
2023-05-31 17:34:33 +05:30
Derek McGowan
197b27bd02
Merge pull request #8586 from mcdonagj/fix-spelling-of-repository-in-nri-docs
Fix: Correct the spelling of repository within the NRI plugin documentation.
2023-05-30 09:27:44 -07:00
rongfu.leng
9287711b7a upgrade registry.k8s.io/pause version
Signed-off-by: rongfu.leng <rongfu.leng@daocloud.io>
2023-05-28 07:59:10 +08:00
Gary McDonald
fbb38ab6b8
Fix the spelling of repository within the NRI plugin documentation.
Signed-off-by: Gary McDonald <mcdonagj@dukes.jmu.edu>
2023-05-27 13:18:46 -04:00
chschumacher1994
752e13d9a9
fix(docs): minor fix on the windows installation steps
If this command is used without "-Container:$false" and the "containerd" directory does not already exist all files will be merged into a single "containerd" file instead of a new directory.

Signed-off-by: chschumacher1994 <115921143+chschumacher1994@users.noreply.github.com>
2023-05-27 01:35:42 +02:00
Kohei Tokunaga
261d45efe1
docs/remote-snapshotter.md: update links and description
This commit fixes a broken link. This commit also updates the description about
the image handler. It now mentions about
`github.com/containerd/containerd/pkg/snapshotters` package.

Signed-off-by: Kohei Tokunaga <ktokunaga.mail@gmail.com>
2023-05-23 22:55:57 +09:00
Akihiro Suda
878132923d
Merge pull request #8511 from dmcgowan/blockfile-snapshotter
Add blockfile snapshotter
2023-05-18 11:52:37 +09:00
Derek McGowan
b729962e3e
Add blockfile snapshotter to snapshotters doc
Signed-off-by: Derek McGowan <derek@mcg.dev>
2023-05-17 14:25:27 -07:00
Derek McGowan
9e7f8fe30c
Update CRI registry configuration docs
Remove deprecated sections except for auth configuration.
Add note about auth configuration deprecation.

Signed-off-by: Derek McGowan <derek@mcg.dev>
2023-04-29 23:54:25 -07:00
Tony Fang
8c80ccc7f4 Update external repo links that changed default branch to main
Signed-off-by: Tony Fang <nhfang@amazon.com>
2023-04-21 20:26:48 +00:00