Commit Graph

463 Commits

Author SHA1 Message Date
Derek McGowan
5a3bbca1bb Merge pull request #11724 from swagatbora90/cri-image-transfer-doc-update
Update CRI documentation to add information about Image Pull with Transfer Service
2025-05-06 22:51:40 +00:00
Rodrigo Campos
ce73e1b3e9 docs: Run userns example in /tmp
This simplifies the permissions. If it's run on the home, some distros
make the /home/user dir with just permissions for the owner, but we
need +x permissions for others (technically for host user the container
is mapped to, but that is more tricky in this example).

/tmp has the right permissions already, so let's just do the example
there.

While we are there, I just copied the two commands from the runc doc, to
create the rootfs, instead of linking there. Also, I changed the
config.json to include the right path, now that is known.

Having the path fixed makes sure users can't do a mistake when setting
it. This was the cause of #11575 (they were not setting the rootfs as an
absolute path, as documented).

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2025-04-24 12:53:47 +02:00
Rodrigo Campos
882b1903cc docs: Fix typo in userns example
Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2025-04-24 12:53:47 +02:00
Rodrigo Campos
b62339f399 docs: Fix typos to run userns with ctr
While we are there, bash should not be the process, it should be sh. In
the bare-bone image used in the example, bash is not present (or not
present anymore?).

Signed-off-by: Rodrigo Campos <rodrigoca@microsoft.com>
2025-04-24 12:53:47 +02:00
Tony Fang
b694be29a0 Update CRI image service to pull using transfer service
- adds a transfer service progress reporter to handle timeouts. Also other test fixes
- fallback to local image pull when configuration conflict

Signed-off-by: Tony Fang <nhfang@amazon.com>

Co-authored-by: Swagat Bora <sbora@amazon.com>
2025-04-23 18:18:27 +00:00
Swagat Bora
21a6db1b38 Update CRI documentation to add information about Image Pull with Transfer Service
Signed-off-by: Swagat Bora <sbora@amazon.com>
2025-04-22 16:42:05 +00:00
Marco Visin
c1026d5bf6 Fixing install instructions for Windows
Fixing install script to allow using arm64 architecture

Signed-off-by: Marco Visin <marco@visin.ch>
2025-04-14 16:17:09 +02:00
Jin Dong
42effa3b91 Mark NetworkPluginBinDir as DEPRECATED
To make it as DEPRECATED, this PR does the following:

1. Changes config default to use `NetworkPluginBinDirs`;
2. Mark `NetworkPluginBinDir` as deprecated (in config version 3);
3. Add config migration from 2 to 3, which migrates `bin_dir`
  in version 2 to `bin_dirs` in version 3.

Signed-off-by: Jin Dong <djdongjin95@gmail.com>

[wip] add deprecation warning

Signed-off-by: Jin Dong <djdongjin95@gmail.com>
2025-03-21 16:59:32 +00:00
Jin Dong
71f593d4a2 Support multiple CNI plugin bin dirs
Signed-off-by: Jin Dong <djdongjin95@gmail.com>
2025-03-20 17:13:34 +00:00
Philip Laine
c4982bffc6 Add dial timeout field to hosts toml configuration
Signed-off-by: Philip Laine <philip.laine@gmail.com>
2025-03-13 23:33:53 -07:00
Samuel Karp
edd1cc50d5 docs: include note about unprivileged sysctls
We changed the default setting for `enable_unprivileged_ports` and
`enable_unprivileged_icmp` in the CRI plugin in
https://github.com/containerd/containerd/pull/9348, but missed including
this change in the release notes.

Signed-off-by: Samuel Karp <samuelkarp@google.com>
2025-03-06 16:38:38 -08:00
Phil Estes
4ed9adb86b Merge pull request #11402 from z63d/docs/add-cri-plugin-config-runtime-path
docs: add CRI Plugin Config runtime_path
2025-03-05 21:19:24 +00:00
Gao Xiang
971915797a erofs-snapshotter: force the use of loop devices for single-layer images
Currently, containerd cannot dynamically select between EROFS block
or file-based mounting approaches based on the specific runtime (or
the Linux kernel version of the runtime) due to its static mount
structure.

For example, the EROFS snapshotter fails on Linux 5.4 (Ubuntu 20.04)
with `bin/nerdctl run --net=host --snapshotter=erofs busybox:latest`:

FATA[0005] failed to mount {Type:erofs Source:/var/lib/containerd/
io.containerd.snapshotter.v1.erofs/snapshots/1/layer.erofs Target:
Options:[ro]} on "/tmp/initialC1374142795": block device required

Temporarily fix this by appending `-oloop` for single-layer images.
The upcoming mount manager will make it better [1].

[1] https://github.com/containerd/containerd/issues/11303
Signed-off-by: Gao Xiang <hsiangkao@linux.alibaba.com>
2025-03-04 17:07:01 +08:00
Gao Xiang
b477cf8e97 erofs-snapshotter: protect layer blobs with FS_IMMUTABLE_FL
As documented in ioctl_iflags(2):
```
 FS_IMMUTABLE_FL
  The file is immutable: no changes are permitted to the file contents
  or metadata (permissions, timestamps, ownership, link count, and so
  on).  (This restriction applies even to the superuser.)
```

For example, any user cannot delete/move layer blobs when
FS_IMMUTABLE_FL is set:
``` sh
 # cd /var/lib/containerd/io.containerd.snapshotter.v1.erofs/snapshots/4
 # mv layer{,1}.erofs
 mv: cannot move 'layer.erofs' to 'layer1.erofs': Operation not permitted
 # rm layer.erofs
 rm: cannot remove 'layer.erofs': Operation not permitted
```

Note that it's a best-effort approach for data loss prevention.  IOWs,
just warn out if FS_IMMUTABLE_FL cannot be set anyway (e.g., due to lack
of support in the underlying filesystem.)

Signed-off-by: Gao Xiang <hsiangkao@linux.alibaba.com>
2025-03-03 20:11:48 +08:00
ChengyuZhu6
f3b6078f90 erofs-snapshotter: add fsverity support
Add fsverity support to erofs snapshotter to enable data integrity
verification for erofs layers:

- Add an config option `EnableFsverity` for erofs snapshotter
- Add fsverity verification during mount operations
- Enable fsverity on erofs layers during commit
- Add documentation for fsverity support in erofs snapshotter.
- Add TestErofsFsverity to verify fsverity enablement and data protection

The feature can be enabled via config.toml, such as:
```toml
[plugins.'io.containerd.snapshotter.v1.erofs']
    root_path = ''
    ovl_mount_options = []
    enable_fsverity = true
```

Signed-off-by: ChengyuZhu6 <hudson@cyzhu.com>
2025-02-25 10:33:26 +08:00
z63d
a1e7457bc4 docs: add CRI Plugin Config runtime_path
Signed-off-by: Kaita Nakamura <kaita.nakamura0830@gmail.com>
2025-02-19 06:16:24 +09:00
Jin Dong
a502b7931b Clarify port handling in hosts toml
Signed-off-by: Jin Dong <djdongjin95@gmail.com>
2025-02-17 16:50:15 +00:00
Gao Xiang
fd4caef786 Add EROFS snapshotter documentation
Signed-off-by: Gao Xiang <hsiangkao@linux.alibaba.com>
2025-01-13 16:31:21 +08:00
Amal Thundiyil
b78c5c6ed2 docs: fix snapshots api import
Signed-off-by: Amal Thundiyil <mail@amalthundiyil.com>
2024-11-28 12:13:07 +01:00
Samuel Karp
6c1b699bf9 docs: update schema 1 deprecation information
* Correctly reference the only schema 1 mediatype containerd supports.
* Document that `--local` is required for `ctr` when pulling schema 1
  images
* Document CRI users more clearly

Fixes https://github.com/containerd/containerd/issues/10998

Signed-off-by: Samuel Karp <samuelkarp@google.com>
2024-11-13 09:34:47 -08:00
Akihiro Suda
bf47b6ebc9 docs/containerd-2.0.md: add more highlights
- CRI support for user namespaces (PR 8803)
- CRI support for recursive read-only mounts (PR 9787)
- CDI is now enabled by default (PR 9621)

Co-authored-by: Samuel Karp <me@samuelkarp.com>
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-11-02 06:27:18 +09:00
Akihiro Suda
f5ce859ee2 docs/containerd-2.0.md: fix the deprecation release of AUFS
AUFS was deprecated in v1.5, not in v1.7.
See PR 5433

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-11-02 06:19:04 +09:00
Samuel Karp
bc819bc97a docs: add command for finding schema 1 images
Signed-off-by: Samuel Karp <samuelkarp@google.com>
2024-10-22 20:44:51 -07:00
Samuel Karp
c86b2772ce docs: update min version for deprecation warnings
While some warnings were available in earlier versions, the first
"complete" implementation was in 1.7.12 and 1.6.27.

https://github.com/containerd/containerd/issues/9312 tracks that initial
set of warnings.

Signed-off-by: Samuel Karp <samuelkarp@google.com>
2024-10-22 15:57:26 -07:00
Austin Vazquez
92d327af17 Update tracing docs for containerd 2.0
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-10-18 14:50:05 +00:00
Akihiro Suda
d4cabf7179 Merge pull request #10852 from austinvazquez/update-nri-doc-for-2.0
Update NRI documentation for containerd 2.0
2024-10-18 12:12:40 +09:00
Austin Vazquez
943b196ad6 Update NRI documentation for containerd 2.0
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-10-17 23:33:04 +00:00
Samuel Karp
a6ceb4be0d containerd 2.0 guide: add image verifier plugins
Signed-off-by: Samuel Karp <samuelkarp@google.com>
2024-10-17 14:10:29 -07:00
Austin Vazquez
249dd74744 Format link text in containerd 2.0 doc for readability
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-10-17 17:11:13 +00:00
Akihiro Suda
3eea3536f1 docs/containerd-2.0.md: mention the removal of cri-containerd-*.tar.gz
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-10-17 19:17:34 +09:00
Austin Vazquez
b724b9f231 Add containerd 2.0 doc
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-10-16 17:53:38 +00:00
Maksym Pavlenko
146a977f92 Move features section to a separate file
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2024-09-26 15:32:16 -07:00
Akihiro Suda
a3d84a1727 docs: update for containerd v2
Fix issue 10132

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2024-08-16 03:09:50 +09:00
Paul Meyer
d036988eec docs/content-flow: fix code fence delimiter
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2024-08-05 12:55:48 +02:00
Avi Deitcher
1a5c711c3c update documentation for content-flow
Signed-off-by: Avi Deitcher <avi@deitcher.net>
2024-07-17 15:29:54 +03:00
bzsuni
22f2af40c0 update pause image to 3.10
Signed-off-by: bzsuni <bingzhe.sun@daocloud.io>
2024-05-25 08:17:46 +08:00
Mike Brown
87bab6cdc7 Merge pull request #10238 from MikeZappa87/feature/provideinternalloup
Add support to set loopback to up
2024-05-20 14:19:43 +00:00
Michael Zappa
332caf1a15 Provide ability to set lo up without CNI
Signed-off-by: Michael Zappa <michael.zappa@gmail.com>
2024-05-17 14:34:55 -06:00
Maksym Pavlenko
90a8667310 Merge pull request #10190 from abel-von/fix-streaming-io-path
fix: modify streaming io url and add docs of sandboxer and io_type
2024-05-16 19:57:27 +00:00
Maksym Pavlenko
4fa8ce9d30 Merge pull request #10075 from ZhangShuaiyi/fix/docs
docs: update registry config guide
2024-05-16 19:42:21 +00:00
Abel Feng
0b113d78d4 doc: add the description of sandboxer and io_type
Signed-off-by: Abel Feng <fshb1988@gmail.com>
2024-05-13 17:42:58 +08:00
Ruihua Wen
fb1f15d304 docs: correct the typo in the documentation
Signed-off-by: Ruihua Wen <spiffyeight77@gmail.com>
2024-05-02 02:04:24 +09:00
Avi Deitcher
e07b63d845 document usage and design of blockfile snapshotter
Signed-off-by: Avi Deitcher <avi@deitcher.net>
2024-04-28 11:44:03 +03:00
Akihiro Suda
9d108fa83b Merge pull request #9894 from profnandaa/docs/fix-windows-instructions-2
fix(docs): fix duplicate instructions for windows installation
2024-04-23 23:54:59 +00:00
Shuaiyi Zhang
c51463010e docs: update registry config guide
Signed-off-by: Shuaiyi Zhang <zhang_syi@qq.com>
2024-04-22 12:01:30 +00:00
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
Anthony Nandaa
c5ef8a2c26 fix(docs): fix duplicate instructions for windows installation
This commit fixes the duplicate copy and configure steps for
the Windows powershell scripts.

fixes #9887

It also adds the architecture as a variable in preparation for
the ARM64 support that is coming.

Signed-off-by: Anthony Nandaa <profnandaa@gmail.com>
2024-02-28 11:21:28 +03: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