[skip ci] Formalize our compare-against-docker mechanism

[edsantiago]

Long-term followup to #14917. This adds a new one-off script, to be run periodically, which runs our man-page crossref against docker, highlighting commands and options that docker lists in its --help but we don't list in our man pages.

Signed-off-by: Ed Santiago [email protected]

None

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: edsantiago

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [edsantiago]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[edsantiago]

Suggestion: rather than keep updating 14917, let's just close it. Once this PR merges (with a complete list of hidden options), create a new issue.

[edsantiago]

Someone please run this script, see what it spits out, then amend this list as needed.

[rhatdan]

docker manifest push --insecure #hidden

[edsantiago]

Marking as draft until someone gives me the exact list of hidden options

[mheon]

I think create --runtime is another one. We have --runtime as a global flag in Podman, not a per-command flag.

[vrothberg]

LGTM

[edsantiago]

Okay, I added podman manifest push --insecure and all --runtime options that leaves this list, which still seems a little excessive?

• docker --tls
• docker --tlscacert
• docker --tlscert
• docker --tlskey
• docker --tlsverify
• docker -l
• docker builder
• docker config
• docker container cp --follow-link
• docker container cp -L
• docker container create --domainname
• docker container create --isolation
• docker container create --kernel-memory
• docker container create --link
• docker container create --link-local-ip
• docker container create --storage-opt
• docker container create --volume-driver
• docker container logs --details
• docker container ls
• docker container rm --link
• docker container run --domainname
• docker container run --gpus
• docker container run --isolation
• docker container run --kernel-memory
• docker container run --link
• docker container run --link-local-ip
• docker container run --storage-opt
• docker container run --volume-driver
• docker container update --kernel-memory
• docker container update --pids-limit
• docker container update --restart
• docker context
• docker cp --follow-link
• docker cp -L
• docker create --domainname
• docker create --isolation
• docker create --kernel-memory
• docker create --link
• docker create --link-local-ip
• docker create --storage-opt
• docker create --volume-driver
• docker image import --platform
• docker image ls
• docker image push --all-tags
• docker image push -a
• docker import --platform
• docker logs --details
• docker manifest inspect --insecure
• docker manifest inspect --verbose
• docker manifest inspect -v
• docker manifest push --purge
• docker manifest push -p
• docker network connect --driver-opt
• docker network connect --link
• docker network connect --link-local-ip
• docker network create --attachable
• docker network create --aux-address
• docker network create --config-from
• docker network create --config-only
• docker network create --ingress
• docker network create --ipam-opt
• docker network create --scope
• docker network inspect --verbose
• docker network inspect -v
• docker push --all-tags
• docker push -a
• docker rm --link
• docker run --domainname
• docker run --isolation
• docker run --link
• docker run --link-local-ip
• docker run --storage-opt
• docker run --volume-driver
• docker secret create --template-driver
• docker service
• docker stack
• docker system events
• docker trust
• docker update --kernel-memory
• docker update --pids-limit
• docker update --restart
• docker version --kubeconfig
• docker volume create -d

[mheon]

docker container run --gpus
docker container run --isolation
docker container run --kernel-memory
docker container run --link

All of these (plus their container create counterparts) are known. Isolation is for Windows containers only, kernel-memory is gone from CGroups v2 and as such is hidden in Podman, gpus and link are not implemented and not likely to be (we don't require Docker's OCI runtime hacks for GPUs, and --link is deprecated in Docker and we have no intention of duplicating).

[mheon]

docker context is available in Podman but hidden.

[mheon]

docker service
docker stack

These are both swarm commands, no intention of adding

[edsantiago]

Thanks. Re-pushed with your additions, and some fixes (anchors, so --link doesn't hide --link-local-ip), refactoring, comments. New output is:

• docker --tls
• docker --tlscacert
• docker --tlscert
• docker --tlskey
• docker --tlsverify
• docker -l # Can't do, since cobra would have a hard time with this overriding podman stop -l type commands
• docker builder #Hidden
• docker config #Hidden
• docker container cp --follow-link [WIP] Add support for podman cp --follow-link #15730
• docker container cp -L [WIP] Add support for podman cp --follow-link #15730
• docker container create --domainname add support for podman create/run --domainname #15200
• docker container create --link-local-ip
• docker container create --storage-opt # this is a legal command, just we document under podman command.
• docker container create --volume-driver
• docker container logs --details #hidden
• docker container run --domainname add support for podman create/run --domainname #15200
• docker container run --link-local-ip
• docker container run --storage-opt # this is a legal command, just we document under podman command.
• docker container run --volume-driver
• docker container update --pids-limit
• docker container update --restart
• docker cp --follow-link [WIP] Add support for podman cp --follow-link #15730
• docker cp -L [WIP] Add support for podman cp --follow-link #15730
• docker create --domainname add support for podman create/run --domainname #15200
• docker create --link-local-ip
• docker create --storage-opt # this is a legal command, just we document under podman command.
• docker create --volume-driver
• docker image import --platform
• docker image ls # this alias exists, you can do podman image ls
• docker image push --all-tags
• docker image push -a
• docker import --platform
• docker logs --details #hidden
• docker manifest inspect --insecure #hidden
• docker manifest inspect --verbose #hidden
• docker manifest inspect -v Add hidden podman manifest inspect -v option #16462
• docker manifest push --purge #hidden
• docker manifest push -p Allow podman manifest push --purge|-p as alias for --rm #16466
• docker network connect --driver-opt
• docker network connect --link-local-ip
• docker network create --attachable
• docker network create --aux-address
• docker network create --config-from
• docker network create --config-only
• docker network create --ingress
• docker network create --ipam-opt
• docker network create --scope
• docker network inspect --verbose
• docker network inspect -v
• docker push --all-tags
• docker push -a
• docker run --domainname add support for podman create/run --domainname #15200
• docker run --link-local-ip
• docker run --storage-opt # this is a legal command, just we document under podman command.
• docker run --volume-driver
• docker secret create --template-driver
• docker system events Add podman system events alias to podman events #16464
• docker trust Add hidden trust command to alias existing trust commands #16463
• docker update --pids-limit
• docker update --restart
• docker version --kubeconfig
• docker volume create -d Add podman volume create -d short option for driver #16467

...and I've removed Draft status. Once this merges I will want to close #14917 and open a new PR, instead of just updating comment-0 in 14917. LMK if that's not OK.

[rhatdan]

@cdoern Is this possible docker container update --pids-limit with current design of update?

[rhatdan]

@umohnani8 docker version --kubeconfig does this make any sense for us? IE Do we have a default kubeconfig?

[edsantiago]

docker config #Hidden

@rhatdan are you sure about this?

$ bin/podman config
Error: unrecognized command `podman config`
Try 'podman --help' for more information

I've applied your other deltas and re-pushed. Rather than post a new list, here are the subtractions:

• docker container create --storage-opt
• docker container logs --details
• docker container run --storage-opt
• docker create --storage-opt
• docker image ls
• docker logs --details
• docker manifest inspect --insecure
• docker manifest inspect --verbose
• docker manifest push --purge
• docker run --storage-opt

[mheon]

I think we have podman --config but no podman config yet. Not seen that command before in the wild.

[rhatdan]

Sadly, I think I did the work on podman config, and have lost it, I thought it was merged.

[rhatdan]

@edsantiago I think we should keep an up2date list at the top of this issue. Along with my comments to see where we are, only showing the ones that are missing along with the links to any PR that is working to solve them.

[rhatdan]

Actually open an issue that is with the outstanding potential work items. If we don't plan on implementing items we should update the transfer.md doc with the ones we don't plan to update.

[rhatdan]

/lgtm