Current Path :
/
usr
/
share
/
man
/
man8
/
Or
Select Your Path :
Upload File :
New :
File
Dir
//usr/share/man/man8/ctr.8
.nh .TH ctr 8 .SH NAME ctr .SH SYNOPSIS ctr .EX [--address|-a]=[value] [--connect-timeout]=[value] [--debug] [--namespace|-n]=[value] [--timeout]=[value] .EE .SH DESCRIPTION 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. .PP \fBUsage\fP: .EX ctr [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] .EE .SH GLOBAL OPTIONS \fB--address, -a\fP="": Address for containerd's GRPC server (default: "/run/containerd/containerd.sock") .PP \fB--connect-timeout\fP="": Timeout for connecting to containerd (default: 0s) .PP \fB--debug\fP: Enable debug output in logs .PP \fB--namespace, -n\fP="": Namespace to use with commands (default: "default") .PP \fB--timeout\fP="": Total timeout for ctr commands (default: 0s) .SH COMMANDS .SH plugins, plugin Provides information about containerd plugins .SS list, ls Lists containerd plugins .PP \fB--detailed, -d\fP: Print detailed information about each plugin .PP \fB--quiet, -q\fP: Print only the plugin ids .SS inspect-runtime Display runtime info .PP \fB--runc-binary\fP="": Specify runc-compatible binary .PP \fB--runc-root\fP="": Specify runc-compatible root .PP \fB--runc-systemd-cgroup\fP: Start runc with systemd cgroup manager .PP \fB--runtime\fP="": Runtime name or absolute path to runtime binary (default: "io.containerd.runc.v2") .PP \fB--runtime-config-path\fP="": Optional runtime config path .SH version Print the client and server versions .SH containers, c, container Manage containers .SS create Create container .PP \fB--allow-new-privs\fP: Turn off OCI spec's NoNewPrivileges feature flag .PP \fB--annotation\fP="": Specify additional OCI annotations (e.g. foo=bar) .PP \fB--apparmor-default-profile\fP="": Enable AppArmor with the default profile with the specified name, e.g. "cri-containerd.apparmor.d" .PP \fB--apparmor-profile\fP="": Enable AppArmor with an existing custom profile .PP \fB--blockio-class\fP="": Name of the blockio class to associate the container with .PP \fB--blockio-config-file\fP="": File path to blockio class definitions. By default class definitions are not loaded. .PP \fB--cap-add\fP="": Add Linux capabilities (Set capabilities with 'CAP_' prefix) .PP \fB--cap-drop\fP="": Drop Linux capabilities (Set capabilities with 'CAP_' prefix) .PP \fB--config, -c\fP="": Path to the runtime-specific spec config file .PP \fB--cpu-period\fP="": Limit CPU CFS period (default: 0) .PP \fB--cpu-quota\fP="": Limit CPU CFS quota (default: -1) .PP \fB--cwd\fP="": Specify the working directory of the process .PP \fB--device\fP="": File path to a device to add to the container; or a path to a directory tree of devices to add to the container .PP \fB--env\fP="": Specify additional container environment variables (e.g. FOO=bar) .PP \fB--env-file\fP="": Specify additional container environment variables in a file(e.g. FOO=bar, one per line) .PP \fB--gpus\fP="": Add gpus to the container .PP \fB--hostname\fP="": Set the container's host name .PP \fB--label\fP="": Specify additional labels (e.g. foo=bar) .PP \fB--memory-limit\fP="": Memory limit (in bytes) for the container (default: 0) .PP \fB--mount\fP="": Specify additional container mount (e.g. type=bind,src=/tmp,dst=/host,options=rbind:ro) .PP \fB--net-host\fP: Enable host networking for the container .PP \fB--no-pivot\fP: Disable use of pivot-root (linux only) .PP \fB--pid-file\fP="": File path to write the task's pid .PP \fB--privileged\fP: Run privileged container .PP \fB--rdt-class\fP="": Name of the RDT class to associate the container with. Specifies a Class of Service (CLOS) for cache and memory bandwidth management. .PP \fB--read-only\fP: Set the containers filesystem as readonly .PP \fB--rootfs\fP: Use custom rootfs that is not managed by containerd snapshotter .PP \fB--rootfs-propagation\fP="": Set the propagation of the container rootfs .PP \fB--runc-binary\fP="": Specify runc-compatible binary .PP \fB--runc-root\fP="": Specify runc-compatible root .PP \fB--runc-systemd-cgroup\fP: Start runc with systemd cgroup manager .PP \fB--runtime\fP="": Runtime name or absolute path to runtime binary (default: "io.containerd.runc.v2") .PP \fB--runtime-config-path\fP="": Optional runtime config path .PP \fB--sandbox\fP="": Create the container in the given sandbox .PP \fB--seccomp\fP: Enable the default seccomp profile .PP \fB--seccomp-profile\fP="": File path to custom seccomp profile. seccomp must be set to true, before using seccomp-profile .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--snapshotter-label\fP="": Labels added to the new snapshot for this container. .PP \fB--tty, -t\fP: Allocate a TTY for the container .PP \fB--user, -u\fP="": Username or user id, group optional (format: [:]) .PP \fB--with-ns\fP="": Specify existing Linux namespaces to join at container runtime (format ':\&') .SS delete, del, remove, rm Delete one or more existing containers .PP \fB--keep-snapshot\fP: Do not clean up snapshot with container .SS info Get info about a container .PP \fB--spec\fP: Only display the spec .SS list, ls List containers .PP \fB--quiet, -q\fP: Print only the container id .SS label Set and clear labels for a container .SS checkpoint Checkpoint a container .PP \fB--image\fP: Include the image in the checkpoint .PP \fB--rw\fP: Include the rw layer in the checkpoint .PP \fB--task\fP: Checkpoint container task .SS restore Restore a container from checkpoint .PP \fB--live\fP: Restore the runtime and memory data from the checkpoint .PP \fB--rw\fP: Restore the rw layer from the checkpoint .SH content Manage content .SS active Display active transfers .PP \fB--root\fP="": Path to content store root (default: "/tmp/content") .PP \fB--timeout, -t\fP="": Total timeout for fetch (default: 0s) .SS delete, del, remove, rm Permanently delete one or more blobs .SS edit Edit a blob and return a new digest .PP \fB--editor\fP="": Select editor (vim, emacs, etc.) .PP \fB--validate\fP="": Validate the result against a format (json, mediatype, etc.) .SS fetch Fetch all content for an image into containerd .PP \fB--all-platforms\fP: Pull content from all platforms .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--label\fP="": Labels to attach to the image .PP \fB--metadata-only\fP: Pull all metadata including manifests and configs .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--platform\fP="": Pull content from a specific platform .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--skip-metadata\fP: Skips metadata for unused platforms (Image may be unable to be pushed without metadata) .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS fetch-object Retrieve objects from a remote .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS fetch-blob Retrieve blobs from a remote .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--media-type\fP="": Specify target mediatype for request header .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS get Get the data for an object .SS ingest Accept content into the store .PP \fB--expected-digest\fP="": Verify content against expected digest .PP \fB--expected-size\fP="": Validate against provided size (default: 0) .SS list, ls List all blobs in the store .PP \fB--quiet, -q\fP: Print only the blob digest .SS push-object Push an object to a remote .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS label Add labels to content .SS prune Prunes content from the content store .SS references Prunes preference labels from the content store (layers only by default) .PP \fB--async\fP: Allow garbage collection to cleanup asynchronously .PP \fB--dry\fP: Just show updates without applying (enables debug logging) .SH events, event Display containerd events .SH images, image, i Manage images .SS check Check existing images to ensure all content is available locally .PP \fB--quiet, -q\fP: Print only the ready image refs (fully downloaded and unpacked) .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .SS export Export images .PP \fB--all-platforms\fP: Exports content from all platforms .PP \fB--local\fP: Run export locally rather than through transfer API .PP \fB--platform\fP="": Pull content from a specific platform .PP \fB--skip-manifest-json\fP: Do not add Docker compatible manifest.json to archive .PP \fB--skip-non-distributable\fP: Do not add non-distributable blobs such as Windows layers to archive .SS import Import images .PP \fB--all-platforms\fP: Imports content for all platforms, false by default .PP \fB--base-name\fP="": Base image name for added images, when provided only images with this name prefix are imported .PP \fB--compress-blobs\fP: Compress uncompressed blobs when creating manifest (Docker format only) .PP \fB--digests\fP: Whether to create digest images (default: false) .PP \fB--discard-unpacked-layers\fP: Allow the garbage collector to clean layers up from the content store after unpacking, cannot be used with --no-unpack, false by default .PP \fB--index-name\fP="": Image name to keep index as, by default index is discarded .PP \fB--label\fP="": Labels to attach to the image .PP \fB--local\fP: Run import locally rather than through transfer API .PP \fB--no-unpack\fP: Skip unpacking the images, cannot be used with --discard-unpacked-layers, false by default .PP \fB--platform\fP="": Imports content for specific platform .PP \fB--skip-digest-for-named\fP: Skip applying --digests option to images named in the importing tar (use it in conjunction with --digests) .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--sync-fs\fP: Synchronize the underlying filesystem containing files when unpack images, false by default .SS inspect, i inspect an image .PP \fB--content\fP: Show JSON content .SS list, ls List images known to containerd .PP \fB--quiet, -q\fP: Print only the image refs .SS mount Mount an image to a target path .PP \fB--expiration, -x\fP="": Set the expiration time for the mount and snapshots (default: 1h0m0s) .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--label\fP="": Labels to attach to the image .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--platform\fP="": Mount the image for the specified platform (default: "linux/amd64") .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--rw\fP: Enable write support on the mount .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--sync-fs\fP: Synchronize the underlying filesystem containing files when unpack images, false by default .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS unmount Unmount the image from the target .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--label\fP="": Labels to attach to the image .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--rm\fP: Remove the snapshot after a successful unmount .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS pull Pull an image from a remote .PP \fB--all-platforms\fP: Pull content and metadata from all platforms .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--label\fP="": Labels to attach to the image .PP \fB--local\fP: Fetch content from local client rather than using transfer service .PP \fB--max-concurrent-downloads\fP="": Set the max concurrent downloads for each pull (default: 0) .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--platform\fP="": Pull content from a specific platform .PP \fB--print-chainid\fP: Print the resulting image's chain ID .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--skip-metadata\fP: Skips metadata for unused platforms (Image may be unable to be pushed without metadata) .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--sync-fs\fP: Synchronize the underlying filesystem containing files when unpack images, false by default .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS push Push an image to a remote .PP \fB--allow-non-distributable-blobs\fP: Allow pushing blobs that are marked as non-distributable .PP \fB--hosts-dir\fP="": Custom hosts configuration directory .PP \fB--http-dump\fP: Dump all HTTP request/responses when interacting with container registry .PP \fB--http-trace\fP: Enable HTTP tracing for registry interactions .PP \fB--local\fP: Push content from local client rather than using transfer service .PP \fB--manifest\fP="": Digest of manifest .PP \fB--manifest-type\fP="": Media type of manifest digest (default: "application/vnd.oci.image.manifest.v1+json") .PP \fB--max-concurrent-uploaded-layers\fP="": Set the max concurrent uploaded layers for each push (default: 0) .PP \fB--plain-http\fP: Allow connections using plain HTTP .PP \fB--platform\fP="": Push content from a specific platform .PP \fB--refresh\fP="": Refresh token for authorization server .PP \fB--skip-verify, -k\fP: Skip SSL certificate validation .PP \fB--tlscacert\fP="": Path to TLS root CA .PP \fB--tlscert\fP="": Path to TLS client certificate .PP \fB--tlskey\fP="": Path to TLS client key .PP \fB--user, -u\fP="": User[:password] Registry user and password .SS prune Remove unused images .PP \fB--all\fP: Remove all unused images, not just dangling ones (if all is not specified no images will be pruned) .SS delete, del, remove, rm Remove one or more images by reference .PP \fB--sync\fP: Synchronously remove image and all associated resources .SS tag Tag an image .PP \fB--force\fP: Force target_ref to be created, regardless if it already exists .PP \fB--local\fP: Run tag locally rather than through transfer API .PP \fB--skip-reference-check\fP: Skip the strict check for reference names .SS label Set and clear labels for an image .PP \fB--replace-all, -r\fP: Replace all labels .SS convert Convert an image .PP \fB--all-platforms\fP: Exports content from all platforms .PP \fB--oci\fP: Convert Docker media types to OCI media types .PP \fB--platform\fP="": Pull content from a specific platform .PP \fB--uncompress\fP: Convert tar.gz layers to uncompressed tar layers .SS usage Display usage of snapshots for a given image ref .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .SH leases Manage leases .SS list, ls List all active leases .PP \fB--quiet, -q\fP: Print only the blob digest .SS create Create lease .PP \fB--expires, -x\fP="": Expiration of lease (0 value will not expire) (default: 24h0m0s) .PP \fB--id\fP="": Set the id for the lease, will be generated by default .SS delete, del, remove, rm Delete a lease .PP \fB--sync\fP: Synchronously remove leases and all unreferenced resources .SH namespaces, namespace, ns Manage namespaces .SS create, c Create a new namespace .SS list, ls List namespaces .PP \fB--quiet, -q\fP: Print only the namespace name .SS remove, rm Remove one or more namespaces .PP \fB--cgroup, -c\fP: Delete the namespace's cgroup .SS label Set and clear labels for a namespace .SH pprof Provide golang pprof outputs for containerd .PP \fB--debug-socket, -d\fP="": Socket path for containerd's debug server (default: "/run/containerd/debug.sock") .SS block Goroutine blocking profile .PP \fB--debug\fP="": Debug pprof args (default: 0) .SS goroutines Dump goroutine stack dump .PP \fB--debug\fP="": Debug pprof args (default: 2) .SS heap Dump heap profile .PP \fB--debug\fP="": Debug pprof args (default: 0) .SS profile CPU profile .PP \fB--debug\fP="": Debug pprof args (default: 0) .PP \fB--seconds, -s\fP="": Duration for collection (seconds) (default: 30s) .SS threadcreate Goroutine thread creating profile .PP \fB--debug\fP="": Debug pprof args (default: 0) .SS trace Collect execution trace .PP \fB--debug\fP="": Debug pprof args (default: 0) .PP \fB--seconds, -s\fP="": Trace time (seconds) (default: 5s) .SH run Run a container .PP \fB--allow-new-privs\fP: Turn off OCI spec's NoNewPrivileges feature flag .PP \fB--annotation\fP="": Specify additional OCI annotations (e.g. foo=bar) .PP \fB--apparmor-default-profile\fP="": Enable AppArmor with the default profile with the specified name, e.g. "cri-containerd.apparmor.d" .PP \fB--apparmor-profile\fP="": Enable AppArmor with an existing custom profile .PP \fB--blockio-class\fP="": Name of the blockio class to associate the container with .PP \fB--blockio-config-file\fP="": File path to blockio class definitions. By default class definitions are not loaded. .PP \fB--cap-add\fP="": Add Linux capabilities (Set capabilities with 'CAP_' prefix) .PP \fB--cap-drop\fP="": Drop Linux capabilities (Set capabilities with 'CAP_' prefix) .PP \fB--cgroup\fP="": Cgroup path (To disable use of cgroup, set to "" explicitly) .PP \fB--cni\fP: Enable cni networking for the container .PP \fB--config, -c\fP="": Path to the runtime-specific spec config file .PP \fB--cpu-period\fP="": Limit CPU CFS period (default: 0) .PP \fB--cpu-quota\fP="": Limit CPU CFS quota (default: -1) .PP \fB--cpu-shares\fP="": Set the cpu shares (default: 1024) .PP \fB--cpus\fP="": Set the CFS cpu quota (default: 0) .PP \fB--cpuset-cpus\fP="": Set the CPUs the container will run in (e.g., 1-2,4) .PP \fB--cpuset-mems\fP="": Set the memory nodes the container will run in (e.g., 1-2,4) .PP \fB--cwd\fP="": Specify the working directory of the process .PP \fB--detach, -d\fP: Detach from the task after it has started execution, cannot be used with --rm .PP \fB--device\fP="": File path to a device to add to the container; or a path to a directory tree of devices to add to the container .PP \fB--env\fP="": Specify additional container environment variables (e.g. FOO=bar) .PP \fB--env-file\fP="": Specify additional container environment variables in a file(e.g. FOO=bar, one per line) .PP \fB--fifo-dir\fP="": Directory used for storing IO FIFOs .PP \fB--gidmap\fP="": Run inside a user namespace with the specified GID mapping ranges; specified with the format \fBcontainer-gid:host-gid:length\fR .PP \fB--gpus\fP="": Add gpus to the container .PP \fB--hostname\fP="": Set the container's host name .PP \fB--label\fP="": Specify additional labels (e.g. foo=bar) .PP \fB--log-uri\fP="": Log uri .PP \fB--memory-limit\fP="": Memory limit (in bytes) for the container (default: 0) .PP \fB--mount\fP="": Specify additional container mount (e.g. type=bind,src=/tmp,dst=/host,options=rbind:ro) .PP \fB--net-host\fP: Enable host networking for the container .PP \fB--no-pivot\fP: Disable use of pivot-root (linux only) .PP \fB--null-io\fP: Send all IO to /dev/null .PP \fB--pid-file\fP="": File path to write the task's pid .PP \fB--platform\fP="": Run image for specific platform .PP \fB--privileged\fP: Run privileged container .PP \fB--privileged-without-host-devices\fP: Don't pass all host devices to privileged container .PP \fB--rdt-class\fP="": Name of the RDT class to associate the container with. Specifies a Class of Service (CLOS) for cache and memory bandwidth management. .PP \fB--read-only\fP: Set the containers filesystem as readonly .PP \fB--remap-labels\fP: Provide the user namespace ID remapping to the snapshotter via label options; requires snapshotter support .PP \fB--rm\fP: Remove the container after running, cannot be used with --detach .PP \fB--rootfs\fP: Use custom rootfs that is not managed by containerd snapshotter .PP \fB--rootfs-propagation\fP="": Set the propagation of the container rootfs .PP \fB--runc-binary\fP="": Specify runc-compatible binary .PP \fB--runc-root\fP="": Specify runc-compatible root .PP \fB--runc-systemd-cgroup\fP: Start runc with systemd cgroup manager .PP \fB--runtime\fP="": Runtime name or absolute path to runtime binary (default: "io.containerd.runc.v2") .PP \fB--runtime-config-path\fP="": Optional runtime config path .PP \fB--sandbox\fP="": Create the container in the given sandbox .PP \fB--seccomp\fP: Enable the default seccomp profile .PP \fB--seccomp-profile\fP="": File path to custom seccomp profile. seccomp must be set to true, before using seccomp-profile .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--snapshotter-label\fP="": Labels added to the new snapshot for this container. .PP \fB--sync-fs\fP: Synchronize the underlying filesystem containing files when unpack images, false by default .PP \fB--tty, -t\fP: Allocate a TTY for the container .PP \fB--uidmap\fP="": Run inside a user namespace with the specified UID mapping ranges; specified with the format \fBcontainer-uid:host-uid:length\fR .PP \fB--user, -u\fP="": Username or user id, group optional (format: [:]) .PP \fB--with-ns\fP="": Specify existing Linux namespaces to join at container runtime (format ':\&') .SH snapshots, snapshot Manage snapshots .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .SS commit Commit an active snapshot into the provided name .SS diff Get the diff of two snapshots. the default second snapshot is the first snapshot's parent. .PP \fB--keep\fP: Keep diff content. up to creator to delete it. .PP \fB--label\fP="": Labels to attach to the image .PP \fB--media-type\fP="": Media type to use for creating diff (default: "application/vnd.oci.image.layer.v1.tar+gzip") .PP \fB--ref\fP="": Content upload reference to use .SS info Get info about a snapshot .SS list, ls List snapshots .SS mounts, m, mount Mount gets mount commands for the snapshots .PP \fB--temp\fP: Mounts the snapshot mounts as a temp mount and returns a bind mount .SS prepare Prepare a snapshot from a committed snapshot .PP \fB--mounts\fP: Print out snapshot mounts as JSON .PP \fB--target, -t\fP="": Mount target path, will print mount, if provided .SS delete, del, remove, rm Remove snapshots .SS label Add labels to content .SS tree Display tree view of snapshot branches .SS unpack Unpack applies layers from a manifest to a snapshot .PP \fB--snapshotter\fP="": Snapshotter name. Empty value stands for the default value. .PP \fB--sync-fs\fP: Synchronize the underlying filesystem containing files when unpack images, false by default .SS usage Usage snapshots .PP \fB-b\fP: Display size in bytes .SS view Create a read-only snapshot from a committed snapshot .PP \fB--mounts\fP: Print out snapshot mounts as JSON .PP \fB--target, -t\fP="": Mount target path, will print mount, if provided .SH tasks, t, task Manage tasks .SS attach Attach to the IO of a running container .SS checkpoint Checkpoint a container .PP \fB--exit\fP: Stop the container after the checkpoint .PP \fB--image-path\fP="": Path to criu image files .PP \fB--work-path\fP="": Path to criu work files and logs .SS delete, del, remove, rm Delete one or more tasks .PP \fB--exec-id\fP="": Process ID to kill .PP \fB--force, -f\fP: Force delete task process .SS exec Execute additional processes in an existing container .PP \fB--cwd\fP="": Working directory of the new process .PP \fB--detach, -d\fP: Detach from the task after it has started execution .PP \fB--exec-id\fP="": Exec specific id for the process .PP \fB--fifo-dir\fP="": Directory used for storing IO FIFOs .PP \fB--log-uri\fP="": Log uri for custom shim logging .PP \fB--tty, -t\fP: Allocate a TTY for the container .PP \fB--user\fP="": User id or name .SS list, ls List tasks .PP \fB--quiet, -q\fP: Print only the task id .SS kill Signal a container (default: SIGTERM) .PP \fB--all, -a\fP: Send signal to all processes inside the container .PP \fB--exec-id\fP="": Process ID to kill .PP \fB--signal, -s\fP="": Signal to send to the container .SS metrics, metric Get a single data point of metrics for a task with the built-in Linux runtime .PP \fB--format\fP="": "table" or "json" (default: "table") .SS pause Pause an existing container .SS ps List processes for container .SS resume Resume a paused container .SS start Start a container that has been created .PP \fB--detach, -d\fP: Detach from the task after it has started execution .PP \fB--fifo-dir\fP="": Directory used for storing IO FIFOs .PP \fB--log-uri\fP="": Log uri .PP \fB--no-pivot\fP: Disable use of pivot-root (linux only) .PP \fB--null-io\fP: Send all IO to /dev/null .PP \fB--pid-file\fP="": File path to write the task's pid .SH install Install a new package .PP \fB--libs, -l\fP: Install libs from the image .PP \fB--path\fP="": Set an optional install path other than the managed opt directory .PP \fB--replace, -r\fP: Replace any binaries or libs in the opt directory .SH oci OCI tools .SS spec See the output of the default OCI spec .PP \fB--platform\fP="": Platform of the spec to print (Examples: 'linux/arm64', 'windows/amd64') .SH sandboxes, sandbox, sb, s Manage sandboxes .SS run, create, c, r Run a new sandbox .PP \fB--runtime\fP="": Runtime name (default: "io.containerd.runc.v2") .SS list, ls List sandboxes .PP \fB--filters\fP="": The list of filters to apply when querying sandboxes from the store .SS remove, rm Remove sandboxes .PP \fB--force, -f\fP: Ignore shutdown errors when removing sandbox .SS info, i Get info about a sandbox .SH info Print the server info .SH deprecations .SS list Print warnings for deprecations .PP \fB--format\fP="": output format to use (Examples: 'default', 'json') .SH shim Interact with a shim directly .PP \fB--id\fP="": shim ID .PP \fB--shim-address\fP="": shim address (default: computed from shim ID) .SS delete Delete a container with a task .SS exec Exec a new process in the task's container .PP \fB--attach, -a\fP: Stay attached to the container and open the fifos .PP \fB--cwd\fP="": Current working directory .PP \fB--env, -e\fP="": Add environment vars .PP \fB--spec\fP="": Runtime spec .PP \fB--stderr\fP="": Specify the path to the stderr fifo .PP \fB--stdin\fP="": Specify the path to the stdin fifo .PP \fB--stdout\fP="": Specify the path to the stdout fifo .PP \fB--tty, -t\fP: Enable tty support .SS start Start a container with a task .SS state Get the state of all main process of the task .PP \fB--api-version\fP="": shim API version {2,3} (default: 3) .PP \fB--task-id, -t\fP="": task ID .SS shutdown Shutdown shim if there is no active container .PP \fB--api-version\fP="": shim API version {2,3} (default: 3) .SS pprof Provide golang pprof outputs for containerd-shim .SS block Goroutine blocking profile .PP \fB--debug\fP="": Output format, value = 0: binary, value > 0: plaintext (default: 0) .SS goroutines Print goroutine stack dump .PP \fB--debug\fP="": Output format, value = 0: binary, value > 0: plaintext (default: 2) .SS heap Dump heap profile .PP \fB--debug\fP="": Output format, value = 0: binary, value > 0: plaintext (default: 0) .SS profile CPU profile .PP \fB--debug\fP="": Output format, value = 0: binary, value > 0: plaintext (default: 0) .PP \fB--seconds, -s\fP="": Duration for collection (seconds) (default: 30s) .SS threadcreate Goroutine thread creating profile .PP \fB--debug\fP="": Output format, value = 0: binary, value > 0: plaintext (default: 0) .SS trace Collect execution trace .PP \fB--debug\fP="": Output format, value = 0: binary, value > 0: plaintext (default: 0) .PP \fB--seconds, -s\fP="": Trace time (seconds) (default: 5s)
