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

Merge pull request #769 from rhatdan/debug

Browse source 
More cleanups of main man page kpod-1.md and README.md
This commit is contained in:
Mrunal Patel 2017-08-15 10:42:56 -07:00 committed by GitHub
commit a69631c1bd
7 changed files with 81 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -39,27 +39,35 @@ It is currently in active development in the Kubernetes community through the [d
## Commands
| Command | Description |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| [crio(8)](/docs/crio.8.md) | Enable OCI Kubernetes Container Runtime daemon |
| [kpod(1)](/docs/kpod.1.md) | Simple management tool for pods and images |
| [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-mount(1)](/docs/kpod-mount.1.md) | Mount a working container's root filesystem |
| [kpod-load(1)](/docs/kpod-load.1.md) | Load an image from docker archive or oci |
| [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-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 |
| [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-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-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 |
## Configuration
| File | Description |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| [crio.conf(5)](/docs/crio.conf.5.md) | CRI-O Configuation file |
## cri-o Usage Transfer
[Useful information for ops and dev transfer as it relates to infrastructure that utilizes cri-o](/transfer.md)
## Communication
For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation.

2
docs/kpod-info.1.md
View file

@ -3,7 +3,7 @@
% kpod-version "1" "JULY 2017" "kpod"
## NAME
kpod-info - Display System Information
kpod-info - Display system information
## SYNOPSIS

2
docs/kpod-load.1.md
View file

@ -3,7 +3,7 @@
# kpod-load "1" "July 2017" "kpod"
## NAME
kpod-load - load an image from docker archive
kpod-load - Load an image from docker archive
## SYNOPSIS
**kpod load**

2
docs/kpod-mount.1.md
View file

@ -3,7 +3,7 @@
# kpod-mount "1" "July 2017" "kpod"
## NAME
kpod mount - Mount a working container's root filesystem.
kpod mount - Mount a working container's root filesystem
## SYNOPSIS
**kpod** **mount**

2
docs/kpod-umount.1.md
View file

@ -3,7 +3,7 @@
# kpod-umount "1" "July 2017" "kpod"
## NAME
kpod umount - Unmount a working container's root file system.
kpod umount - Unmount a working container's root file system
## SYNOPSIS
**kpod** **umount** **containerID**

41
docs/kpod.1.md
View file

@ -46,17 +46,50 @@ has the capability to debug pods/images created by crio.
## 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
### load
Load an image from docker archive
### mount
Mount a working container's root filesystem
### pull
Pull an image from a registry
### push
Push an image from local storage to elsewhere
### rmi
Removes one or more locally stored images
### tag
Add one or more additional names to locally-stored image
### save
Save an image to docker-archive or oci
### info
Displays system information
### tag
Add an additional name to a local image
### umount
Unmount a working container's root file system
### version
Display the version information
## SEE ALSO
crio(8), crio.conf(5)

29
transfer.md
View file

@ -24,12 +24,12 @@ Following provides equivalent with cri-o tools for gathering information or jump
| Existing Step | CRI-O (and friends) |
| :---: | :---: |
| `docker info` | [`kpod info`](./docs/kpod-info.2.md) |
| `docker inspect` | [`kpod inspect`]() (TBD) |
| `docker stats` | [`crioctl ctr status`]() (TBD) |
| `docker exec` | [`crioctl ctr exec`](./docs/crio.8.md) |
| `docker info` | [`kpod info`](./docs/kpod-info.1.md) |
| `docker inspect` | [`kpod inspect`](./docs/kpod-inspect.1.md) |
| `docker logs` | `journalctl ...` |
| `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 logs` | [`kpod ...`]() (TBD) or `journalctl ...` |
| `docker stats` | `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.
@ -39,11 +39,16 @@ There are other equivalents for these tools
| Existing Step | CRI-O (and friends) |
| :---: | :---: |
| `docker images` | [`kpod images`](./docs/kpod-images.1.md) |
| `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) |
| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) |
| `docker pull` | [`kpod pull`](./docs/kpod-pull.1.md) |
| `docker load` | [`kpod load`](TBD) |
| `docker save` | [`kpod save`](TBD) |
| `docker build` | [`buildah bud`](https://github.com/projectatomic/buildah/blob/master/docs/buildah-bud.md) |
| `docker push` | [`buildah push`](https://github.com/projectatomic/buildah/blob/master/docs/buildah-push.md) |
| `docker build` | [`buildah bud`](https://github.com/projectatomic/buildah/blob/master/docs/buildah-bud.md) |
| `docker cp` | [`kpod mount`](./docs/kpod-cp.1.md) |
| `docker diff` | [`kpod diff`](./docs/kpod-diff.1.md) |
| `docker export` | [`kpod export`](./docs/kpod-export.1.md) |
| `docker history`| [`kpod history`](./docs/kpod-history.1.md)|
| `docker images` | [`kpod images`](./docs/kpod-images.1.md) |
| `docker load` | [`kpod load`](./docs/kpod-load.1.md) |
| `docker pull` | [`kpod pull`](./docs/kpod-pull.1.md) |
| `docker push` | [`kpod push`](./docs/kpod-push.1.md) |
| `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) |
| `docker save` | [`kpod save`](./docs/kpod-save.1.md) |
| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) |
| `docker version`| [`kpod version`](./docs/kpod-version.1.md)|