Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incomplete documentation when running podman -h #24836

Closed
liviu-vasut opened this issue Dec 13, 2024 · 2 comments
Closed

Incomplete documentation when running podman -h #24836

liviu-vasut opened this issue Dec 13, 2024 · 2 comments
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@liviu-vasut
Copy link

Issue Description

Running podman -h does not display the play command. However, running podman play -h shows the documentation as expected.
This prevents users from discovering the functionality of podman.

Steps to reproduce the issue

Steps to reproduce the issue

$ podman -h | grep play
  diff        Display the changes to the object's file system
  info        Display podman system information
  inspect     Display the configuration of object denoted by ID
  stats       Display a live stream of container resource usage statistics
  top         Display the running processes of a container
  version     Display the Podman version information

$ podman play -h
Play containers, pods or volumes from a structured file

Description:
  Play structured data (e.g., Kubernetes YAML) based on containers, pods or volumes.

Usage:
  podman play


$ podman version
Client:       Podman Engine
Version:      5.3.1
API Version:  5.3.1
Go Version:   go1.23.3
Built:        Thu Nov 21 02:00:00 2024
OS/Arch:      linux/amd64

Describe the results you received

podman -h does not show the play command

Describe the results you expected

podman -h should show the play command

podman info output

host:
  arch: amd64
  buildahVersion: 1.38.0
  cgroupControllers:
  - memory
  - pids
  cgroupManager: systemd
  cgroupVersion: v2
  conmon:
    package: conmon-2.1.12-3.fc41.x86_64
    path: /usr/bin/conmon
    version: 'conmon version 2.1.12, commit: '
  cpuUtilization:
    idlePercent: 81.84
    systemPercent: 3.37
    userPercent: 14.79
  cpus: 4
  databaseBackend: boltdb
  distribution:
    distribution: fedora
    variant: sway-atomic
    version: "41"
  eventLogger: journald
  freeLocks: 2014
  hostname: fedora
  idMappings:
    gidmap:
    - container_id: 0
      host_id: 1000
      size: 1
    - container_id: 1
      host_id: 524288
      size: 65536
    uidmap:
    - container_id: 0
      host_id: 1000
      size: 1
    - container_id: 1
      host_id: 524288
      size: 65536
  kernel: 6.11.10-300.fc41.x86_64
  linkmode: dynamic
  logDriver: journald
  memFree: 1031888896
  memTotal: 8225058816
  networkBackend: netavark
  networkBackendInfo:
    backend: netavark
    dns:
      package: aardvark-dns-1.13.1-1.fc41.x86_64
      path: /usr/libexec/podman/aardvark-dns
      version: aardvark-dns 1.13.1
    package: netavark-1.13.0-1.fc41.x86_64
    path: /usr/libexec/podman/netavark
    version: netavark 1.13.0
  ociRuntime:
    name: crun
    package: crun-1.18.1-1.fc41.x86_64
    path: /usr/bin/crun
    version: |-
      crun version 1.18.1
      commit: c41f034fdbb9742c395085fc98459c94ad1f9aae
      rundir: /run/user/1000/crun
      spec: 1.0.0
      +SYSTEMD +SELINUX +APPARMOR +CAP +SECCOMP +EBPF +CRIU +LIBKRUN +WASM:wasmedge +YAJL
  os: linux
  pasta:
    executable: /usr/bin/pasta
    package: passt-0^20241127.gc0fbc7e-1.fc41.x86_64
    version: |
      pasta 0^20241127.gc0fbc7e-1.fc41.x86_64
      Copyright Red Hat
      GNU General Public License, version 2 or later
        <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
      This is free software: you are free to change and redistribute it.
      There is NO WARRANTY, to the extent permitted by law.
  remoteSocket:
    exists: true
    path: /run/user/1000/podman/podman.sock
  rootlessNetworkCmd: pasta
  security:
    apparmorEnabled: false
    capabilities: CAP_CHOWN,CAP_DAC_OVERRIDE,CAP_FOWNER,CAP_FSETID,CAP_KILL,CAP_NET_BIND_SERVICE,CAP_SETFCAP,CAP_SETGID,CAP_SETPCAP,CAP_SETUID,CAP_SYS_CHROOT
    rootless: true
    seccompEnabled: true
    seccompProfilePath: /usr/share/containers/seccomp.json
    selinuxEnabled: true
  serviceIsRemote: false
  slirp4netns:
    executable: /usr/bin/slirp4netns
    package: slirp4netns-1.3.1-1.fc41.x86_64
    version: |-
      slirp4netns version 1.3.1
      commit: e5e368c4f5db6ae75c2fce786e31eef9da6bf236
      libslirp: 4.8.0
      SLIRP_CONFIG_VERSION_MAX: 5
      libseccomp: 2.5.5
  swapFree: 6012788736
  swapTotal: 8225026048
  uptime: 11h 44m 53.00s (Approximately 0.46 days)
  variant: ""
plugins:
  authorization: null
  log:
  - k8s-file
  - none
  - passthrough
  - journald
  network:
  - bridge
  - macvlan
  - ipvlan
  volume:
  - local
registries:
  search:
  - registry.fedoraproject.org
  - registry.access.redhat.com
  - docker.io
store:
  configFile: /var/home/li/.config/containers/storage.conf
  containerStore:
    number: 5
    paused: 0
    running: 0
    stopped: 5
  graphDriverName: overlay
  graphOptions: {}
  graphRoot: /home/li/.local/share/containers/storage
  graphRootAllocated: 118329704448
  graphRootUsed: 107276808192
  graphStatus:
    Backing Filesystem: btrfs
    Native Overlay Diff: "true"
    Supports d_type: "true"
    Supports shifting: "false"
    Supports volatile: "true"
    Using metacopy: "false"
  imageCopyTmpDir: /var/tmp
  imageStore:
    number: 24
  runRoot: /run/user/1000/containers
  transientStore: false
  volumePath: /var/home/li/.local/share/containers/storage/volumes
version:
  APIVersion: 5.3.1
  Built: 1732147200
  BuiltTime: Thu Nov 21 02:00:00 2024
  GitCommit: ""
  GoVersion: go1.23.3
  Os: linux
  OsArch: linux/amd64
  Version: 5.3.1

Podman in a container

No

Privileged Or Rootless

Rootless

Upstream Latest Release

Yes

Additional environment details

Running on Fedora Sway atomic host.

Additional information

No response

@liviu-vasut liviu-vasut added the kind/bug Categorizes issue or PR as related to a bug. label Dec 13, 2024
@Luap99
Copy link
Member

Luap99 commented Dec 13, 2024

play kube is an alias for kube play thus it is not shown by default in help,
i.e. man podman-play-kube redirects to the kube play man page.

It is not really deprecated but we prefer to only list th enew way when we move command/options.

@Luap99 Luap99 closed this as not planned Won't fix, can't repro, duplicate, stale Dec 13, 2024
@liviu-vasut
Copy link
Author

thanks for clearing that up @Luap99 and sorry for the noise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

2 participants