Skip to content

Commit 9c3cca2

Browse files
committed
docs: clarify availability of optional features
Signed-off-by: Akihiro Suda <[email protected]>
1 parent 57b2e04 commit 9c3cca2

File tree

8 files changed

+25
-1
lines changed

8 files changed

+25
-1
lines changed

Diff for: docs/build.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ This limitation can be avoided using containerd worker as mentioned later.
3333

3434
## Setting up BuildKit with containerd worker
3535

36-
### Rootless (requires BuildKit v0.10.0 or later)
36+
### Rootless
37+
38+
| :zap: Requirement | nerdctl >= 0.18, BuildKit >= 0.10 |
39+
|-------------------|-----------------------------------|
3740

3841
```
3942
$ CONTAINERD_NAMESPACE=default containerd-rootless-setuptool.sh install-buildkit-containerd

Diff for: docs/compose.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# nerdctl compose
22

3+
| :zap: Requirement | nerdctl >= 0.8 |
4+
|-------------------|----------------|
5+
36
## Usage
47

58
The `nerdctl compose` CLI is designed to be compatible with `docker-compose`.

Diff for: docs/cosign.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Container Image Sign and Verify with cosign tool
22

3+
| :zap: Requirement | nerdctl >= 0.15 |
4+
|-------------------|-----------------|
5+
36
[cosign](https://github.com/sigstore/cosign) is tool that allows you to sign and verify container images with the
47
public/private key pairs or without them by providing
58
a [Keyless support](https://github.com/sigstore/cosign/blob/main/KEYLESS.md).

Diff for: docs/gpu.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Using GPUs inside containers
22

3+
| :zap: Requirement | nerdctl >= 0.9 |
4+
|-------------------|----------------|
5+
36
nerdctl provides docker-compatible NVIDIA GPU support.
47

58
## Prerequisites

Diff for: docs/ipfs.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Distribute Container Images on IPFS (Experimental)
22

3+
| :zap: Requirement | nerdctl >= 0.14 |
4+
|-------------------|-----------------|
5+
36
You can distribute container images without registries, using IPFS.
47

58
IPFS support is completely optional. Your host is NOT connected to any P2P network, unless you opt in to [install and run IPFS daemon](https://docs.ipfs.io/install/).

Diff for: docs/multi-platform.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Multi-platform
22

3+
| :zap: Requirement | nerdctl >= 0.13 |
4+
|-------------------|-----------------|
5+
36
nerdctl can execute non-native container images using QEMU.
47
e.g., ARM on Intel, and vice versa.
58

Diff for: docs/ocicrypt.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# OCIcrypt
22

3+
| :zap: Requirement | nerdctl >= 0.7 |
4+
|-------------------|----------------|
5+
36
nerdctl supports encryption and decryption using [OCIcrypt](https://github.com/containers/ocicrypt)
47
(aka [imgcrypt](https://github.com/containerd/imgcrypt) for containerd).
58

Diff for: docs/stargz.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Lazy-pulling using Stargz Snapshotter
22

3+
| :zap: Requirement | nerdctl >= 0.0.1 |
4+
|-------------------|------------------|
5+
36
Lazy-pulling is a technique to running containers before completion of pulling the images.
47

58
See https://github.com/containerd/stargz-snapshotter to learn further information.

0 commit comments

Comments
 (0)