From 33201aff5687ed6f4c4a46b108a6b4335d474363 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Thu, 17 Aug 2017 15:12:24 -0400 Subject: [PATCH] Update web site documentation for latest kpod Add missing commands to transfer page and add links for demos to README.md page. Fixup bash completions for new commands. Signed-off-by: Daniel J Walsh --- README.md | 45 ++++++++++++------------ completions/bash/kpod | 79 ++++++++++++++++++++++++++++++++++++------ docs/kpod.1.md | 6 ++++ docs/play.png | Bin 0 -> 1672 bytes transfer.md | 5 +-- 5 files changed, 101 insertions(+), 34 deletions(-) create mode 100644 docs/play.png diff --git a/README.md b/README.md index 9c93d208..310c53da 100644 --- a/README.md +++ b/README.md @@ -37,28 +37,29 @@ The plan is to use OCI projects and best of breed libraries for different aspect It is currently in active development in the Kubernetes community through the [design proposal](https://github.com/kubernetes/kubernetes/pull/26788). Questions and issues should be raised in the Kubernetes [sig-node Slack channel](https://kubernetes.slack.com/archives/sig-node). ## Commands -| Command | Description | -| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| [crio(8)](/docs/crio.8.md) | OCI Kubernetes Container Runtime daemon | -| [kpod(1)](/docs/kpod.1.md) | Simple management tool for pods and images | -| [kpod-cp(1)](/docs/kpod-cp.1.md) | Copy files/folders between a container and the local filesystem | -| [kpod-diff(1)](/docs/kpod-diff.1.md) | Inspect changes on a container or image's filesystem | -| [kpod-export(1)](/docs/kpod-export.1.md) | Export container's filesystem contents as a tar archive | -| [kpod-history(1)](/docs/kpod-history.1.md) | Shows the history of an image | -| [kpod-images(1)](/docs/kpod-images.1.md) | List images in local storage | -| [kpod-info(1)](/docs/kpod-info.1.md) | Display system information | -| [kpod-inspect(1)](/docs/kpod-inspect.1.md) | Display the configuration of a container or image | -| [kpod-load(1)](/docs/kpod-load.1.md) | Load an image from docker archive or oci | -| [kpod-logs(1)](/docs/kpod-logs.1.md) | Display the logs of a container | -| [kpod-mount(1)](/docs/kpod-mount.1.md) | Mount a working container's root filesystem | -| [kpod-pull(1)](/docs/kpod-pull.1.md) | Pull an image from a registry | -| [kpod-push(1)](/docs/kpod-push.1.md) | Push an image to a specified destination | -| [kpod-rmi(1)](/docs/kpod-rmi.1.md) | Removes one or more images | -| [kpod-save(1)](/docs/kpod-save.1.md) | Saves an image to an archive | -| [kpod-stats(1)](/docs/kpod-stats.1.md) | Display a live stream of one or more containers' resource usage statistics | -| [kpod-tag(1)](/docs/kpod-tag.1.md) | Add an additional name to a local image | -| [kpod-umount(1)](/docs/kpod-umount.1.md) | Unmount a working container's root filesystem | -| [kpod-version(1)](/docs/kpod-version.1.md) | Display the Kpod version information | +| Command | Description | Demo| +| ---------------------------------------------------- | --------------------------------------------------------------------------|-----| +| [crio(8)](/docs/crio.8.md) | OCI Kubernetes Container Runtime daemon || +| [kpod(1)](/docs/kpod.1.md) | Simple management tool for pods and images || +| [kpod-cp(1)](/docs/kpod-cp.1.md) | Copy files/folders between a container and the local filesystem || +| [kpod-diff(1)](/docs/kpod-diff.1.md) | Inspect changes on a container or image's filesystem || +| [kpod-export(1)](/docs/kpod-export.1.md) | Export container's filesystem contents as a tar archive || +| [kpod-history(1)](/docs/kpod-history.1.md) | Shows the history of an image || +| [kpod-images(1)](/docs/kpod-images.1.md) | List images in local storage |[![...](/docs/play.png)](https://asciinema.org/a/133649)| +| [kpod-info(1)](/docs/kpod-info.1.md) | Display system information || +| [kpod-inspect(1)](/docs/kpod-inspect.1.md) | Display the configuration of a container or image |[![...](/docs/play.png)](https://asciinema.org/a/133418)| +| [kpod-load(1)](/docs/kpod-load.1.md) | Load an image from docker archive or oci |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)| +| [kpod-logs(1)](/docs/kpod-logs.1.md) | Display the logs of a container || +| [kpod-mount(1)](/docs/kpod-mount.1.md) | Mount a working container's root filesystem || +| [kpod-pull(1)](/docs/kpod-pull.1.md) | Pull an image from a registry |[![...](/docs/play.png)](https://asciinema.org/a/lr4zfoynHJOUNu1KaXa1dwG2X)| +| [kpod-push(1)](/docs/kpod-push.1.md) | Push an image to a specified destination |[![...](/docs/play.png)](https://asciinema.org/a/133276)| +| [kpod-rename(1)](/docs/kpod-rename.1.md) | Rename a container || +| [kpod-rmi(1)](/docs/kpod-rmi.1.md) | Removes one or more images |[![...](/docs/play.png)](https://asciinema.org/a/133799)| +| [kpod-save(1)](/docs/kpod-save.1.md) | Saves an image to an archive |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)| +| [kpod-stats(1)](/docs/kpod-stats.1.md) | Display a live stream of one or more containers' resource usage statistics|| +| [kpod-tag(1)](/docs/kpod-tag.1.md) | Add an additional name to a local image |[![...](/docs/play.png)](https://asciinema.org/a/133803)| +| [kpod-umount(1)](/docs/kpod-umount.1.md) | Unmount a working container's root filesystem || +| [kpod-version(1)](/docs/kpod-version.1.md) | Display the version information |[![...](/docs/play.png)](https://asciinema.org/a/mfrn61pjZT9Fc8L4NbfdSqfgu)| ## Configuration | File | Description | diff --git a/completions/bash/kpod b/completions/bash/kpod index e70fca27..ee7f037c 100644 --- a/completions/bash/kpod +++ b/completions/bash/kpod @@ -10,16 +10,53 @@ __kpod_list_containers() { COMPREPLY=($(compgen -W "$(kpod ps -aq)" -- $cur)) } -_kpod_history() { - local options_with_args=" +_kpod_diff() { + local options_with_args=" --format " - local boolean_options=" + local boolean_options=" + " + _complete_ "$options_with_args" "$boolean_options" + + case "$cur" in + -*) + COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur")) + ;; + *) + __kpod_list_images + ;; + esac +} + +_kpod_export() { + local options_with_args=" + --output + -o + " + local boolean_options=" + " + _complete_ "$options_with_args" "$boolean_options" + + case "$cur" in + -*) + COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur")) + ;; + *) + __kpod_list_images + ;; + esac +} + +_kpod_history() { + local options_with_args=" + --format + " + local boolean_options=" --human -H --no-trunc --quiet -q " - _complete_ "$options_with_args" "$boolean_options" + _complete_ "$options_with_args" "$boolean_options" case "$cur" in -*) @@ -47,6 +84,9 @@ _kpod_info() { -*) COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur")) ;; + *) + __kpod_list_images + ;; esac } @@ -76,12 +116,26 @@ _kpod_images() { esac } -_kpod_launch() { - local options_with_args=" +_kpod_inspect() { + local boolean_options=" + --help + -h " - local boolean_options=" - " - _complete_ "$options_with_args" "$boolean_options" + local options_with_args=" + --format + -f + --type + -t + --size + " + + local all_options="$options_with_args $boolean_options" + + case "$cur" in + -*) + COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur")) + ;; + esac } _kpod_logs() { @@ -314,15 +368,20 @@ _kpod_kpod() { --version -v " commands=" + diff + export history images info - launch + inspect load + logs mount pull push + rename rmi + save stats tag umount diff --git a/docs/kpod.1.md b/docs/kpod.1.md index d420ab40..d4635a45 100644 --- a/docs/kpod.1.md +++ b/docs/kpod.1.md @@ -70,6 +70,9 @@ Display a container or image's configuration ### load Load an image from docker archive +### logs +Display the logs of a container + ### mount Mount a working container's root filesystem @@ -88,6 +91,9 @@ 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 + ### tag Add an additional name to a local image diff --git a/docs/play.png b/docs/play.png new file mode 100644 index 0000000000000000000000000000000000000000..9be2868fdf87289472ba06069bb298b19089a3d4 GIT binary patch literal 1672 zcmV;326y?1P)Px#AY({UO#lFTCIA3{ga82g0001h=l}q9FaQARU;qF* zm;eA5aGbhPJOBUy24YJ`L;(K){{a7>y{D4^00ojsL_t(o!|j*fZ(P+8$LHL=yY_Cp zwqqx@;~zM&9qeE?p!`s9LJLG{Rf3X=mWN6pB;b`t-uV}Jqz_H|R8pykP$_8|0Y&^2 zC4fwv#H4ZTxLMcU*lQ>I!}s1Z^Bo?}db0^QSqB6!9UZOikvsB6~m2!nJ2n9eq=50(Rx?4AFZBMr~)z_lLtShUhvW2nC@=UH! zjM!6!s4&=qt%Q+;p`;T2{oTz6hC2qkntmAYaxwaJdhz07o=A<7FsubzVFp`B`9au9 z5Q^t{`$swt?YnQ|hQ#**XL60(sdm!wmkF8!Bm|eS)j`3?6u;=mF1ei|GicuC|eOLQ7A#kLBK)4D**>Vc^gGs z3hY}SPaXg8vSo2E9@yFW+!H%eb$%4xw40z8uPjyTU$a&(+*pCYsu5^Mb8@)1r9K{0 zRZ>zVy(uIDV@$qeTN-1kYK-~$LtTLW;f=4Z-w0JzL=~FJ7HR^Q0v3i4)hA-V9o^R3 zmZrOjbGTzax~n_8So-6eXGzIbn?f;EC1dUe29&K3Q6d>{Z%$V9)*_DG*VSZ**i|}F z#Vu#njB%asSu4U=TwWQwyhuc5ZE>GevBnq!=!aik4I_alpb$-^;*|q;vbZH(A4TwE zMxcLr`|A(JG6_GXs!Faft(GU%$f7Zoc>3T#=cWcCHO7eG&woF6;{7S-XAx!Smd&?x zi#5T$ZRscy@;xFdmhAcITsfzzkbp*!G$i9M93H-n`qxumGee=SsR%H%bz@E7zAfp7 zR9&$cRE3U+l#~eWm)N3dL*m85BL^PrbUywzRTv`Lwy9yqww9V=+}@lV>1z!mag~`Z ztn0q6p0I==Z>aZQI6S;cB@z7Tt#ilzG2uFu>m?9n#^|o@uGUmdU?O_#p{_*2x2rX) zf@Fq`;Ctr9!^4j}*i}UxKXz(@844;>86rqG)*pGS|2E}!0uS{xJ-)kVC1k0ZG~9$` zt!!#aKK!#S73$IB~C2In23%X*fz4gEr?{5TK2XuX0wHV zkIxYiphw>vfBocza$MOp5`bYDqkFoaIW+Wb&3B)at6ATeGFVliEGhy( zJt8faMs;<{LPz)Zy!`y$fv(2y)LH9zn=3?rd-u|b_a<*#Uoll|C{=o&t56K2o07kK zV(8f?hg#EhYbjjcK!0v}>EuUKpL{VppUo?j)J+-$sHlo+`{ss6_VoPbVE@kk);p_O zAK1xkt~4>VG%=ma%oXy*P?Z`|@y@n}p}y7!`dV(guRkQXT5f9(wadNyX}jga*N=4a z4XG3{JVuN5+yDRoC3HntbYx+4WjbSWWnpw>05UK!H!UzYEiy1vF)}(cGdeUdD=;!T zFfe2Iqk{kd03~!qSaf7zbY(hiZ)9m^c>ppnF*hwRI4v?TR53C-Gc!6gFe@-JIxsL2 Sr5is00000