Merge pull request #10487 from rhatdan/docs

[CI:DOCS] Update a way out of date transfer document
2024-10-19 16:54:07 +00:00 · 2021-05-28 12:18:41 +02:00 · 2021-05-28 12:18:41 +02:00 · 3d6c19c8be
parent aa1e15961e 5bd1b7dfd5
commit 3d6c19c8be
1 changed files with 84 additions and 32 deletions
--- a/transfer.md
+++ b/transfer.md
@ -9,7 +9,7 @@ This document outlines useful information for ops and dev transfer as it relates

 Podman is a tool for managing Pods, Containers, and Container Images.  The CLI
 for Podman is based on the Docker CLI, although Podman does not require a
-runtime daemon to be running in order to function.
+runtime daemon to be running in order to function. Podman also supports the Docker API via the Podman socket activated system service.

 ## System Tools

@ -21,81 +21,94 @@ As well as some systemd helpers like `systemd-cgls` and `systemd-cgtop` are stil
 For many troubleshooting and information collection steps, there may be an existing pattern.
 Following provides equivalent with `Podman` tools for gathering information or jumping into containers, for operational use.

-| Existing Step | `Podman` (and friends) |
-| :--- | :--- |
-| `docker run`  | [`podman run`](./docs/source/markdown/podman-run.1.md) |
-| `docker exec` | [`podman exec`](./docs/source/markdown/podman-exec.1.md) |
-| `docker info` | [`podman info`](./docs/source/markdown/podman-info.1.md)  |
-| `docker inspect` | [`podman inspect`](./docs/source/markdown/podman-inspect.1.md)       |
-| `docker logs` | [`podman logs`](./docs/source/markdown/podman-logs.1.md)                 |
-| `docker ps`   | [`podman ps`](./docs/source/markdown/podman-ps.1.md) |
-| `docker stats`| [`podman stats`](./docs/source/markdown/podman-stats.1.md)|
-
 ## Development Transfer

 There are other equivalents for these tools

 | Existing Step | `Podman` (and friends) |
 | :--- | :--- |
+| `docker `        | [`podman`](./docs/source/markdown/podman.1.md)                  |
 | `docker attach`  | [`podman attach`](./docs/source/markdown/podman-attach.1.md)    |
+| `docker auto-update`|[`podman auto-update`](./docs/source/markdown/podman-auto-update.1.md)|
 | `docker build`   | [`podman build`](./docs/source/markdown/podman-build.1.md)      |
 | `docker commit`  | [`podman commit`](./docs/source/markdown/podman-commit.1.md)    |
-| `docker container`|[`podman container`](./docs/source/markdown/podman-container.1.md) |
+| `docker container `|[`podman container`](./docs/source/markdown/podman-container.1.md) |
+| `docker container prune`|[`podman container prune`](./docs/source/markdown/podman-container-prune.1.md) |
 | `docker cp`      | [`podman cp`](./docs/source/markdown/podman-cp.1.md)            |
 | `docker create`  | [`podman create`](./docs/source/markdown/podman-create.1.md)    |
 | `docker diff`    | [`podman diff`](./docs/source/markdown/podman-diff.1.md)        |
 | `docker events`  | [`podman events`](./docs/source/markdown/podman-events.1.md)    |
+| `docker exec`    | [`podman exec`](./docs/source/markdown/podman-exec.1.md)        |
 | `docker export`  | [`podman export`](./docs/source/markdown/podman-export.1.md)    |
 | `docker history` | [`podman history`](./docs/source/markdown/podman-history.1.md)  |
-| `docker image`   | [`podman image`](./docs/source/markdown/podman-image.1.md)        |
+| `docker image`   | [`podman image`](./docs/source/markdown/podman-image.1.md)      |
 | `docker images`  | [`podman images`](./docs/source/markdown/podman-images.1.md)    |
 | `docker import`  | [`podman import`](./docs/source/markdown/podman-import.1.md)    |
+| `docker info`    | [`podman info`](./docs/source/markdown/podman-info.1.md)        |
+| `docker inspect` | [`podman inspect`](./docs/source/markdown/podman-inspect.1.md)  |
 | `docker kill`    | [`podman kill`](./docs/source/markdown/podman-kill.1.md)        |
 | `docker load`    | [`podman load`](./docs/source/markdown/podman-load.1.md)        |
 | `docker login`   | [`podman login`](./docs/source/markdown/podman-login.1.md)      |
 | `docker logout`  | [`podman logout`](./docs/source/markdown/podman-logout.1.md)    |
-| `docker network create`  | [`podman network create`](./docs/source/markdown/podman-network-create.1.md)   |
-| `docker network inspect` | [`podman network inspect`](./docs/source/markdown/podman-network-inspect.1.md) |
-| `docker network ls`      | [`podman network ls`](./docs/source/markdown/podman-network-ls.1.md)           |
-| `docker network rm`      | [`podman network rm`](./docs.source/markdown/podman-network-rm.1.md)           |
+| `docker logs` | [`podman logs`](./docs/source/markdown/podman-logs.1.md)           |
+| `docker manifest `| [`podman manifest`](./docs.source/markdown/podman-manifest.1.md)           |
+| `docker manifest annotate`  | [`podman manifest annotate`](./docs/source/markdown/podman-manifest-annotate.1.md)   |
+| `docker manifest create` | [`podman manifest create`](./docs/source/markdown/podman-manifest-create.1.md)   |
+| `docker manifest inspect`| [`podman manifest inspect`](./docs/source/markdown/podman-manifest-inspect.1.md) |
+| `docker manifest push`   | [`podman manifest push`](./docs/source/markdown/podman-manifest-push.1.md)       |
+| `docker manifest rm`     | [`podman manifest rm`](./docs.source/markdown/podman-manifest-rm.1.md)           |
+| `docker network `        | [`podman network`](./docs.source/markdown/podman-network.1.md)                   |
+| `docker network connect` | [`podman network connect`](./docs/source/markdown/podman-network-connect.1.md)   |
+| `docker network create`  | [`podman network create`](./docs/source/markdown/podman-network-create.1.md)     |
+| `docker network disconnect`| [`podman network disconnect`](./docs/source/markdown/podman-network-disconnect.1.md)|
+| `docker network inspect` | [`podman network inspect`](./docs/source/markdown/podman-network-inspect.1.md)   |
+| `docker network ls`      | [`podman network ls`](./docs/source/markdown/podman-network-ls.1.md)             |
+| `docker network rm`      | [`podman network rm`](./docs.source/markdown/podman-network-rm.1.md)             |
 | `docker pause`   | [`podman pause`](./docs/source/markdown/podman-pause.1.md)      |
 | `docker port`    | [`podman port`](./docs/source/markdown/podman-port.1.md)        |
 | `docker ps`      | [`podman ps`](./docs/source/markdown/podman-ps.1.md)            |
 | `docker pull`    | [`podman pull`](./docs/source/markdown/podman-pull.1.md)        |
 | `docker push`    | [`podman push`](./docs/source/markdown/podman-push.1.md)        |
+| `docker rename`  | [`podman rename`](./docs/source/markdown/podman-rename.1.md)    |
 | `docker restart` | [`podman restart`](./docs/source/markdown/podman-restart.1.md)  |
 | `docker rm`      | [`podman rm`](./docs/source/markdown/podman-rm.1.md)            |
 | `docker rmi`     | [`podman rmi`](./docs/source/markdown/podman-rmi.1.md)          |
 | `docker run`     | [`podman run`](./docs/source/markdown/podman-run.1.md)          |
 | `docker save`    | [`podman save`](./docs/source/markdown/podman-save.1.md)        |
 | `docker search`  | [`podman search`](./docs/source/markdown/podman-search.1.md)    |
+| `docker secret ` | [`podman secret`](./docs/source/markdown/podman-secret.1.md)    |
+| `docker secret create`  | [`podman secret`](./docs/source/markdown/podman-secret-create.1.md)  |
+| `docker secret inspect`  | [`podman secret`](./docs/source/markdown/podman-secret-inspect.1.md)|
+| `docker secret ls`  | [`podman secret`](./docs/source/markdown/podman-secret-ls.1.md)|
+| `docker secret rm`  | [`podman secret`](./docs/source/markdown/podman-secret-rm.1.md)|
+| `docker service` | [`podman service`](./docs/source/markdown/podman-service.1.md)  |
 | `docker start`   | [`podman start`](./docs/source/markdown/podman-start.1.md)      |
+| `docker stats`   | [`podman stats`](./docs/source/markdown/podman-stats.1.md)      |
 | `docker stop`    | [`podman stop`](./docs/source/markdown/podman-stop.1.md)        |
-| `docker system df`     | [`podman system df`](./docs/source/markdown/podman-system-df.1.md)          |
-| `docker system info`   | [`podman system info`](./docs/source/markdown/podman-system-info.1.md)      |
-| `docker system prune`  | [`podman system prune`](./docs/source/markdown/podman-system-prune.1.md)    |
-| `docker system`        | [`podman system`](./docs/source/markdown/podman-system.1.md)                |
+| `docker system ` | [`podman system`](./docs/source/markdown/podman-system.1.md)    |
+| `docker system df`     | [`podman system df`](./docs/source/markdown/podman-system-df.1.md)      |
+| `docker system info`   | [`podman system info`](./docs/source/markdown/podman-system-info.1.md)  |
+| `docker system prune`  | [`podman system prune`](./docs/source/markdown/podman-system-prune.1.md)|
 | `docker tag`     | [`podman tag`](./docs/source/markdown/podman-tag.1.md)          |
 | `docker top`     | [`podman top`](./docs/source/markdown/podman-top.1.md)          |
 | `docker unpause` | [`podman unpause`](./docs/source/markdown/podman-unpause.1.md)  |
 | `docker version` | [`podman version`](./docs/source/markdown/podman-version.1.md)  |
+| `docker volume        `| [`podman volume`](./docs/source/markdown/podman-volume.1.md)		       |
 | `docker volume create` | [`podman volume create`](./docs/source/markdown/podman-volume-create.1.md)  |
 | `docker volume inspect`| [`podman volume inspect`](./docs/source/markdown/podman-volume-inspect.1.md)|
 | `docker volume ls`     | [`podman volume ls`](./docs/source/markdown/podman-volume-ls.1.md)          |
 | `docker volume prune`  | [`podman volume prune`](./docs/source/markdown/podman-volume-prune.1.md)    |
 | `docker volume rm`     | [`podman volume rm`](./docs/source/markdown/podman-volume-rm.1.md)          |
-| `docker volume`  | [`podman volume`](./docs/source/markdown/podman-volume.1.md)			|
 | `docker wait`          | [`podman wait`](./docs/source/markdown/podman-wait.1.md)		       |

-**** 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.
-
 ## Behavioural differences and pitfalls

 These commands behave differently from the commands in Docker:

 | Command | Description |
 | :--- | :--- |
-| `podman volume create` | While `docker volume create` is idempotent, `podman volume create` raises an error if the volume does already exist. See this [docker issue](https://github.com/moby/moby/issues/16068) for more information.|
+| `podman volume create`                | While `docker volume create` is idempotent, `podman volume create` raises an error if the volume does already exist. See this [docker issue](https://github.com/moby/moby/issues/16068) for more information.|
+| `podman run -v /tmp/noexist:/tmp ...` | While `docker run -v /tmp/noexist:/tmp` will create non existing volumes on the host, Podman will report that the volume does not exist. The Podman team sees this as a bug in Docker.|

 ## Missing commands in podman

@ -103,14 +116,17 @@ Those Docker commands currently do not have equivalents in `podman`:

 | Missing command | Description|
 | :--- | :--- |
-| `docker container rename`   | podman does not support `container rename` - or the `rename` shorthand. We recommend using `podman rm` and  `podman create` to create a container with a specific name.|
+| `docker builder`  ||
+| `docker buildx`   ||
+| `docker config`   ||
+| `docker context`  ||
 | `docker container update`  | podman does not support altering running containers. We recommend recreating containers with the correct arguments.|
 | `docker node`     ||
 | `docker plugin`   | podman does not support plugins.  We recommend you use alternative OCI Runtimes or OCI Runtime Hooks to alter behavior of podman.|
-| `docker secret`   ||
-| `docker service`  ||
 | `docker stack`    ||
 | `docker swarm`    | podman does not support swarm.  We support Kubernetes for orchestration using [CRI-O](https://github.com/cri-o/cri-o).|
+| `docker trust`    |[`podman image trust`](./docs/source/markdown/podman-image-trust.1.md)          |
+| `docker update`   ||

 ## Missing commands in Docker

@ -122,26 +138,62 @@ The following podman commands do not have a Docker equivalent:
 * [`podman container refresh`](/docs/source/markdown/podman-container-refresh.1.md)
 * [`podman container restore`](/docs/source/markdown/podman-container-restore.1.md)
 * [`podman container runlabel`](/docs/source/markdown/podman-container-runlabel.1.md)
+* [`podman generate `](./docs/source/markdown/podman-generate.1.md)
 * [`podman generate kube`](./docs/source/markdown/podman-generate-kube.1.md)
-* [`podman generate`](./docs/source/markdown/podman-generate.1.md)
-* [`podman healthcheck run`](/docs/source/markdown/podman-healthcheck-run.1.md)
+* [`podman generate systemd`](./docs/source/markdown/podman-generate-systemd.1.md)
+* [`podman healthcheck `](/docs/source/markdown/podmanh-healthcheck.1.md)
+* [`podman healthcheck run`](/docs/source/markdown/podmanh-healthcheck-run.1.md)
+* [`podman image diff`](./docs/source/markdown/podman-image-diff.1.md)
 * [`podman image exists`](./docs/source/markdown/podman-image-exists.1.md)
+* [`podman image mount`](./docs/source/markdown/podman-image-mount.1.md)
+* [`podman image prune`](./docs/source/markdown/podman-image-prune.1.md)
 * [`podman image sign`](./docs/source/markdown/podman-image-sign.1.md)
+* [`podman image tree`](./docs/source/markdown/podman-image-tree.1.md)
 * [`podman image trust`](./docs/source/markdown/podman-image-trust.1.md)
+* [`podman image unmount`](./docs/source/markdown/podman-image-unmount.1.md)
+* [`podman init`](./docs/source/markdown/podman-init.1.md)
+* [`podman machine `](./docs/source/markdown/podman-machine.1.md)
+* [`podman machine init`](./docs/source/markdown/podman-machine-init.1.md)
+* [`podman machine list`](./docs/source/markdown/podman-machine-list.1.md)
+* [`podman machine rm`](./docs/source/markdown/podman-machine-rm.1.md)
+* [`podman machine ssh`](./docs/source/markdown/podman-machine-ssh.1.md)
+* [`podman machine start`](./docs/source/markdown/podman-machine-start.1.md)
+* [`podman machine stop`](./docs/source/markdown/podman-machine-stop.1.md)
+* [`podman manifest add`](./docs/source/markdown/podman-manifest-add.1.md)
+* [`podman manifest exists`](./docs/source/markdown/podman-manifest-exists.1.md)
+* [`podman manifest remove`](./docs/source/markdown/podman-manifest-remove.1.md)
 * [`podman mount`](./docs/source/markdown/podman-mount.1.md)
+* [`podman network exists`](./docs/source/markdown/podman-network-exists.1.md)
+* [`podman network prune`](./docs/source/markdown/podman-network-prune.1.md)
+* [`podman network reload`](./docs/source/markdown/podman-network-reload.1.md)
+* [`podman play `](./docs/source/markdown/podman-play.1.md)
 * [`podman play kube`](./docs/source/markdown/podman-play-kube.1.md)
-* [`podman play`](./docs/source/markdown/podman-play.1.md)
+* [`podman pod `](./docs/source/markdown/podman-pod.1.md)
 * [`podman pod create`](./docs/source/markdown/podman-pod-create.1.md)
 * [`podman pod exists`](./docs/source/markdown/podman-pod-exists.1.md)
 * [`podman pod inspect`](./docs/source/markdown/podman-pod-inspect.1.md)
 * [`podman pod kill`](./docs/source/markdown/podman-pod-kill.1.md)
 * [`podman pod pause`](./docs/source/markdown/podman-pod-pause.1.md)
+* [`podman pod prune`](./docs/source/markdown/podman-pod-prune.1.md)
 * [`podman pod ps`](./docs/source/markdown/podman-pod-ps.1.md)
 * [`podman pod restart`](./docs/source/markdown/podman-pod-restart.1.md)
 * [`podman pod rm`](./docs/source/markdown/podman-pod-rm.1.md)
 * [`podman pod start`](./docs/source/markdown/podman-pod-start.1.md)
+* [`podman pod stats`](./docs/source/markdown/podman-pod-stats.1.md)
 * [`podman pod stop`](./docs/source/markdown/podman-pod-stop.1.md)
 * [`podman pod top`](./docs/source/markdown/podman-pod-top.1.md)
 * [`podman pod unpause`](./docs/source/markdown/podman-pod-unpause.1.md)
-* [`podman pod`](./docs/source/markdown/podman-pod.1.md)
+* [`podman system connection `](./docs/source/markdown/podman-system-connection.1.md)
+* [`podman system connection add`](./docs/source/markdown/podman-system-connection-add.1.md)
+* [`podman system connection default`](./docs/source/markdown/podman-system-connection-default.1.md)
+* [`podman system connection list`](./docs/source/markdown/podman-system-connection-list.1.md)
+* [`podman system connection remove`](./docs/source/markdown/podman-system-connection-remove.1.md)
+* [`podman system connection rename`](./docs/source/markdown/podman-system-connection-rename.1.md)
+* [`podman system migrate`](./docs/source/markdown/podman-system-connection-migrate.1.md)
+* [`podman system renumber`](./docs/source/markdown/podman-system-connection-renumber.1.md)
+* [`podman system reset`](./docs/source/markdown/podman-system-connection-reset.1.md)
+* [`podman system service`](./docs/source/markdown/podman-system-connection-service.1.md)
 * [`podman umount`](./docs/source/markdown/podman-umount.1.md)
+* [`podman unshare`](./docs/source/markdown/podman-unshare.1.md)
+* [`podman untag`](./docs/source/markdown/podman-untag.1.md)
+* [`podman volume exists`](./docs/source/markdown/podman-volume-exists.1.md)