mirror of
https://github.com/containers/podman.git
synced 2025-05-17 15:18:43 +08:00
dbe0e67897
Initial impetus was #20958 (ps --format .Label abc). This is a complicated solution to a simple-seeming problem. The problem: .Label is a cobra *function*, something I did not know about nor handle. Solution: recognize cobra functions. Switch to __complete, not __completeNoDesc, so we can see the number of arguments required. Invent new man-page format for documenting functions. And, finally, start enforcing how functions (and cobra structs) are documented. This discovered a never-used completion function, .Recycle(), in podman-events. Remove it. [NO NEW TESTS NEEDED] - the .go change is an excision of dead code. Signed-off-by: Ed Santiago <santiago@redhat.com>
97 lines
4.1 KiB
Markdown
97 lines
4.1 KiB
Markdown
% podman-pod-inspect 1
|
|
|
|
## NAME
|
|
podman\-pod\-inspect - Display information describing a pod
|
|
|
|
## SYNOPSIS
|
|
**podman pod inspect** [*options*] *pod* ...
|
|
|
|
## DESCRIPTION
|
|
Displays configuration and state information about a given pod. It also displays information about containers
|
|
that belong to the pod.
|
|
|
|
## OPTIONS
|
|
|
|
#### **--format**, **-f**=*format*
|
|
|
|
Change the default output format. This can be of a supported type like 'json'
|
|
or a Go template.
|
|
Valid placeholders for the Go template are listed below:
|
|
|
|
| **Placeholder** | **Description** |
|
|
|----------------------|---------------------------------------------|
|
|
| .BlkioDeviceReadBps | Block I/O Device Read, in bytes/sec |
|
|
| .BlkioDeviceWriteBps | Block I/O Device Read, in bytes/sec |
|
|
| .BlkioWeight | Block I/O Weight |
|
|
| .BlkioWeightDevice | Block I/O Device Weight |
|
|
| .CgroupParent | Pod cgroup parent |
|
|
| .CgroupPath | Pod cgroup path |
|
|
| .Containers | Pod containers |
|
|
| .CPUPeriod | CPU period |
|
|
| .CPUQuota | CPU quota |
|
|
| .CPUSetCPUs | CPU Set CPUs |
|
|
| .CPUSetMems | CPU Set Mems |
|
|
| .CPUShares | CPU Shares |
|
|
| .CreateCgroup | Whether cgroup was created |
|
|
| .CreateCommand | Create command |
|
|
| .Created ... | Time when the pod was created |
|
|
| .CreateInfra | Whether infrastructure created |
|
|
| .Devices | Devices |
|
|
| .ExitPolicy | Exit policy |
|
|
| .Hostname | Pod hostname |
|
|
| .ID | Pod ID |
|
|
| .InfraConfig ... | Infra config (contains further fields) |
|
|
| .InfraContainerID | Pod infrastructure ID |
|
|
| .InspectPodData ... | Nested structure, for experts only |
|
|
| .Labels ... | Pod labels |
|
|
| .LockNumber | Number of the pod's Libpod lock |
|
|
| .MemoryLimit | Memory limit, bytes |
|
|
| .MemorySwap | Memory swap limit, in bytes |
|
|
| .Mounts | Mounts |
|
|
| .Name | Pod name |
|
|
| .Namespace | Namespace |
|
|
| .NumContainers | Number of containers in the pod |
|
|
| .RestartPolicy | Restart policy of the pod |
|
|
| .SecurityOpts | Security options |
|
|
| .SharedNamespaces | Pod shared namespaces |
|
|
| .State | Pod state |
|
|
| .VolumesFrom | Volumes from |
|
|
|
|
@@option latest
|
|
|
|
## EXAMPLE
|
|
```
|
|
# podman pod inspect foobar
|
|
{
|
|
|
|
"Id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693",
|
|
"Name": "foobar",
|
|
"Labels": {},
|
|
"CgroupParent": "/libpod_parent",
|
|
"CreateCgroup": true,
|
|
"Created": "2018-08-08T11:15:18.823115347-05:00"
|
|
"State": "created",
|
|
"Hostname": "",
|
|
"SharedNamespaces": [
|
|
"uts",
|
|
"ipc",
|
|
"net"
|
|
]
|
|
"CreateInfra": false,
|
|
"InfraContainerID": "1020dd70583dd7ff2bac83331350f6b6e007de0d026c908e49d89ebf891d4699"
|
|
"CgroupPath": ""
|
|
"Containers": [
|
|
{
|
|
"id": "d53f8bf1e9730281264aac6e6586e327429f62c704abea4b6afb5d8a2b2c9f2c",
|
|
"state": "configured"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## SEE ALSO
|
|
**[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)**, **[podman-inspect(1)](podman-inspect.1.md)**
|
|
|
|
## HISTORY
|
|
August 2018, Originally compiled by Brent Baude <bbaude@redhat.com>
|