Rename all references to kpod to podman

The decision is in, kpod is going to be named podman.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #145
Approved by: umohnani8
This commit is contained in:
Daniel J Walsh
2017-12-15 16:58:36 -05:00
committed by Atomic Bot
parent de3468e120
commit 5770dc2640
149 changed files with 2389 additions and 20841 deletions

View File

@ -1,15 +1,15 @@
# KPOD Usage Transfer
# PODMAN Usage Transfer
This document outlines useful information for ops and dev transfer as it relates to infrastructure that utilizes KPOD.
This document outlines useful information for ops and dev transfer as it relates to infrastructure that utilizes PODMAN.
## Operational Transfer
## Abstract
The `crio` daemon is intended to provide the [CRI](https://github.com/kubernetes/community/blob/master/contributors/devel/container-runtime-interface.md) socket needed for Kubernetes to use for automating deployment, scaling, and management of containerized applications (See the document for [configuring kubernetes to use KPOD](./kubernetes.md) for more information on that).
The `crio` daemon is intended to provide the [CRI](https://github.com/kubernetes/community/blob/master/contributors/devel/container-runtime-interface.md) socket needed for Kubernetes to use for automating deployment, scaling, and management of containerized applications (See the document for [configuring kubernetes to use PODMAN](./kubernetes.md) for more information on that).
Therefore the `crioctl` command line is a client that interfaces to the same grpc socket as the kubernetes daemon would, for talking to the `crio` daemon.
In many ways `crioctl` is only as feature rich as the Kubernetes CRI requires.
There are additional tools e.g. `kpod` and [`buildah`](https://github.com/projectatomic/buildah) that provide a feature rich set of commands for all operational needs in a Kubernetes environment.
There are additional tools e.g. `podman` and [`buildah`](https://github.com/projectatomic/buildah) that provide a feature rich set of commands for all operational needs in a Kubernetes environment.
## System Tools
@ -20,56 +20,56 @@ As well as some systemd helpers like `systemd-cgls` and `systemd-cgtop` are stil
## Equivalents
For many troubleshooting and information collection steps, there may be an existing pattern.
Following provides equivalent with KPOD tools for gathering information or jumping into containers, for operational use.
Following provides equivalent with PODMAN tools for gathering information or jumping into containers, for operational use.
| Existing Step | KPOD (and friends) |
| Existing Step | PODMAN (and friends) |
| :---: | :---: |
| `docker exec` | [`kpod exec`](./docs/kpod-exec.1.md) |
| `docker info` | [`kpod info`](./docs/kpod-info.1.md) |
| `docker inspect` | [`kpod inspect`](./docs/kpod-inspect.1.md) |
| `docker logs` | [`kpod logs`](./docs/kpod-logs.1.md) |
| `docker ps` | [`kpod ps`](./docs/kpod-ps.1.md) |
| `docker stats` | [`kpod stats`](./docs/kpod-stats.1.md)|
| `docker exec` | [`podman exec`](./docs/podman-exec.1.md) |
| `docker info` | [`podman info`](./docs/podman-info.1.md) |
| `docker inspect` | [`podman inspect`](./docs/podman-inspect.1.md) |
| `docker logs` | [`podman logs`](./docs/podman-logs.1.md) |
| `docker ps` | [`podman ps`](./docs/podman-ps.1.md) |
| `docker stats` | [`podman stats`](./docs/podman-stats.1.md)|
## Development Transfer
There are other equivalents for these tools
| Existing Step | KPOD (and friends) |
| Existing Step | PODMAN (and friends) |
| :---: | :---: |
| `docker attach` | [`kpod exec`](./docs/kpod-attach.1.md) ***|
| `docker attach` | [`podman exec`](./docs/podman-attach.1.md) ***|
| `docker build` | [`buildah bud`](https://github.com/projectatomic/buildah/blob/master/docs/buildah-bud.md) |
| `docker commit` | [`buildah commit`](https://github.com/projectatomic/buildah/blob/master/docs/buildah-commit.md) |
| `docker cp` | [`kpod mount`](./docs/kpod-cp.1.md) **** |
| `docker create` | [`kpod create`](./docs/kpod-create.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 kill` | [`kpod kill`](./docs/kpod-kill.1.md) |
| `docker load` | [`kpod load`](./docs/kpod-load.1.md) |
| `docker login` | [`kpod login`](./docs/kpod-login.1.md) |
| `docker logout` | [`kpod logout`](./docs/kpod-logout.1.md) |
| `docker pause` | [`kpod pause`](./docs/kpod-pause.1.md) |
| `docker ps` | [`kpod ps`](./docs/kpod-ps.1.md) |
| `docker pull` | [`kpod pull`](./docs/kpod-pull.1.md) |
| `docker push` | [`kpod push`](./docs/kpod-push.1.md) |
| `docker rm` | [`kpod rm`](./docs/kpod-rm.1.md) |
| `docker rmi` | [`kpod rmi`](./docs/kpod-rmi.1.md) |
| `docker run` | [`kpod run`](./docs/kpod-run.1.md) |
| `docker save` | [`kpod save`](./docs/kpod-save.1.md) |
| `docker stop` | [`kpod stop`](./docs/kpod-stop.1.md) |
| `docker tag` | [`kpod tag`](./docs/kpod-tag.1.md) |
| `docker unpause`| [`kpod unpause`](./docs/kpod-unpause.1.md)|
| `docker version`| [`kpod version`](./docs/kpod-version.1.md)|
| `docker wait` | [`kpod wait`](./docs/kpod-wait.1.md) |
| `docker cp` | [`podman mount`](./docs/podman-cp.1.md) **** |
| `docker create` | [`podman create`](./docs/podman-create.1.md) |
| `docker diff` | [`podman diff`](./docs/podman-diff.1.md) |
| `docker export` | [`podman export`](./docs/podman-export.1.md) |
| `docker history`| [`podman history`](./docs/podman-history.1.md)|
| `docker images` | [`podman images`](./docs/podman-images.1.md) |
| `docker kill` | [`podman kill`](./docs/podman-kill.1.md) |
| `docker load` | [`podman load`](./docs/podman-load.1.md) |
| `docker login` | [`podman login`](./docs/podman-login.1.md) |
| `docker logout` | [`podman logout`](./docs/podman-logout.1.md) |
| `docker pause` | [`podman pause`](./docs/podman-pause.1.md) |
| `docker ps` | [`podman ps`](./docs/podman-ps.1.md) |
| `docker pull` | [`podman pull`](./docs/podman-pull.1.md) |
| `docker push` | [`podman push`](./docs/podman-push.1.md) |
| `docker rm` | [`podman rm`](./docs/podman-rm.1.md) |
| `docker rmi` | [`podman rmi`](./docs/podman-rmi.1.md) |
| `docker run` | [`podman run`](./docs/podman-run.1.md) |
| `docker save` | [`podman save`](./docs/podman-save.1.md) |
| `docker stop` | [`podman stop`](./docs/podman-stop.1.md) |
| `docker tag` | [`podman tag`](./docs/podman-tag.1.md) |
| `docker unpause`| [`podman unpause`](./docs/podman-unpause.1.md)|
| `docker version`| [`podman version`](./docs/podman-version.1.md)|
| `docker wait` | [`podman wait`](./docs/podman-wait.1.md) |
*** Use `kpod exec` to enter a container and `kpod logs` to view the output of pid 1 of a container.
**** Use mount to take advantage of the entire linux tool chain rather then just cp. Read [`here`](./docs/kpod-cp.1.md) for more information.
*** Use `podman exec` to enter a container and `podman logs` to view the output of pid 1 of a container.
**** Use mount to take advantage of the entire linux tool chain rather then just cp. Read [`here`](./docs/podman-cp.1.md) for more information.
## Missing commands in kpod
## Missing commands in podman
Those Docker commands currently do not have equivalents in `kpod`:
Those Docker commands currently do not have equivalents in `podman`:
* `docker container`
* `docker events`
@ -91,7 +91,7 @@ Those Docker commands currently do not have equivalents in `kpod`:
## Missing commands in Docker
The following kpod commands do not have a Docker equivalent:
The following podman commands do not have a Docker equivalent:
* [`kpod mount`](./docs/kpod-mount.1.md)
* [`kpod umount`](./docs/kpod-umount.1.md)
* [`podman mount`](./docs/podman-mount.1.md)
* [`podman umount`](./docs/podman-umount.1.md)