diff options
Diffstat (limited to 'docs')
33 files changed, 2115 insertions, 0 deletions
diff --git a/docs/crio.8.md b/docs/crio.8.md new file mode 100644 index 000000000..2c9d4857d --- /dev/null +++ b/docs/crio.8.md @@ -0,0 +1,177 @@ +% crio(8) Open Container Initiative Daemon +% Dan Walsh +% SEPTEMBER 2016 +# NAME +crio - OCI Kubernetes Container Runtime daemon + +# SYNOPSIS +**crio** +[**--apparmor-profile**=[*value*]] +[**--cgroup-manager**=[*value*]] +[**--cni-config-dir**=[*value*]] +[**--cni-plugin-dir**=[*value*]] +[**--config**=[*value*]] +[**--conmon**=[*value*]] +[**--cpu-profile**=[*value*]] +[**--default-transport**=[*value*]] +[**--help**|**-h**] +[**--insecure-registry**=[*value*]] +[**--listen**=[*value*]] +[**--log**=[*value*]] +[**--log-format value**] +[**--log-level value**] +[**--pause-command**=[*value*]] +[**--pause-image**=[*value*]] +[**--registry**=[*value*]] +[**--root**=[*value*]] +[**--runroot**=[*value*]] +[**--runtime**=[*value*]] +[**--seccomp-profile**=[*value*]] +[**--selinux**] +[**--signature-policy**=[*value*]] +[**--storage-driver**=[*value*]] +[**--storage-opt**=[*value*]] +[**--version**|**-v**] + +# DESCRIPTION +OCI-based implementation of Kubernetes Container Runtime Interface Daemon + +crio is meant to provide an integration path between OCI conformant runtimes and the kubelet. Specifically, it implements the Kubelet Container Runtime Interface (CRI) using OCI conformant runtimes. The scope of crio is tied to the scope of the CRI. + + * Support multiple image formats including the existing Docker image format + * Support for multiple means to download images including trust & image verification + * Container image management (managing image layers, overlay filesystems, etc) + * Container process lifecycle management + * Monitoring and logging required to satisfy the CRI + * Resource isolation as required by the CRI + +**crio [GLOBAL OPTIONS]** + +**crio [GLOBAL OPTIONS] config [OPTIONS]** + +# GLOBAL OPTIONS + +**--apparmor_profile**="" + Name of the apparmor profile to be used as the runtime's default (default: "crio-default") + +**--cgroup-manager**="" + cgroup manager (cgroupfs or systemd) + +**--config**="" + path to configuration file + +**--conmon**="" + path to the conmon executable (default: "/usr/local/libexec/crio/conmon") + +**--cpu-profile**="" +set the CPU profile file path + +**--default-transport** + A prefix to prepend to image names that can't be pulled as-is. + +**--help, -h** + Print usage statement + +**--insecure-registry=** + Enable insecure registry communication, i.e., enable un-encrypted + and/or untrusted communication. + + List of insecure registries can contain an element with CIDR notation + to specify a whole subnet. Insecure registries accept HTTP and/or + accept HTTPS with certificates from unknown CAs. + + Enabling --insecure-registry is useful when running a local registry. + However, because its use creates security vulnerabilities it should + ONLY be enabled for testing purposes. For increased security, users + should add their CA to their system's list of trusted CAs instead of + using --insecure-registry. + +**--image-volumes**="" + Image volume handling ('mkdir', 'bind' or 'ignore') (default: "mkdir") + mkdir: A directory is created inside the container root filesystem for the volumes. + bind: A directory is created inside container state directory and bind mounted into + the container for the volumes. + ignore: All volumes are just ignored and no action is taken. + +**--listen**="" + Path to CRI-O socket (default: "/var/run/crio.sock") + +**--log**="" + Set the log file path where internal debug information is written + +**--log-format**="" + Set the format used by logs ('text' (default), or 'json') (default: "text") + +**--log-level**="" + log crio messages above specified level: debug, info (default), warn, error, fatal or panic + +**--log-size-max**="" + Maximum log size in bytes for a container (default: -1 (no limit)). + If it is positive, it must be >= 8192 (to match/exceed conmon read buffer). + +**--pause-command**="" + Path to the pause executable in the pause image (default: "/pause") + +**--pause-image**="" + Image which contains the pause executable (default: "kubernetes/pause") + +**--pids-limit**="" + Maximum number of processes allowed in a container (default: 1024) + +**--root**="" + The crio root dir (default: "/var/lib/containers/storage") + +**--registry**="" + Registry host which will be prepended to unqualified images, can be specified multiple times + +**--runroot**="" + The crio state dir (default: "/var/run/containers/storage") + +**--runtime**="" + OCI runtime path (default: "/usr/bin/runc") + +**--selinux**=*true*|*false* + Enable selinux support (default: false) + +**--seccomp-profile**="" + Path to the seccomp json profile to be used as the runtime's default (default: "/etc/crio/seccomp.json") + +**--signature-policy**="" + Path to the signature policy json file (default: "", to use the system-wide default) + +**--storage-driver** + OCI storage driver (default: "devicemapper") + +**--storage-opt** + OCI storage driver option (no default) + +**--cni-config-dir**="" + CNI configuration files directory (default: "/etc/cni/net.d/") + +**--cni-plugin-dir**="" + CNI plugin binaries directory (default: "/opt/cni/bin/") + +**--cpu-profile** + Set the CPU profile file path + +**--version, -v** + Print the version + +# COMMANDS +CRI-O's default command is to start the daemon. However, it currently offers a +single additional subcommand. + +## config + +Outputs a commented version of the configuration file that would've been used +by CRI-O. This allows you to save you current configuration setup and then load +it later with **--config**. Global options will modify the output. + +**--default** + Output the default configuration (without taking into account any configuration options). + +# SEE ALSO +crio.conf(5) + +# HISTORY +Sept 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com> and Aleksa Sarai <asarai@suse.de> diff --git a/docs/crio.conf.5.md b/docs/crio.conf.5.md new file mode 100644 index 000000000..32cac7a4d --- /dev/null +++ b/docs/crio.conf.5.md @@ -0,0 +1,159 @@ +% crio.conf(5) Open Container Initiative Daemon +% Aleksa Sarai +% OCTOBER 2016 + +# NAME +crio.conf - CRI-O configuration file + +# DESCRIPTION +The CRI-O configuration file specifies all of the available command-line options +for the crio(8) program, but in a TOML format that can be more easily modified +and versioned. + +# FORMAT +The [TOML format][toml] is used as the encoding of the configuration file. +Every option and subtable listed here is nested under a global "crio" table. +No bare options are used. The format of TOML can be simplified to: + + [table] + option = value + + [table.subtable1] + option = value + + [table.subtable2] + option = value + +## CRIO TABLE + +The `crio` table supports the following options: + + +**root**="" + CRIO root dir (default: "/var/lib/containers/storage") + +**runroot**="" + CRIO state dir (default: "/var/run/containers/storage") + +**storage_driver**="" + CRIO storage driver (default is "overlay") + +Note: + **overlay** and **overlay2** are the same driver + + +**storage_option**=[] + CRIO storage driver option list (no default) + + Values: + + "STORAGE_DRIVER.imagestore=/PATH", + + Paths to additional container image stores. These are read/only and are usually stored on remote network shares, based on overlay storage format. + storage_option=[ "overlay.imagestore=/mnt/overlay", ] + + "STORAGE_DRIVER.size=SIZE" + + Maximum size of a container image. Default is 10GB. The size flag sets quota on the size of container images. + storage_option=[ "overlay.size=1G", ] + +Note: Not all drivers support all options. + +Note: In order to use the **size** option for quota on *overlay* storage you must use the *xfs* file system. The mount point that the *overlay* file system must be setup with the *pquota* flag at mount time. If you are setting up / to be used with quota, you have to modify the linux boot line in /etc/grubq2.conf and add the rootflags=pquota flag. + +Example: + linux16 /vmlinuz-4.12.13-300.fc26.x86_64 root=/dev/mapper/fedora-root ro rd.lvm.lv=fedora/root rd.lvm.lv=fedora/swap rhgb quiet LANG=en_US.UTF-8 rootflags=pquota + + +## CRIO.API TABLE + +**listen**="" + Path to crio socket (default: "/var/run/crio.sock") + +## CRIO.RUNTIME TABLE + +**conmon**="" + Path to the conmon executable (default: "/usr/local/libexec/crio/conmon") + +**conmon_env**=[] + Environment variable list for conmon process (default: ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",]) + +**log_size_max**="" + Maximum sized allowed for the container log file (default: -1) + Negative numbers indicate that no size limit is imposed. + If it is positive, it must be >= 8192 (to match/exceed conmon read buffer). + The file is truncated and re-opened so the limit is never exceeded. + +**pids_limit**="" + Maximum number of processes allowed in a container (default: 1024) + +**runtime**="" + OCI runtime path (default: "/usr/bin/runc") + +**selinux**=*true*|*false* + Enable selinux support (default: false) + +**signature_policy**="" + Path to the signature policy json file (default: "", to use the system-wide default) + +**seccomp_profile**="" + Path to the seccomp json profile to be used as the runtime's default (default: "/etc/crio/seccomp.json") + +**apparmor_profile**="" + Name of the apparmor profile to be used as the runtime's default (default: "crio-default") + +**no_pivot**=*true*|*false* + Instructs the runtime to not use pivot_root, but instead use MS_MOVE + +**default_mounts**=[] + List of mount points, in the form host:container, to be mounted in every container + +## CRIO.IMAGE TABLE + +**default_transport** + A prefix to prepend to image names that can't be pulled as-is (default: "docker://") + +**image_volumes**="" + Image volume handling ('mkdir', 'bind' or 'ignore') (default: "mkdir") + mkdir: A directory is created inside the container root filesystem for the volumes. + bind: A directory is created inside container state directory and bind mounted into + the container for the volumes. + ignore: All volumes are just ignored and no action is taken. + +**insecure_registries**="" + Enable insecure registry communication, i.e., enable un-encrypted + and/or untrusted communication. + + List of insecure registries can contain an element with CIDR notation + to specify a whole subnet. Insecure registries accept HTTP and/or + accept HTTPS with certificates from unknown CAs. + + Enabling --insecure-registry is useful when running a local registry. + However, because its use creates security vulnerabilities it should + ONLY be enabled for testing purposes. For increased security, users + should add their CA to their system's list of trusted CAs instead of + using --insecure-registry. + +**pause_command**="" + Path to the pause executable in the pause image (default: "/pause") + +**pause_image**="" + Image which contains the pause executable (default: "kubernetes/pause") + +**registries**="" + Comma separated list of registries that will be prepended when pulling + unqualified images + +## CRIO.NETWORK TABLE + +**network_dir**="" + Path to CNI configuration files (default: "/etc/cni/net.d/") + +**plugin_dir**="" + Path to CNI plugin binaries (default: "/opt/cni/bin/") + +# SEE ALSO +crio(8) + +# HISTORY +Oct 2016, Originally compiled by Aleksa Sarai <asarai@suse.de> diff --git a/docs/kpod-attach.1.md b/docs/kpod-attach.1.md new file mode 100644 index 000000000..4c2a02186 --- /dev/null +++ b/docs/kpod-attach.1.md @@ -0,0 +1,31 @@ +% kpod(1) kpod-attach - See the output of pid 1 of a container or enter the container +% Dan Walsh +# kpod-attach "1" "September 2017" "kpod" + +## NAME +kpod-attach - Attach to a running container + +## Description + +We chose not to implement the `attach` feature in `kpod` even though the upstream Docker +project has it. The upstream project has had lots of issues with attaching to running +processes that we did not want to replicate. The `kpod exec` and `kpod log` commands +offer you the same functionality far more dependably. + +**Reasons to attach to the primary PID of a container:** + + +1) Executing commands inside of the container + + We recommend that you use `kpod exec` to execute a command within a container + + `kpod exec CONTAINERID /bin/sh` + +2) Viewing the output stream of the primary process in the container + + We recommend that you use `kpod logs` to see the output from the container + + `kpod logs CONTAINERID` + +## SEE ALSO +kpod(1), kpod-exec(1), kpod-logs(1) diff --git a/docs/kpod-cp.1.md b/docs/kpod-cp.1.md new file mode 100644 index 000000000..eea48e6c9 --- /dev/null +++ b/docs/kpod-cp.1.md @@ -0,0 +1,46 @@ +% kpod(1) kpod-cp - Copy content between container's file system and the host +% Dan Walsh +# kpod-cp "1" "August 2017" "kpod" + +## NAME +kpod-cp - Copy files/folders between a container and the local filesystem. + +## Description +We chose not to implement the `cp` feature in `kpod` even though the upstream Docker +project has it. We have a much stronger capability. Using standard kpod-mount +and kpod-umount, we can take advantage of the entire linux tool chain, rather +then just cp. + +If a user wants to copy contents out of a container or into a container, they +can execute a few simple commands. + +You can copy from the container's file system to the local machine or the +reverse, from the local filesystem to the container. + +If you want to copy the /etc/foobar directory out of a container and onto /tmp +on the host, you could execute the following commands: + + mnt=$(kpod mount CONTAINERID) + cp -R ${mnt}/etc/foobar /tmp + kpod umount CONTAINERID + +If you want to untar a tar ball into a container, you can execute these commands: + + mnt=$(kpod mount CONTAINERID) + tar xf content.tgz -C ${mnt} + kpod umount CONTAINERID + +One last example, if you want to install a package into a container that +does not have dnf installed, you could execute something like: + + mnt=$(kpod mount CONTAINERID) + dnf install --installroot=${mnt} httpd + chroot ${mnt} rm -rf /var/log/dnf /var/cache/dnf + kpod umount CONTAINERID + +This shows that using `kpod mount` and `kpod umount` you can use all of the +standard linux tools for moving files into and out of containers, not just +the cp command. + +## SEE ALSO +kpod(1), kpod-mount(1), kpod-umount(1) diff --git a/docs/kpod-diff.1.md b/docs/kpod-diff.1.md new file mode 100644 index 000000000..1916780c8 --- /dev/null +++ b/docs/kpod-diff.1.md @@ -0,0 +1,45 @@ +% kpod(1) kpod-diff - Inspect changes on a container or image's filesystem +% Dan Walsh +# kpod-diff "1" "August 2017" "kpod" + +## NAME +kpod diff - Inspect changes on a container or image's filesystem + +## SYNOPSIS +**kpod** **diff** [*options* [...]] NAME + +## DESCRIPTION +Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer + +## OPTIONS + +**--format** + +Alter the output into a different format. The only valid format for diff is `json`. + + +## EXAMPLE + +kpod diff redis:alpine +C /usr +C /usr/local +C /usr/local/bin +A /usr/local/bin/docker-entrypoint.sh + +kpod diff --format json redis:alpine +{ + "changed": [ + "/usr", + "/usr/local", + "/usr/local/bin" + ], + "added": [ + "/usr/local/bin/docker-entrypoint.sh" + ] +} + +## SEE ALSO +kpod(1) + +## HISTORY +August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod-export.1.md b/docs/kpod-export.1.md new file mode 100644 index 000000000..c344f1367 --- /dev/null +++ b/docs/kpod-export.1.md @@ -0,0 +1,44 @@ +% kpod(1) kpod-export - Simple tool to export a container's filesystem as a tarball +% Urvashi Mohnani +# kpod-export "1" "July 2017" "kpod" + +## NAME +kpod-export - Export container's filesystem contents as a tar archive + +## SYNOPSIS +**kpod export** +**CONTAINER** +[**--output**|**-o**] +[**--help**|**-h**] + +## DESCRIPTION +**kpod export** exports the filesystem of a container and saves it as a tarball +on the local machine. **kpod export** writes to STDOUT by default and can be +redirected to a file using the **output flag**. + +**kpod [GLOBAL OPTIONS]** + +**kpod export [GLOBAL OPTIONS]** + +**kpod export [OPTIONS] CONTAINER** + +## OPTIONS + +**--output, -o** +Write to a file, default is STDOUT + +## EXAMPLES + +``` +# kpod export -o redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57 +``` + +``` +# kpod export > redis-container.tar 883504668ec465463bc0fe7e63d53154ac3b696ea8d7b233748918664ea90e57 +``` + +## SEE ALSO +kpod(1), kpod-import(1), crio(8), crio.conf(5) + +## HISTORY +August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-history.1.md b/docs/kpod-history.1.md new file mode 100644 index 000000000..ae75e376e --- /dev/null +++ b/docs/kpod-history.1.md @@ -0,0 +1,106 @@ +% kpod(1) kpod-history - Simple tool to view the history of an image +% Urvashi Mohnani +% kpod-history "1" "JULY 2017" "kpod" + +## NAME +kpod-history - Shows the history of an image + +## SYNOPSIS +**kpod history** +**IMAGE[:TAG|DIGEST]** +[**--human**|**-H**] +[**--no-trunc**] +[**--quiet**|**-q**] +[**--format**] +[**--help**|**-h**] + +## DESCRIPTION +**kpod history** displays the history of an image by printing out information +about each layer used in the image. The information printed out for each layer +include Created (time and date), Created By, Size, and Comment. The output can +be truncated or not using the **--no-trunc** flag. If the **--human** flag is +set, the time of creation and size are printed out in a human readable format. +The **--quiet** flag displays the ID of the image only when set and the **--format** +flag is used to print the information using the Go template provided by the user. + +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| --------------- | ----------------------------------------------------------------------------- | +| .ID | Image ID | +| .Created | if **--human**, time elapsed since creation, otherwise time stamp of creation | +| .CreatedBy | Command used to create the layer | +| .Size | Size of layer on disk | +| .Comment | Comment for the layer | + +**kpod [GLOBAL OPTIONS]** + +**kpod history [GLOBAL OPTIONS]** + +**kpod history [OPTIONS] IMAGE[:TAG|DIGEST]** + +## OPTIONS + +**--human, -H** + Display sizes and dates in human readable format + +**--no-trunc** + Do not truncate the output + +**--quiet, -q** + Print the numeric IDs only + +**--format** + Alter the output for a format like 'json' or a Go template. + + +## EXAMPLES + +``` +# kpod history debian +ID CREATED CREATED BY SIZE COMMENT +b676ca55e4f2c 9 weeks ago /bin/sh -c #(nop) CMD ["bash"] 0 B +<missing> 9 weeks ago /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45.14 MB +``` + +``` +# kpod history --no-trunc=true --human=false debian +ID CREATED CREATED BY SIZE COMMENT +b676ca55e4f2c 2017-07-24T16:52:55Z /bin/sh -c #(nop) CMD ["bash"] 0 +<missing> 2017-07-24T16:52:54Z /bin/sh -c #(nop) ADD file:ebba725fb97cea4... 45142935 +``` + +``` +# kpod history --format "{{.ID}} {{.Created}}" debian +b676ca55e4f2c 9 weeks ago +<missing> 9 weeks ago +``` + +``` +# kpod history --format json debian +[ + { + "id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060", + "created": "2017-07-24T16:52:55.195062314Z", + "createdBy": "/bin/sh -c #(nop) CMD [\"bash\"]", + "size": 0, + "comment": "" + }, + { + "id": "b676ca55e4f2c0ce53d0636438c5372d3efeb5ae99b676fa5a5d1581bad46060", + "created": "2017-07-24T16:52:54.898893387Z", + "createdBy": "/bin/sh -c #(nop) ADD file:ebba725fb97cea45d0b1b35ccc8144e766fcfc9a78530465c23b0c4674b14042 in / ", + "size": 45142935, + "comment": "" + } +] +``` + +## history +Show the history of an image + +## SEE ALSO +kpod(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-images.1.md b/docs/kpod-images.1.md new file mode 100644 index 000000000..96408090d --- /dev/null +++ b/docs/kpod-images.1.md @@ -0,0 +1,60 @@ +% kpod(1) kpod-images - List images in local storage +% Dan Walsh +# kpod-images "1" "March 2017" "kpod" + +## NAME +kpod images - List images in local storage + +## SYNOPSIS +**kpod** **images** [*options* [...]] + +## DESCRIPTION +Displays locally stored images, their names, and their IDs. + +## OPTIONS + +**--digests** + +Show image digests + +**--filter, -f=[]** + +Filter output based on conditions provided (default []) + +**--format** + +Change the default output format. This can be of a supported type like 'json' +or a Go template. + +**--noheading, -n** + +Omit the table headings from the listing of images. + +**--no-trunc, --notruncate** + +Do not truncate output. + +**--quiet, -q** + +Lists only the image IDs. + + +## EXAMPLE + +kpod images + +kpod images --quiet + +kpod images -q --noheading --notruncate + +kpod images --format json + +kpod images --format "{{.ID}}" + +kpod images --filter dangling=true + +## SEE ALSO +kpod(1) + +## HISTORY +March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> diff --git a/docs/kpod-info.1.md b/docs/kpod-info.1.md new file mode 100644 index 000000000..99deae9b1 --- /dev/null +++ b/docs/kpod-info.1.md @@ -0,0 +1,36 @@ +% kpod(1) kpod-version - Simple tool to view version information +% Vincent Batts +% kpod-version "1" "JULY 2017" "kpod" + +## NAME +kpod-info - Display system information + + +## SYNOPSIS +**kpod** **info** [*options* [...]] + + +## DESCRIPTION + +Information display here pertain to the host, current storage stats, and build of kpod. Useful for the user and when reporting issues. + + +## OPTIONS + +**--debug, -D** + +Show additional information + +**--format** + +Change output format to "json" or a Go template. + + +## EXAMPLE + +`kpod info` + +`kpod info --debug --format json| jq .host.kernel` + +## SEE ALSO +crio(8), crio.conf(5) diff --git a/docs/kpod-inspect.1.md b/docs/kpod-inspect.1.md new file mode 100644 index 000000000..633f1fa41 --- /dev/null +++ b/docs/kpod-inspect.1.md @@ -0,0 +1,171 @@ +% kpod(1) kpod-inspect - Display a container or image's configuration +% Dan Walsh +# kpod-inspect "1" "July 2017" "kpod" + +## NAME +kpod inspect - Display a container or image's configuration + +## SYNOPSIS +**kpod** **inspect** [*options* [...]] name + +## DESCRIPTION +This displays the low-level information on containers and images identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result. + +## OPTIONS + +**--type, t="TYPE"** + +Return data on items of the specified type. Type can be 'container', 'image' or 'all' (default: all) + +**--format, -f="FORMAT"** + +Format the output using the given Go template + +**--size** + +Display the total file size if the type is a container + + +## EXAMPLE + +kpod inspect redis:alpine + +{ + "ArgsEscaped": true, + "AttachStderr": false, + "AttachStdin": false, + "AttachStdout": false, + "Cmd": [ + "/bin/sh", + "-c", + "#(nop) ", + "CMD [\"redis-server\"]" + ], + "Domainname": "", + "Entrypoint": [ + "entrypoint.sh" + ], + "Env": [ + "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", + "REDIS_VERSION=3.2.9", + "REDIS_DOWNLOAD_URL=http://download.redis.io/releases/redis-3.2.9.tar.gz", + "REDIS_DOWNLOAD_SHA=6eaacfa983b287e440d0839ead20c2231749d5d6b78bbe0e0ffa3a890c59ff26" + ], + "ExposedPorts": { + "6379/tcp": {} + }, + "Hostname": "e1ede117fb1e", + "Image": "sha256:75e877aa15b534396de82d385386cc4dda7819d5cbb018b9f97b77aeb8f4b55a", + "Labels": {}, + "OnBuild": [], + "OpenStdin": false, + "StdinOnce": false, + "Tty": false, + "User": "", + "Volumes": { + "/data": {} + }, + "WorkingDir": "/data" +} +{ + "ID": "b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45", + "Names": [ + "docker.io/library/redis:alpine" + ], + "Digests": [ + "sha256:88286f41530e93dffd4b964e1db22ce4939fffa4a4c665dab8591fbab03d4926", + "sha256:07b1ac6c7a5068201d8b63a09bb15358ec1616b813ef3942eb8cc12ae191227f", + "sha256:91e2e140ea27b3e89f359cd9fab4ec45647dda2a8e5fb0c78633217d9dca87b5", + "sha256:08957ceaa2b3be874cde8d7fa15c274300f47185acd62bca812a2ffb6228482d", + "sha256:acd3d12a6a79f772961a771f678c1a39e1f370e7baeb9e606ad8f1b92572f4ab", + "sha256:4ad88df090801e8faa8cf0be1f403b77613d13e11dad73f561461d482f79256c", + "sha256:159ac12c79e1a8d85dfe61afff8c64b96881719139730012a9697f432d6b739a" + ], + "Parent": "", + "Comment": "", + "Created": "2017-06-28T22:14:36.35280993Z", + "Container": "ba8d6c6b0d7fdd201fce404236136b44f3bfdda883466531a3d1a1f87906770b", + "ContainerConfig": { + "Hostname": "e1ede117fb1e", + "Domainname": "", + "User": "", + "AttachStdin": false, + "AttachStdout": false, + "AttachStderr": false, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": [ + "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", + "REDIS_VERSION=3.2.9", + "REDIS_DOWNLOAD_URL=http://download.redis.io/releases/redis-3.2.9.tar.gz", + "REDIS_DOWNLOAD_SHA=6eaacfa983b287e440d0839ead20c2231749d5d6b78bbe0e0ffa3a890c59ff26" + ], + "Cmd": [ + "/bin/sh", + "-c", + "#(nop) ", + "CMD [\"redis-server\"]" + ], + "ArgsEscaped": true, + "Image": "sha256:75e877aa15b534396de82d385386cc4dda7819d5cbb018b9f97b77aeb8f4b55a", + "Volumes": { + "/data": {} + }, + "WorkingDir": "/data", + "Entrypoint": [ + "entrypoint.sh" + ], + "Labels": {}, + "OnBuild": [] + }, + "Author": "", + "Config": { + "ExposedPorts": { + "6379/tcp": {} + }, + "Env": [ + "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", + "REDIS_VERSION=3.2.9", + "REDIS_DOWNLOAD_URL=http://download.redis.io/releases/redis-3.2.9.tar.gz", + "REDIS_DOWNLOAD_SHA=6eaacfa983b287e440d0839ead20c2231749d5d6b78bbe0e0ffa3a890c59ff26" + ], + "Entrypoint": [ + "entrypoint.sh" + ], + "Cmd": [ + "redis-server" + ], + "Volumes": { + "/data": {} + }, + "WorkingDir": "/data" + }, + "Architecture": "amd64", + "OS": "linux", + "Size": 3965955, + "VirtualSize": 19808086, + "GraphDriver": { + "Name": "overlay", + "Data": { + "MergedDir": "/var/lib/containers/storage/overlay/2059d805c90e034cb773d9722232ef018a72143dd31113b470fb876baeccd700/merged", + "UpperDir": "/var/lib/containers/storage/overlay/2059d805c90e034cb773d9722232ef018a72143dd31113b470fb876baeccd700/diff", + "WorkDir": "/var/lib/containers/storage/overlay/2059d805c90e034cb773d9722232ef018a72143dd31113b470fb876baeccd700/work" + } + }, + "RootFS": { + "type": "layers", + "diff_ids": [ + "sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0", + "sha256:c92a8fc997217611d0bfc9ff14d7ec00350ca564aef0ecbf726624561d7872d7", + "sha256:d4c406dea37a107b0cccb845611266a146725598be3e82ba31c55c08d1583b5a", + "sha256:8b4fa064e2b6c03a6c37089b0203f167375a8b49259c0ad7cb47c8c1e58b3fa0", + "sha256:c393e3d0b00ddf6b4166f1e2ad68245e08e9e3be0a0567a36d0a43854f03bfd6", + "sha256:38047b4117cb8bb3bba82991daf9a4e14ba01f9f66c1434d4895a7e96f67d8ba" + ] + } +} + + +## SEE ALSO +kpod(1) diff --git a/docs/kpod-kill.1.md b/docs/kpod-kill.1.md new file mode 100644 index 000000000..91247d282 --- /dev/null +++ b/docs/kpod-kill.1.md @@ -0,0 +1,33 @@ +% kpod(1) kpod-kill- Kill one or more containers with a signal +% Brent Baude +# kpod-kill"1" "September 2017" "kpod" + +## NAME +kpod kill - Kills one or more containers with a signal + +## SYNOPSIS +**kpod kill [OPTIONS] CONTAINER [...]** + +## DESCRIPTION +The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. + +## OPTIONS + +**--signal, s** + +Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. + + +## EXAMPLE + +kpod kill mywebserver + +kpod kill 860a4b23 + +kpod kill --signal TERM 860a4b23 + +## SEE ALSO +kpod(1), kpod-stop(1) + +## HISTORY +September 2017, Originally compiled by Brent Baude <bbaude@redhat.com> diff --git a/docs/kpod-load.1.md b/docs/kpod-load.1.md new file mode 100644 index 000000000..d29614de9 --- /dev/null +++ b/docs/kpod-load.1.md @@ -0,0 +1,76 @@ +% kpod(1) kpod-load - Simple tool to load an image from an archive to containers-storage +% Urvashi Mohnani +# kpod-load "1" "July 2017" "kpod" + +## NAME +kpod-load - Load an image from docker archive + +## SYNOPSIS +**kpod load** +**NAME[:TAG|@DIGEST]** +[**--input**|**-i**] +[**--quiet**|**-q**] +[**--help**|**-h**] + +## DESCRIPTION +**kpod load** copies an image from either **docker-archive** or **oci-archive** stored +on the local machine. **kpod load** reads from stdin by default or a file if the **input** flag is set. +The **quiet** flag suppresses the output when set. + +**kpod [GLOBAL OPTIONS]** + +**kpod load [GLOBAL OPTIONS]** + +**kpod load [OPTIONS] NAME[:TAG|@DIGEST]** + +## OPTIONS + +**--input, -i** +Read from archive file, default is STDIN + +**--quiet, -q** +Suppress the output + +**--signature-policy="PATHNAME"** + +Pathname of a signature policy file to use. It is not recommended that this +option be used, as the default behavior of using the system-wide default policy +(frequently */etc/containers/policy.json*) is most often preferred + +## EXAMPLES + +``` +# kpod load --quiet -i fedora.tar +``` + +``` +# kpod load -q --signature-policy /etc/containers/policy.json -i fedora.tar +``` + +``` +# kpod load < fedora.tar +Getting image source signatures +Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0 + 0 B / 4.03 MB [---------------------------------------------------------------] +Copying config sha256:7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560 + 0 B / 1.48 KB [---------------------------------------------------------------] +Writing manifest to image destination +Storing signatures +``` + +``` +# cat fedora.tar | kpod load +Getting image source signatures +Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0 + 0 B / 4.03 MB [---------------------------------------------------------------] +Copying config sha256:7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560 + 0 B / 1.48 KB [---------------------------------------------------------------] +Writing manifest to image destination +Storing signatures +``` + +## SEE ALSO +kpod(1), kpod-save(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-login.1.md b/docs/kpod-login.1.md new file mode 100644 index 000000000..05b3097c8 --- /dev/null +++ b/docs/kpod-login.1.md @@ -0,0 +1,65 @@ +% kpod(1) kpod-login - Simple tool to login to a registry server +% Urvashi Mohnani +# kpod-login "1" "August 2017" "kpod" + +## NAME +kpod-login - Login to a container registry + +## SYNOPSIS +**kpod login** +[**--help**|**-h**] +[**--authfile**] +[**--user**|**-u**] +[**--password**|**-p**] +**REGISTRY** + +## DESCRIPTION +**kpod login** logs into a specified registry server with the correct username +and password. **kpod login** reads in the username and password from STDIN. +The username and password can also be set using the **username** and **password** flags. +The path of the authentication file can be specified by the user by setting the **authfile** +flag. The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**. + +**kpod [GLOBAL OPTIONS]** + +**kpod login [GLOBAL OPTIONS]** + +**kpod login [OPTIONS] REGISTRY [GLOBAL OPTIONS]** + +## OPTIONS + +**--password, -p** +Password for registry + +**--username, -u** +Username for registry + +**--authfile** +Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth.json + +## EXAMPLES + +``` +# kpod login docker.io +Username: umohnani +Password: +Login Succeeded! +``` + +``` +# kpod login -u testuser -p testpassword localhost:5000 +Login Succeeded! +``` + +``` +# kpod login --authfile authdir/myauths.json docker.io +Username: umohnani +Password: +Login Succeeded! +``` + +## SEE ALSO +kpod(1), kpod-logout(1), crio(8), crio.conf(5) + +## HISTORY +August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-logout.1.md b/docs/kpod-logout.1.md new file mode 100644 index 000000000..5f119a18a --- /dev/null +++ b/docs/kpod-logout.1.md @@ -0,0 +1,56 @@ +% kpod(1) kpod-logout - Simple tool to logout of a registry server +% Urvashi Mohnani +# kpod-logout "1" "August 2017" "kpod" + +## NAME +kpod-logout - Logout of a container registry + +## SYNOPSIS +**kpod logout** +[**--help**|**-h**] +[**--authfile**] +[**--all**|**-a**] +**REGISTRY** + +## DESCRIPTION +**kpod logout** logs out of a specified registry server by deleting the cached credentials +stored in the **auth.json** file. The path of the authentication file can be overrriden by the user by setting the **authfile** flag. +The default path used is **${XDG\_RUNTIME_DIR}/containers/auth.json**. +All the cached credentials can be removed by setting the **all** flag. + +**kpod [GLOBAL OPTIONS]** + +**kpod logout [GLOBAL OPTIONS]** + +**kpod logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]** + +## OPTIONS + +**--authfile** +Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth.json + +**--all, -a** +Remove the cached credentials for all registries in the auth file + +## EXAMPLES + +``` +# kpod logout docker.io +Remove login credentials for https://registry-1.docker.io/v2/ +``` + +``` +# kpod logout --authfile authdir/myauths.json docker.io +Remove login credentials for https://registry-1.docker.io/v2/ +``` + +``` +# kpod logout --all +Remove login credentials for all registries +``` + +## SEE ALSO +kpod(1), kpod-login(1), crio(8), crio.conf(5) + +## HISTORY +August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-logs.1.md b/docs/kpod-logs.1.md new file mode 100644 index 000000000..25d108edd --- /dev/null +++ b/docs/kpod-logs.1.md @@ -0,0 +1,61 @@ +% kpod(1) kpod-logs - Fetch the logs of a container +% Ryan Cole +# kpod-logs "1" "March 2017" "kpod" + +## NAME +kpod logs - Fetch the logs of a container + +## SYNOPSIS +**kpod** **logs** [*options* [...]] container + +## DESCRIPTION +The kpod logs command batch-retrieves whatever logs are present for a container at the time of execution. This does not guarantee execution order when combined with kpod run (i.e. your run may not have generated any logs at the time you execute kpod logs + +## OPTIONS + +**--follow, -f** + +Follow log output. Default is false + +**--since=TIMESTAMP** + +Show logs since TIMESTAMP + +**--tail=LINES** + +Ouput the specified number of LINES at the end of the logs. LINES must be a positive integer. Defaults to 0, which prints all lines + +## EXAMPLE + +kpod logs b3f2436bdb978c1d33b1387afb5d7ba7e3243ed2ce908db431ac0069da86cb45 + +2017/08/07 10:16:21 Seeked /var/log/crio/pods/eb296bd56fab164d4d3cc46e5776b54414af3bf543d138746b25832c816b933b/c49f49788da14f776b7aa93fb97a2a71f9912f4e5a3e30397fca7dfe0ee0367b.log - &{Offset:0 Whence:0} +1:C 07 Aug 14:10:09.055 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo +1:C 07 Aug 14:10:09.055 # Redis version=4.0.1, bits=64, commit=00000000, modified=0, pid=1, just started +1:C 07 Aug 14:10:09.055 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf +1:M 07 Aug 14:10:09.055 # You requested maxclients of 10000 requiring at least 10032 max file descriptors. +1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted. +1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'. +1:M 07 Aug 14:10:09.056 * Running mode=standalone, port=6379. +1:M 07 Aug 14:10:09.056 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. +1:M 07 Aug 14:10:09.056 # Server initialized + + +kpod logs --tail 2 b3f2436bdb97 + +1:M 07 Aug 14:10:09.056 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. +1:M 07 Aug 14:10:09.056 # Server initialized + +kpod logs 224c375f27cd --since 2017-08-07T10:10:09.055837383-04:00 myserver + +1:M 07 Aug 14:10:09.055 # Server can't set maximum open files to 10032 because of OS error: Operation not permitted. +1:M 07 Aug 14:10:09.055 # Current maximum open files is 4096. maxclients has been reduced to 4064 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'. +1:M 07 Aug 14:10:09.056 * Running mode=standalone, port=6379. +1:M 07 Aug 14:10:09.056 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. +1:M 07 Aug 14:10:09.056 # Server initialized + +## SEE ALSO +kpod(1) + +## HISTORY +August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod-mount.1.md b/docs/kpod-mount.1.md new file mode 100644 index 000000000..25ccd937a --- /dev/null +++ b/docs/kpod-mount.1.md @@ -0,0 +1,50 @@ +% kpod(1) kpod-mount - Mount a working container's root filesystem. +% Dan Walsh +# kpod-mount "1" "July 2017" "kpod" + +## NAME +kpod mount - Mount a working container's root filesystem + +## SYNOPSIS +**kpod** **mount** + +**kpod** **mount** **containerID** + +## DESCRIPTION +Mounts the specified container's root file system in a location which can be +accessed from the host, and returns its location. + +If you execute the command without any arguments, the tool will list all of the +currently mounted containers. + +## RETURN VALUE +The location of the mounted file system. On error an empty string and errno is +returned. + +## OPTIONS + +**--format** + Print the mounted containers in specified format (json) + +**--notruncate** + +Do not truncate IDs in output. + +**--label** + +SELinux label for the mount point + +## EXAMPLE + +kpod mount c831414b10a3 + +/var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged + +kpod mount + +c831414b10a3 /var/lib/containers/storage/overlay/f3ac502d97b5681989dff84dfedc8354239bcecbdc2692f9a639f4e080a02364/merged + +a7060253093b /var/lib/containers/storage/overlay/0ff7d7ca68bed1ace424f9df154d2dd7b5a125c19d887f17653cbcd5b6e30ba1/merged + +## SEE ALSO +kpod(1), kpod-umount(1), mount(8) diff --git a/docs/kpod-pause.1.md b/docs/kpod-pause.1.md new file mode 100644 index 000000000..4a1eee92e --- /dev/null +++ b/docs/kpod-pause.1.md @@ -0,0 +1,24 @@ +% kpod(1) kpod-pause - Pause one or more containers +% Dan Walsh +# kpod-pause "1" "September 2017" "kpod" + +## NAME +kpod pause - Pause one or more containers + +## SYNOPSIS +**kpod pause [OPTIONS] CONTAINER [...]** + +## DESCRIPTION +Pauses all the processes in one or more containers. You may use container IDs or names as input. + +## EXAMPLE + +kpod pause mywebserver + +kpod pause 860a4b23 + +## SEE ALSO +kpod(1), kpod-unpause(1) + +## HISTORY +September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> diff --git a/docs/kpod-ps.1.md b/docs/kpod-ps.1.md new file mode 100644 index 000000000..e42855311 --- /dev/null +++ b/docs/kpod-ps.1.md @@ -0,0 +1,131 @@ +% kpod(1) kpod-ps - Simple tool to list containers +% Urvashi Mohnani +% kpod-ps "1" "AUGUST 2017" "kpod" + +## NAME +kpod-ps - Prints out information about containers + +## SYNOPSIS +**kpod ps** +[**--all**|**-a**] +[**--no-trunc**] +[**--quiet**|**-q**] +[**--fromat**] +[**--help**|**-h**] + +## DESCRIPTION +**kpod ps** lists the running containers on the system. Use the **--all** flag to view +all the containers information. By default it lists: + + * container id + * the name of the image the container is using + * the COMMAND the container is executing + * the time the container was created + * the status of the container + * port mappings the container is using + * alternative names for the container + +**kpod [GLOBAL OPTIONS]** + +**kpod ps [GLOBAL OPTIONS]** + +**kpod ps [OPTIONS]** + +## OPTIONS + +**--all, -a** + Show all the containers, default is only running containers + +**--no-trunc** + Display the extended information + +**--quiet, -q** + Print the numeric IDs of the containers only + +**--format** + Pretty-print containers to JSON or using a Go template + +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| --------------- | ------------------------------------------------ | +| .ID | Container ID | +| .Image | Image ID/Name | +| .Command | Quoted command used | +| .CreatedAt | Creation time for container | +| .RunningFor | Time elapsed since container was started | +| .Status | Status of container | +| .Ports | Exposed ports | +| .Size | Size of container | +| .Names | Name of container | +| .Labels | All the labels assigned to the container | +| .Mounts | Volumes mounted in the container | + + +**--size, -s** + Display the total file size + +**--last, -n** + Print the n last created containers (all states) + +**--latest, -l** + show the latest container created (all states) + +**--namespace, --ns** + Display namespace information + +**--filter, -f** + Filter output based on conditions given + +Valid filters are listed below: + +| **Filter** | **Description** | +| --------------- | ------------------------------------------------------------------- | +| id | [ID] Container's ID | +| name | [Name] Container's name | +| label | [Key] or [Key=Value] Label assigned to a container | +| exited | [Int] Container's exit code | +| status | [Status] Container's status, e.g *running*, *stopped* | +| ancestor | [ImageName] Image or descendant used to create container | +| before | [ID] or [Name] Containers created before this container | +| since | [ID] or [Name] Containers created since this container | +| volume | [VolumeName] or [MountpointDestination] Volume mounted in container | + +## EXAMPLES + +``` +sudo kpod ps -a +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +02f65160e14ca redis:alpine "redis-server" 19 hours ago Exited (-1) 19 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 +69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 +``` + +``` +sudo kpod ps -a -s +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES SIZE +02f65160e14ca redis:alpine "redis-server" 20 hours ago Exited (-1) 20 hours ago 6379/tcp k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 27.49 MB +69ed779d8ef9f redis:alpine "redis-server" 25 hours ago Created 6379/tcp k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 27.49 MB +``` + +``` +sudo kpod ps -a --format "{{.ID}} {{.Image}} {{.Labels}} {{.Mounts}}" +02f65160e14ca redis:alpine tier=backend proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/ +69ed779d8ef9f redis:alpine batch=no,type=small proc,tmpfs,devpts,shm,mqueue,sysfs,cgroup,/var/run/,/var/run/ +``` + +``` +sudo kpod ps --ns -a +CONTAINER ID NAMES PID CGROUP IPC MNT NET PIDNS USER UTS +3557d882a82e3 k8s_container2_podsandbox1_redhat.test.crio_redhat-test-crio_1 29910 4026531835 4026532585 4026532593 4026532508 4026532595 4026531837 4026532594 +09564cdae0bec k8s_container1_podsandbox1_redhat.test.crio_redhat-test-crio_1 29851 4026531835 4026532585 4026532590 4026532508 4026532592 4026531837 4026532591 +a31ebbee9cee7 k8s_podsandbox1-redis_podsandbox1_redhat.test.crio_redhat-test-crio_0 29717 4026531835 4026532585 4026532587 4026532508 4026532589 4026531837 4026532588 +``` + +## ps +Print a list of containers + +## SEE ALSO +kpod(1), crio(8), crio.conf(5) + +## HISTORY +August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-pull.1.md b/docs/kpod-pull.1.md new file mode 100644 index 000000000..254fc5846 --- /dev/null +++ b/docs/kpod-pull.1.md @@ -0,0 +1,135 @@ +% kpod(1) kpod-pull - Simple tool to pull an image from a registry +% Urvashi Mohnani +# kpod-pull "1" "July 2017" "kpod" + +## NAME +kpod-pull - Pull an image from a registry + +## SYNOPSIS +**kpod pull** +**NAME[:TAG|@DIGEST]** +[**--help**|**-h**] + +## DESCRIPTION +Copies an image from a registry onto the local machine. **kpod pull** pulls an +image from Docker Hub if a registry is not specified in the command line argument. +If an image tag is not specified, **kpod pull** defaults to the image with the +**latest** tag (if it exists) and pulls it. **kpod pull** can also pull an image +using its digest **kpod pull [image]@[digest]**. **kpod pull** can be used to pull +images from archives and local storage using different transports. + +## imageID +Image stored in local container/storage + +## SOURCE + + The SOURCE is a location to get container images + The Image "SOURCE" uses a "transport":"details" format. + + Multiple transports are supported: + + **dir:**_path_ + An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection. + + **docker://**_docker-reference_ + An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set e.g. using `(kpod login)`. + + **docker-archive:**_path_[**:**_docker-reference_] + An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest. + + **docker-daemon:**_docker-reference_ + An image _docker-reference_ stored in the docker daemon internal storage. _docker-reference_ must contain either a tag or a digest. Alternatively, when reading images, the format can also be docker-daemon:algo:digest (an image ID). + + **oci-archive:**_path_**:**_tag_ + An image _tag_ in a directory compliant with "Open Container Image Layout Specification" at _path_. + + **ostree:**_image_[**@**_/absolute/repo/path_] + An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_. + +**kpod [GLOBAL OPTIONS]** + +**kpod pull [GLOBAL OPTIONS]** + +**kpod pull NAME[:TAG|@DIGEST]** + +## OPTIONS + +**--authfile** + +Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json + +**--cert-dir** + +Pathname of a directory containing TLS certificates and keys + +**--creds** + +Credentials (USERNAME:PASSWORD) to use for authenticating to a registry + +**--quiet, -q** + +Suppress output information when pulling images + +**--signature-policy="PATHNAME"** + +Pathname of a signature policy file to use. It is not recommended that this +option be used, as the default behavior of using the system-wide default policy +(frequently */etc/containers/policy.json*) is most often preferred + +**--tls-verify** + +Require HTTPS and verify certificates when contacting registries (default: true) + +## EXAMPLES + +``` +# kpod pull --signature-policy /etc/containers/policy.json alpine:latest +Trying to pull registry.access.redhat.com/alpine:latest... Failed +Trying to pull registry.fedoraproject.org/alpine:latest... Failed +Trying to pull docker.io/library/alpine:latest...Getting image source signatures +Copying blob sha256:88286f41530e93dffd4b964e1db22ce4939fffa4a4c665dab8591fbab03d4926 + 1.90 MB / 1.90 MB [========================================================] 0s +Copying config sha256:76da55c8019d7a47c347c0dceb7a6591144d232a7dd616242a367b8bed18ecbc + 1.48 KB / 1.48 KB [========================================================] 0s +Writing manifest to image destination +Storing signatures +``` + +``` +# kpod pull --authfile temp-auths/myauths.json docker://docker.io/umohnani/finaltest +Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures +Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 + 1.90 MB / 1.90 MB [========================================================] 0s +Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 + 1.41 KB / 1.41 KB [========================================================] 0s +Writing manifest to image destination +Storing signatures +``` + +``` +# kpod pull --creds testuser:testpassword docker.io/umohnani/finaltest +Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures +Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 + 1.90 MB / 1.90 MB [========================================================] 0s +Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 + 1.41 KB / 1.41 KB [========================================================] 0s +Writing manifest to image destination +Storing signatures +``` + +``` +# kpod pull --tls-verify=false --cert-dir image/certs docker.io/umohnani/finaltest +Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures +Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 + 1.90 MB / 1.90 MB [========================================================] 0s +Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 + 1.41 KB / 1.41 KB [========================================================] 0s +Writing manifest to image destination +Storing signatures +``` + +## SEE ALSO +kpod(1), kpod-push(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-push.1.md b/docs/kpod-push.1.md new file mode 100644 index 000000000..801615034 --- /dev/null +++ b/docs/kpod-push.1.md @@ -0,0 +1,116 @@ +% kpod(1) kpod-push - Push an image from local storage to elsewhere +% Dan Walsh +# kpod-push "1" "June 2017" "kpod" + +## NAME +kpod push - Push an image from local storage to elsewhere + +## SYNOPSIS +**kpod** **push** [*options* [...]] **imageID** [**destination**] + +## DESCRIPTION +Pushes an image from local storage to a specified destination, decompressing +and recompressing layers as needed. + +## imageID +Image stored in local container/storage + +## DESTINATION + + The DESTINATION is a location to store container images + The Image "DESTINATION" uses a "transport":"details" format. + + Multiple transports are supported: + + **dir:**_path_ + An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection. + + **docker://**_docker-reference_ + An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set e.g. using `(kpod login)`. + + **docker-archive:**_path_[**:**_docker-reference_] + An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest. + + **docker-daemon:**_docker-reference_ + An image _docker-reference_ stored in the docker daemon internal storage. _docker-reference_ must contain either a tag or a digest. Alternatively, when reading images, the format can also be docker-daemon:algo:digest (an image ID). + + **oci-archive:**_path_**:**_tag_ + An image _tag_ in a directory compliant with "Open Container Image Layout Specification" at _path_. + + **ostree:**_image_[**@**_/absolute/repo/path_] + An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_. + +## OPTIONS + +**--authfile** + +Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json + +**--creds="CREDENTIALS"** + +Credentials (USERNAME:PASSWORD) to use for authenticating to a registry + +**cert-dir="PATHNAME"** + +Pathname of a directory containing TLS certificates and keys + +**--disable-compression, -D** + +Don't compress copies of filesystem layers which will be pushed + +**--quiet, -q** + +When writing the output image, suppress progress output + +**--remove-signatures** + +Discard any pre-existing signatures in the image + +**--signature-policy="PATHNAME"** + +Pathname of a signature policy file to use. It is not recommended that this +option be used, as the default behavior of using the system-wide default policy +(frequently */etc/containers/policy.json*) is most often preferred + +**--sign-by="KEY"** + +Add a signature at the destination using the specified key + +**--tls-verify** + +Require HTTPS and verify certificates when contacting registries (default: true) + +## EXAMPLE + +This example extracts the imageID image to a local directory in docker format. + + `# kpod push imageID dir:/path/to/image` + +This example extracts the imageID image to a local directory in oci format. + + `# kpod push imageID oci-archive:/path/to/layout:image:tag` + +This example extracts the imageID image to a container registry named registry.example.com + + `# kpod push imageID docker://registry.example.com/repository:tag` + +This example extracts the imageID image and puts into the local docker container store + + `# kpod push imageID docker-daemon:image:tag` + +This example pushes the alpine image to umohnani/alpine on dockerhub and reads the creds from +the path given to --authfile + +``` +# kpod push --authfile temp-auths/myauths.json alpine docker://docker.io/umohnani/alpine +Getting image source signatures +Copying blob sha256:5bef08742407efd622d243692b79ba0055383bbce12900324f75e56f589aedb0 + 4.03 MB / 4.03 MB [========================================================] 1s +Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 + 1.41 KB / 1.41 KB [========================================================] 1s +Writing manifest to image destination +Storing signatures +``` + +## SEE ALSO +kpod(1), kpod-pull(1), crio(8), crio.conf(5) diff --git a/docs/kpod-rename.1.md b/docs/kpod-rename.1.md new file mode 100644 index 000000000..e59dbd991 --- /dev/null +++ b/docs/kpod-rename.1.md @@ -0,0 +1,24 @@ +% kpod(1) kpod-rename - Rename a container +% Ryan Cole +# kpod-images "1" "March 2017" "kpod" + +## NAME +kpod rename - Rename a container + +## SYNOPSIS +**kpod** **rename** CONTAINER NEW-NAME + +## DESCRIPTION +Rename a container. Container may be created, running, paused, or stopped + +## EXAMPLE + +kpod rename redis-container webserver + +kpod rename a236b9a4 mycontainer + +## SEE ALSO +kpod(1) + +## HISTORY +March 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod-rm.1.md b/docs/kpod-rm.1.md new file mode 100644 index 000000000..4e2c490a6 --- /dev/null +++ b/docs/kpod-rm.1.md @@ -0,0 +1,31 @@ +% kpod(1) kpod-rm - Remove one or more containers +% Ryan Cole +# kpod-rm "1" "August 2017" "kpod" + +## NAME +kpod rm - Remove one or more containers + +## SYNOPSIS +**kpod** **rm** [*options* [...]] container + +## DESCRIPTION +Kpod rm will remove one or more containers from the host. The container name or ID can be used. This does not remove images. Running containers will not be removed without the -f option + +## OPTIONS + +**--force, f** + +Force the removal of a running container + + +## EXAMPLE + +kpod rm mywebserver + +kpod rm -f 860a4b23 + +## SEE ALSO +kpod(1), kpod-rmi(1) + +## HISTORY +August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod-rmi.1.md b/docs/kpod-rmi.1.md new file mode 100644 index 000000000..1566f9612 --- /dev/null +++ b/docs/kpod-rmi.1.md @@ -0,0 +1,32 @@ +% kpod(1) kpod-rmi - Removes one or more images +% Dan Walsh +# kpod-rmi "1" "March 2017" "kpod" + +## NAME +kpod rmi - Removes one or more images + +## SYNOPSIS +**kpod** **rmi** **imageID [...]** + +## DESCRIPTION +Removes one or more locally stored images. + +## OPTIONS + +**--force, -f** + +Executing this command will stop all containers that are using the image and remove them from the system + +## EXAMPLE + +kpod rmi imageID + +kpod rmi --force imageID + +kpod rmi imageID1 imageID2 imageID3 + +## SEE ALSO +kpod(1) + +## HISTORY +March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> diff --git a/docs/kpod-save.1.md b/docs/kpod-save.1.md new file mode 100644 index 000000000..dbcf96d04 --- /dev/null +++ b/docs/kpod-save.1.md @@ -0,0 +1,60 @@ +% kpod(1) kpod-save - Simple tool to save an image to an archive +% Urvashi Mohnani +# kpod-save "1" "July 2017" "kpod" + +## NAME +kpod-save - Save an image to docker-archive or oci-archive + +## SYNOPSIS +**kpod save** +**NAME[:TAG]** +[**--quiet**|**-q**] +[**--format**] +[**--output**|**-o**] +[**--help**|**-h**] + +## DESCRIPTION +**kpod save** saves an image to either **docker-archive** or **oci-archive** +on the local machine, default is **docker-archive**. +**kpod save** writes to STDOUT by default and can be redirected to a file using the **output** flag. +The **quiet** flag suppresses the output when set. + +**kpod [GLOBAL OPTIONS]** + +**kpod save [GLOBAL OPTIONS]** + +**kpod save [OPTIONS] NAME[:TAG]** + +## OPTIONS + +**--output, -o** +Write to a file, default is STDOUT + +**--format** +Save image to **oci-archive** +``` +--format oci-archive +``` + +**--quiet, -q** +Suppress the output + +## EXAMPLES + +``` +# kpod save --quiet -o alpine.tar alpine:2.6 +``` + +``` +# kpod save > alpine-all.tar alpine +``` + +``` +# kpod save -o oci-alpine.tar --format oci-archive alpine +``` + +## SEE ALSO +kpod(1), kpod-load(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-stats.1.md b/docs/kpod-stats.1.md new file mode 100644 index 000000000..1c1c0b35d --- /dev/null +++ b/docs/kpod-stats.1.md @@ -0,0 +1,37 @@ +% kpod(1) kpod-stats - Display a live stream of 1 or more containers' resource usage statistics +% Ryan Cole +# kpod-stats "1" "July 2017" "kpod" + +## NAME +kpod-stats - Display a live stream of 1 or more containers' resource usage statistics + +## SYNOPSIS +**kpod** **stats** [*options* [...]] [container] + +## DESCRIPTION +Display a live stream of one or more containers' resource usage statistics + +## OPTIONS + +**--all, -a** + +Show all containers. Only running containers are shown by default + +**--no-stream** + +Disable streaming stats and only pull the first result, default setting is false + +**--format="TEMPLATE"** + +Pretty-print images using a Go template + + +## EXAMPLE + +TODO + +## SEE ALSO +kpod(1) + +## HISTORY +July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod-stop.1.md b/docs/kpod-stop.1.md new file mode 100644 index 000000000..52a358156 --- /dev/null +++ b/docs/kpod-stop.1.md @@ -0,0 +1,35 @@ +% kpod(1) kpod-stop - Stop one or more containers +% Brent Baude +# kpod-stop "1" "September 2017" "kpod" + +## NAME +kpod stop - Stop one or more containers + +## SYNOPSIS +**kpod stop [OPTIONS] CONTAINER [...]** + +## DESCRIPTION +Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch +allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command +is issued to the container. The default is 10 seconds. + +## OPTIONS + +**--timeout, t** + +Timeout to wait before forcibly stopping the container + + +## EXAMPLE + +kpod stop mywebserver + +kpod stop 860a4b23 + +kpod stop --timeout 2 860a4b23 + +## SEE ALSO +kpod(1), kpod-rm(1) + +## HISTORY +September 2018, Originally compiled by Brent Baude <bbaude@redhat.com> diff --git a/docs/kpod-tag.1.md b/docs/kpod-tag.1.md new file mode 100644 index 000000000..b92b2eb16 --- /dev/null +++ b/docs/kpod-tag.1.md @@ -0,0 +1,34 @@ +% kpod(1) kpod-tag - Add tags to an image +% Ryan Cole +# kpod-tag "1" "July 2017" "kpod" + +## NAME +kpod tag - Add an additional name to a local image + +## SYNOPSIS +**kpod tag** +[**--help**|**-h**] + +## DESCRIPTION +Assigns a new alias to an image in a registry. An alias refers to the entire image name, including the optional **TAG** after the ':' + +**kpod [GLOBAL OPTIONS]** + +**kpod [GLOBAL OPTIONS] tag [OPTIONS]** + +## GLOBAL OPTIONS + +**--help, -h** + Print usage statement + +## EXAMPLES + + kpod tag 0e3bbc2 fedora:latest + + kpod tag httpd myregistryhost:5000/fedora/httpd:v2 + +## SEE ALSO +kpod(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod-umount.1.md b/docs/kpod-umount.1.md new file mode 100644 index 000000000..2ee03356d --- /dev/null +++ b/docs/kpod-umount.1.md @@ -0,0 +1,19 @@ +% kpod(1) kpod-umount - Unmount a working container's root filesystem. +% Dan Walsh +# kpod-umount "1" "July 2017" "kpod" + +## NAME +kpod umount - Unmount a working container's root file system + +## SYNOPSIS +**kpod** **umount** **containerID** + +## DESCRIPTION +Unmounts the specified container's root file system. + +## EXAMPLE + +kpod umount containerID + +## SEE ALSO +kpod(1), kpod-mount(1) diff --git a/docs/kpod-unpause.1.md b/docs/kpod-unpause.1.md new file mode 100644 index 000000000..52a810025 --- /dev/null +++ b/docs/kpod-unpause.1.md @@ -0,0 +1,24 @@ +% kpod(1) kpod-unpause - Unpause one or more containers +% Dan Walsh +# kpod-unpause "1" "September 2017" "kpod" + +## NAME +kpod unpause - Unpause one or more containers + +## SYNOPSIS +**kpod unpause [OPTIONS] CONTAINER [...]** + +## DESCRIPTION +Unpauses the processes in one or more containers. You may use container IDs or names as input. + +## EXAMPLE + +kpod unpause mywebserver + +kpod unpause 860a4b23 + +## SEE ALSO +kpod(1), kpod-pause(1) + +## HISTORY +September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com> diff --git a/docs/kpod-version.1.md b/docs/kpod-version.1.md new file mode 100644 index 000000000..cdc2c9251 --- /dev/null +++ b/docs/kpod-version.1.md @@ -0,0 +1,24 @@ +% kpod(1) kpod-version - Simple tool to view version information +% Urvashi Mohnani +# kpod-version "1" "July 2017" "kpod" + +## NAME +kpod-version - Display the KPOD Version Information + +## SYNOPSIS +**kpod version** +[**--help**|**-h**] + +## DESCRIPTION +Shows the the following information: Version, Go Version, Git Commit, Build Time, +OS, and Architecture. + +**kpod [GLOBAL OPTIONS]** + +**kpod version** + +## SEE ALSO +kpod(1), crio(8), crio.conf(5) + +## HISTORY +July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/kpod-wait.1.md b/docs/kpod-wait.1.md new file mode 100644 index 000000000..290cdedfc --- /dev/null +++ b/docs/kpod-wait.1.md @@ -0,0 +1,36 @@ +% kpod(1) kpod-wait - Waits on a container +% Brent Baude +# kpod-wait "1" "September 2017" "kpod" + +## NAME +kpod wait - Waits on one or more containers to stop and prints exit code + +## SYNOPSIS +**kpod wait** +[**--help**|**-h**] + +## DESCRIPTION +Waits on one or more containers to stop. The container can be referred to by its +name or ID. In the case of multiple containers, kpod will wait on each consecutively. +After the container stops, the container's return code is printed. + +**kpod [GLOBAL OPTIONS] wait ** + +## GLOBAL OPTIONS + +**--help, -h** + Print usage statement + +## EXAMPLES + + kpod wait mywebserver + + kpod wait 860a4b23 + + kpod wait mywebserver myftpserver + +## SEE ALSO +kpod(1), crio(8), crio.conf(5) + +## HISTORY +September 2017, Originally compiled by Brent Baude<bbaude@redhat.com> diff --git a/docs/kpod.1.md b/docs/kpod.1.md new file mode 100644 index 000000000..27de1ca55 --- /dev/null +++ b/docs/kpod.1.md @@ -0,0 +1,137 @@ +% kpod(1) kpod - Simple management tool for pods and images +% Dan Walsh +# kpod "1" "September 2016" "kpod" +## NAME +kpod - Simple management tool for containers and images + +## SYNOPSIS +**kpod** [*options*] COMMAND + +# DESCRIPTION +kpod is a simple client only tool to help with debugging issues when daemons +such as CRI runtime and the kubelet are not responding or failing. A shared API +layer could be created to share code between the daemon and kpod. kpod does not +require any daemon running. kpod utilizes the same underlying components that +crio uses i.e. containers/image, container/storage, oci-runtime-tool/generate, +runc or any other OCI compatible runtime. kpod shares state with crio and so +has the capability to debug pods/images created by crio. + +**kpod [GLOBAL OPTIONS]** + +## GLOBAL OPTIONS + +**--help, -h** + Print usage statement + +**--config value, -c**=**"config.file"** + Path of a config file detailing container server configuration options + +**--log-level** + log messages above specified level: debug, info, warn, error (default), fatal or panic + +**--root**=**value** + Path to the root directory in which data, including images, is stored + +**--runroot**=**value** + Path to the 'run directory' where all state information is stored + +**--runtime**=**value** + Path to the OCI compatible binary used to run containers + +**--storage-driver, -s**=**value** + Select which storage driver is used to manage storage of images and containers (default is overlay) + +**--storage-opt**=**value** + Used to pass an option to the storage driver + +**--version, -v** + Print the version + +## COMMANDS + +### diff +Inspect changes on a container or image's filesystem + +### export +Export container's filesystem contents as a tar archive + +### history +Shows the history of an image + +### images +List images in local storage + +### info +Displays system information + +### inspect +Display a container or image's configuration + +### kill +Kill the main process in one or more containers + +### load +Load an image from docker archive + +### login +Login to a container registry + +### logout +Logout of a container registry + +### logs +Display the logs of a container + +### mount +Mount a working container's root filesystem + +### pause +Pause one or more containers + +### ps +Prints out information about containers + +### pull +Pull an image from a registry + +### push +Push an image from local storage to elsewhere + +### rename +Rename a container + +### rm +Remove one or more containers + +### rmi +Removes one or more locally stored images + +### save +Save an image to docker-archive or oci + +### stats +Display a live stream of one or more containers' resource usage statistics + +### stop +Stops one or more running containers. + +### tag +Add an additional name to a local image + +### umount +Unmount a working container's root file system + +### unpause +Unpause one or more containers + +### version +Display the version information + +### wait +Wait on one or more containers to stop and print their exit codes + +## SEE ALSO +crio(8), crio.conf(5) + +## HISTORY +Dec 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com> diff --git a/docs/play.png b/docs/play.png Binary files differnew file mode 100644 index 000000000..9be2868fd --- /dev/null +++ b/docs/play.png |
