Skip to content

README.md

Latest commit

 

History

History
60 lines (43 loc) · 2.05 KB

README.md

File metadata and controls

60 lines (43 loc) · 2.05 KB

nerdctl containerd control CLI and CNI plugins (nerdctl)

Installs nerdctl and CNI plugins from upstream.

Example Usage

"features": {
    "ghcr.io/thediveo/devcontainer-features/nerdctl:0": {}
}

Options

Options Id Description Type Default Value
version version of nerdctl to install string latest
cni additionally install CNI plugins from nerdctl-full boolean true
cni-path path to install CNI plugin binaries into string /usr/libexec/cni
containerd-api path to containerd API endpoint string unix:///run/containerd/containerd.sock

Combining with docker-in-docker Feature

Please note that the docker-in-docker feature is only available for Debian/Docker-based base images.

In order to use nerdctl with the containerd included in the docker-in-docker feature, you need to explicitly configure the non-standard API endpoint URL for containerd as follows:

    "features": {
        "ghcr.io/devcontainers/features/docker-in-docker:2": {
            "dockerDashComposeVersion": "none",
            "installDockerBuildx": false
        },
        "ghcr.io/devcontainers/features/nerdctl:0": {
            "containerd-api": "unix:///run/docker/containerd/containerd.sock"
        }
    }

OS Support

Tested with:

Acknowledgement

@containerd/nerdctl

Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.