vbatts/cri-o
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update web site documentation for latest kpod

Browse source 
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 <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh 2017-08-17 15:12:24 -04:00
parent c0f3e02bae
commit 33201aff56
5 changed files with 101 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -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). 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 ## Commands
| Command | Description | | Command | Description | Demo|
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | ---------------------------------------------------- | --------------------------------------------------------------------------|-----|
| [crio(8)](/docs/crio.8.md) | OCI Kubernetes Container Runtime daemon | | [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(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-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-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-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-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-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-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-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 | | [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-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-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-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 | | [kpod-push(1)](/docs/kpod-push.1.md) | Push an image to a specified destination |[![...](/docs/play.png)](https://asciinema.org/a/133276)|
| [kpod-rmi(1)](/docs/kpod-rmi.1.md) | Removes one or more images | | [kpod-rename(1)](/docs/kpod-rename.1.md) | Rename a container ||
| [kpod-save(1)](/docs/kpod-save.1.md) | Saves an image to an archive | | [kpod-rmi(1)](/docs/kpod-rmi.1.md) | Removes one or more images |[![...](/docs/play.png)](https://asciinema.org/a/133799)|
| [kpod-stats(1)](/docs/kpod-stats.1.md) | Display a live stream of one or more containers' resource usage statistics | | [kpod-save(1)](/docs/kpod-save.1.md) | Saves an image to an archive |[![...](/docs/play.png)](https://asciinema.org/a/kp8kOaexEhEa20P1KLZ3L5X4g)|
| [kpod-tag(1)](/docs/kpod-tag.1.md) | Add an additional name to a local image | | [kpod-stats(1)](/docs/kpod-stats.1.md) | Display a live stream of one or more containers' resource usage statistics||
| [kpod-umount(1)](/docs/kpod-umount.1.md) | Unmount a working container's root filesystem | | [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-version(1)](/docs/kpod-version.1.md) | Display the Kpod version information | | [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 ## Configuration
| File | Description | | File | Description |

79
completions/bash/kpod
View file

@ -10,16 +10,53 @@ __kpod_list_containers() {
COMPREPLY=($(compgen -W "$(kpod ps -aq)" -- $cur)) COMPREPLY=($(compgen -W "$(kpod ps -aq)" -- $cur))
} }
_kpod_history() { _kpod_diff() {
local options_with_args=" local options_with_args="
--format --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 --human -H
--no-trunc --no-trunc
--quiet -q --quiet -q
" "
_complete_ "$options_with_args" "$boolean_options" _complete_ "$options_with_args" "$boolean_options"
case "$cur" in case "$cur" in
-*) -*)
@ -47,6 +84,9 @@ _kpod_info() {
-*) -*)
COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur")) COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur"))
;; ;;
*)
__kpod_list_images
;;
esac esac
} }
@ -76,12 +116,26 @@ _kpod_images() {
esac esac
} }
_kpod_launch() { _kpod_inspect() {
local options_with_args=" local boolean_options="
--help
-h
" "
local boolean_options=" local options_with_args="
" --format
_complete_ "$options_with_args" "$boolean_options" -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() { _kpod_logs() {
@ -314,15 +368,20 @@ _kpod_kpod() {
--version -v --version -v
" "
commands=" commands="
diff
export
history history
images images
info info
launch inspect
load load
logs
mount mount
pull pull
push push
rename
rmi rmi
save
stats stats
tag tag
umount umount

6
docs/kpod.1.md
View file

@ -70,6 +70,9 @@ Display a container or image's configuration
### load ### load
Load an image from docker archive Load an image from docker archive
### logs
Display the logs of a container
### mount ### mount
Mount a working container's root filesystem Mount a working container's root filesystem
@ -88,6 +91,9 @@ Removes one or more locally stored images
### save ### save
Save an image to docker-archive or oci Save an image to docker-archive or oci
### stats
Display a live stream of one or more containers' resource usage statistics
### tag ### tag
Add an additional name to a local image Add an additional name to a local image

BIN
docs/play.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.6 KiB

5
transfer.md
View file

@ -27,9 +27,9 @@ Following provides equivalent with cri-o tools for gathering information or jump
| `docker exec` | [`crioctl ctr exec`](./docs/crio.8.md) | | `docker exec` | [`crioctl ctr exec`](./docs/crio.8.md) |
| `docker info` | [`kpod info`](./docs/kpod-info.1.md) | | `docker info` | [`kpod info`](./docs/kpod-info.1.md) |
| `docker inspect` | [`kpod inspect`](./docs/kpod-inspect.1.md) | | `docker inspect` | [`kpod inspect`](./docs/kpod-inspect.1.md) |
| `docker logs` | `journalctl ...` | | `docker logs` | [`kpod logs`](./docs/kpod-logs.1.md) |
| `docker ps` | [`crioctl ctr list`](./docs/crio.8.md) or [`runc list`](https://github.com/opencontainers/runc/blob/master/man/runc-list.8.md) | | `docker ps` | [`crioctl ctr list`](./docs/crio.8.md) or [`runc list`](https://github.com/opencontainers/runc/blob/master/man/runc-list.8.md) |
| `docker stats` | `crioctl ctr status`| | `docker stats` | [`kpod stats`](./docs/kpod-stats.1.md) or `crioctl ctr status`|
If you were already using steps like `kubectl exec` (or `oc exec` on OpenShift), they will continue to function the same way. If you were already using steps like `kubectl exec` (or `oc exec` on OpenShift), they will continue to function the same way.
@ -48,6 +48,7 @@ There are other equivalents for these tools
| `docker load` | [`kpod load`](./docs/kpod-load.1.md) | | `docker load` | [`kpod load`](./docs/kpod-load.1.md) |
| `docker pull` | [`kpod pull`](./docs/kpod-pull.1.md) | | `docker pull` | [`kpod pull`](./docs/kpod-pull.1.md) |
| `docker push` | [`kpod push`](./docs/kpod-push.1.md) | | `docker push` | [`kpod push`](./docs/kpod-push.1.md) |
| `docker rename` | [`kpod rename`](./docs/kpod-rename.1.md) |
| `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) | | `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) |
| `docker save` | [`kpod save`](./docs/kpod-save.1.md) | | `docker save` | [`kpod save`](./docs/kpod-save.1.md) |
| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) | | `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) |