SIMPLE SOLUTIONS

CTR(1) - Linux man page online | Administration and privileged commands

Chapter
ctr(8) System Manager's Manual ctr(8) ctr is an unsupported debug and administrative client for interacting with the containerd daemon. Because it is unsupported, the commands, options, and operations are not guaranteed to be backward compatible or stable from release to release of the containerd project. () ()

NAME

ctr

SYNOPSIS

ctr [--address|-a]=[value] [--connect-timeout]=[value] [--debug] [--namespace|-n]=[value] [--timeout]=[value] Usage: ctr [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

GLOBAL OPTIONS

--address, -a="": address for containerd's GRPC server (default: /run/containerd/containerd.sock) --connect-timeout="": timeout for connecting to containerd (default: 0s) --debug: enable debug output in logs --namespace, -n="": namespace to use with commands (default: default) --timeout="": total timeout for ctr commands (default: 0s)

COMMANDS

plugins, plugin provides information about containerd plugins list, ls lists containerd plugins --detailed, -d: print detailed information about each plugin --quiet, -q: print only the plugin ids version print the client and server versions containers, c, container manage containers create create container --allow-new-privs: turn off OCI spec's NoNewPrivileges feature flag --config, -c="": path to the runtime-specific spec config file --cwd="": specify the working directory of the process --device="": add a device to a container --env="": specify additional container environment variables (i.e. FOO=bar) --env-file="": specify additional container environment variables in a file(i.e. FOO=bar, one per line) --gpus="": add gpus to the container (default: 0) --label="": specify additional labels (i.e. foo=bar) --memory-limit="": memory limit (in bytes) for the container (default: 0) --mount="": specify additional container mount (ex: type=bind,src=/tmp,dst=/host,options=rbind:ro) --net-host: enable host networking for the container --no-pivot: disable use of pivot-root (linux only) --pid-file="": file path to write the task's pid --privileged: run privileged container --read-only: set the containers filesystem as readonly --rootfs: use custom rootfs that is not managed by containerd snapshotter --runtime="": runtime name (default: io.containerd.runc.v2) --seccomp: enable the default seccomp profile --snapshotter="": snapshotter name. Empty value stands for the default value. --tty, -t: allocate a TTY for the container --with-ns="": specify existing Linux namespaces to join at container runtime (format '<nstype>:<path>') delete, del, rm delete one or more existing containers --keep-snapshot: do not clean up snapshot with container info get info about a container list, ls list containers --quiet, -q: print only the container id label set and clear labels for a container checkpoint checkpoint a container --image: include the image in the checkpoint --rw: include the rw layer in the checkpoint --task: checkpoint container task restore restore a container from checkpoint --live: restore the runtime and memory data from the checkpoint --rw: restore the rw layer from the checkpoint content manage content active display active transfers --root="": path to content store root (default: /tmp/content) --timeout, -t="": total timeout for fetch (default: 0s) delete, del, remove, rm permanently delete one or more blobs edit edit a blob and return a new digest --editor="": select editor (vim, emacs, etc.) --validate="": validate the result against a format (json, mediatype, etc.) fetch fetch all content for an image into containerd --all-metadata: Pull metadata for all platforms --all-platforms: pull content from all platforms --label="": labels to attach to the image --metadata-only: Pull all metadata including manifests and configs --plain-http: allow connections using plain HTTP --platform="": Pull content from a specific platform --refresh="": refresh token for authorization server --skip-verify, -k: skip SSL certificate validation --user, -u="": user[:password] Registry user and password fetch-object retrieve objects from a remote --plain-http: allow connections using plain HTTP --refresh="": refresh token for authorization server --skip-verify, -k: skip SSL certificate validation --user, -u="": user[:password] Registry user and password get get the data for an object ingest accept content into the store --expected-digest="": verify content against expected digest --expected-size="": validate against provided size (default: 0) list, ls list all blobs in the store --quiet, -q: print only the blob digest push-object push an object to a remote --plain-http: allow connections using plain HTTP --refresh="": refresh token for authorization server --skip-verify, -k: skip SSL certificate validation --user, -u="": user[:password] Registry user and password label add labels to content events, event display containerd events images, image, i manage images check check that an image has all content available locally --snapshotter="": snapshotter name. Empty value stands for the default value. export export images --all-platforms: exports content from all platforms --platform="": Pull content from a specific platform (default: []) --skip-manifest-json: do not add Docker compatible manifest.json to archive import import images --all-platforms: imports content for all platforms, false by default --base-name="": base image name for added images, when provided only images with this name prefix are imported --compress-blobs: compress uncompressed blobs when creating manifest (Docker format only) --digests: whether to create digest images (default: false) --index-name="": image name to keep index as, by default index is discarded --no-unpack: skip unpacking the images, false by default --snapshotter="": snapshotter name. Empty value stands for the default value. list, ls list images known to containerd --quiet, -q: print only the image refs pull pull an image from a remote --all-metadata: Pull metadata for all platforms --all-platforms: pull content and metadata from all platforms --label="": labels to attach to the image --plain-http: allow connections using plain HTTP --platform="": Pull content from a specific platform (default: []) --refresh="": refresh token for authorization server --skip-verify, -k: skip SSL certificate validation --snapshotter="": snapshotter name. Empty value stands for the default value. --user, -u="": user[:password] Registry user and password push push an image to a remote --manifest="": digest of manifest --manifest-type="": media type of manifest digest (default: application/vnd.oci.image.manifest.v1+json) --plain-http: allow connections using plain HTTP --refresh="": refresh token for authorization server --skip-verify, -k: skip SSL certificate validation --user, -u="": user[:password] Registry user and password remove, rm remove one or more images by reference --sync: Synchronously remove image and all associated resources tag tag an image --force: force target_ref to be created, regardless if it already exists label set and clear labels for an image --replace-all, -r: replace all labels leases manage leases list, ls list all active leases --quiet, -q: print only the blob digest create create lease --expires, -x="": expiration of lease (0 value will not expire) (default: 24h0m0s) --id="": set the id for the lease, will be generated by default delete, rm delete a lease --sync: Synchronously remove leases and all unreferenced resources namespaces, namespace, ns manage namespaces create, c create a new namespace list, ls list namespaces --quiet, -q: print only the namespace name remove, rm remove one or more namespaces --cgroup, -c: delete the namespace's cgroup label set and clear labels for a namespace pprof provide golang pprof outputs for containerd --debug-socket, -d="": socket path for containerd's debug server (default: /run/containerd/debug.sock) block goroutine blocking profile goroutines dump goroutine stack dump heap dump heap profile profile CPU profile --seconds, -s="": duration for collection (seconds) (default: 30s) threadcreate goroutine thread creating profile trace collect execution trace --seconds, -s="": trace time (seconds) (default: 5s) run run a container --allow-new-privs: turn off OCI spec's NoNewPrivileges feature flag --cgroup="": cgroup path (To disable use of cgroup, set to "" explicitly) --config, -c="": path to the runtime-specific spec config file --cwd="": specify the working directory of the process --detach, -d: detach from the task after it has started execution --device="": add a device to a container --env="": specify additional container environment variables (i.e. FOO=bar) --env-file="": specify additional container environment variables in a file(i.e. FOO=bar, one per line) --fifo-dir="": directory used for storing IO FIFOs --gpus="": add gpus to the container (default: 0) --label="": specify additional labels (i.e. foo=bar) --log-uri="": log uri --memory-limit="": memory limit (in bytes) for the container (default: 0) --mount="": specify additional container mount (ex: type=bind,src=/tmp,dst=/host,options=rbind:ro) --net-host: enable host networking for the container --no-pivot: disable use of pivot-root (linux only) --null-io: send all IO to /dev/null --pid-file="": file path to write the task's pid --platform="": run image for specific platform --privileged: run privileged container --read-only: set the containers filesystem as readonly --rm: remove the container after running --rootfs: use custom rootfs that is not managed by containerd snapshotter --runtime="": runtime name (default: io.containerd.runc.v2) --seccomp: enable the default seccomp profile --snapshotter="": snapshotter name. Empty value stands for the default value. --tty, -t: allocate a TTY for the container --with-ns="": specify existing Linux namespaces to join at container runtime (format '<nstype>:<path>') snapshots, snapshot manage snapshots --snapshotter="": snapshotter name. Empty value stands for the default value. commit commit an active snapshot into the provided name diff get the diff of two snapshots. the default second snapshot is the first snapshot's parent. --keep: keep diff content. up to creator to delete it. --label="": labels to attach to the image --media-type="": media type to use for creating diff (default: application/vnd.oci.image.layer.v1.tar+gzip) --ref="": content upload reference to use info get info about a snapshot list, ls list snapshots mounts, m, mount mount gets mount commands for the snapshots prepare prepare a snapshot from a committed snapshot --target, -t="": mount target path, will print mount, if provided remove, rm remove snapshots label add labels to content tree display tree view of snapshot branches unpack unpack applies layers from a manifest to a snapshot --snapshotter="": snapshotter name. Empty value stands for the default value. usage usage snapshots -b: display size in bytes view create a read-only snapshot from a committed snapshot --target, -t="": mount target path, will print mount, if provided tasks, t, task manage tasks attach attach to the IO of a running container checkpoint checkpoint a container --exit: stop the container after the checkpoint --image-path="": path to criu image files --work-path="": path to criu work files and logs delete, rm delete one or more tasks --exec-id="": process ID to kill --force, -f: force delete task process exec execute additional processes in an existing container --cwd="": working directory of the new process --detach, -d: detach from the task after it has started execution --exec-id="": exec specific id for the process --fifo-dir="": directory used for storing IO FIFOs --log-uri="": log uri for custom shim logging --tty, -t: allocate a TTY for the container list, ls list tasks --quiet, -q: print only the task id kill signal a container (default: SIGTERM) --all, -a: send signal to all processes inside the container --exec-id="": process ID to kill --signal, -s="": signal to send to the container pause pause an existing container ps list processes for container resume resume a paused container start start a container that have been created --detach, -d: detach from the task after it has started execution --fifo-dir="": directory used for storing IO FIFOs --log-uri="": log uri --null-io: send all IO to /dev/null --pid-file="": file path to write the task's pid metrics, metric get a single data point of metrics for a task with the built-in Linux runtime --format="": "table" or "json" (default: table) install install a new package --libs, -l: install libs from the image --path="": set an optional install path other than the managed opt directory --replace, -r: replace any binaries or libs in the opt directory shim interact with a shim directly --id="": container id delete delete a container with a task exec exec a new process in the task's container --attach, -a: stay attached to the container and open the fifos --cwd="": current working directory --env, -e="": add environment vars (default: []) --spec="": runtime spec --stderr="": specify the path to the stderr fifo --stdin="": specify the path to the stdin fifo --stdout="": specify the path to the stdout fifo --tty, -t: enable tty support start start a container with a task state get the state of all the processes of the task
()
This manual Reference Other manuals
ctr(1) referred by containerd-config(1) | containerd-config.toml(5)
refer to
Download raw manual
Main page System Manager's Manual (+2060) № 8 (+5755)
Go top