Skip to content

Commit

Permalink
Merge pull request #21060 from edsantiago/labels-space
Browse files Browse the repository at this point in the history 
Man pages: tighter documenting of --format fields
  • Loading branch information
@openshift-merge-bot
openshift-merge-bot[bot] authored Jan 17, 2024
2 parents c187687 + dbe0e67 commit eb77462
Show file tree
Hide file tree
Showing 17 changed files with 155 additions and 77 deletions.
2 changes: 1 addition & 1 deletion docs/source/markdown/podman-container-inspect.1.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Valid placeholders for the Go template are listed below:
| .BoundingCaps | Bounding capability set (array of strings) |
| .Config ... | Structure with config info |
| .ConmonPidFile | Path to file containing conmon pid (string) |
| .Created | Container creation time (string, ISO3601) |
| .Created ... | Container creation time (string, ISO3601) |
| .Dependencies | Dependencies (array of strings) |
| .Driver | Storage driver (string) |
| .EffectiveCaps | Effective capability set (array of strings) |
Expand Down
29 changes: 15 additions & 14 deletions docs/source/markdown/podman-events.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,20 +104,21 @@ In the case where an ID is used, the ID may be in its full or shortened form. T

Format the output to JSON Lines or using the given Go template.

| **Placeholder** | **Description** |
|-----------------------|-----------------------------------------------|
| .Attributes | created_at, _by, labels, and more (map[]) |
| .ContainerExitCode | Exit code (int) |
| .ContainerInspectData | Payload of the container's inspect |
| .HealthStatus | Health Status (string) |
| .ID | Container ID (full 64-bit SHA) |
| .Image | Name of image being run (string) |
| .Name | Container name (string) |
| .Network | Name of network being used (string) |
| .PodID | ID of pod associated with container, if any |
| .Status | Event status (e.g., create, start, died, ...) |
| .Time | Event timestamp (string) |
| .Type | Event type (e.g., image, container, pod, ...) |
| **Placeholder** | **Description** |
|-------------------------|-----------------------------------------------|
| .Attributes ... | created_at, _by, labels, and more (map[]) |
| .ContainerExitCode | Exit code (int) |
| .ContainerInspectData | Payload of the container's inspect |
| .HealthStatus | Health Status (string) |
| .ID | Container ID (full 64-bit SHA) |
| .Image | Name of image being run (string) |
| .Name | Container name (string) |
| .Network | Name of network being used (string) |
| .PodID | ID of pod associated with container, if any |
| .Status | Event status (e.g., create, start, died, ...) |
| .Time ... | Event timestamp (string) |
| .ToHumanReadable *bool* | If true, truncates CID in output |
| .Type | Event type (e.g., image, container, pod, ...) |

#### **--help**

Expand Down
6 changes: 3 additions & 3 deletions docs/source/markdown/podman-image-inspect.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ Valid placeholders for the Go template are listed below:

| **Placeholder** | **Description** |
| ----------------- | ------------------ |
| .Annotations | Annotation information included in the image |
| .Annotations ... | Annotation information included in the image |
| .Architecture | Architecture of software in the image |
| .Author | Image author |
| .Comment | Image comment |
| .Config ... | Structure with config info |
| .Created | Image creation time (string, ISO3601) |
| .Created ... | Image creation time (string, ISO3601) |
| .Digest | Image digest (sha256:+64-char hash) |
| .GraphDriver ... | Structure for the graph driver info |
| .HealthCheck ... | Structure for the health check info |
| .History | History information stored in image |
| .ID | Image ID (full 64-char hash) |
| .Labels | Label information included in the image |
| .Labels ... | Label information included in the image |
| .ManifestType | Manifest type of the image |
| .NamesHistory | Name history information stored in image |
| .Os | Operating system of software in the image |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/markdown/podman-images.1.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Valid placeholders for the Go template are listed below:
| .Id | Image ID (full SHA) |
| .IsDangling | Is image dangling? (true/false) |
| .IsReadOnly | Is unage read-only? (true/false) |
| .Labels | map[] of labels |
| .Labels ... | map[] of labels |
| .Names | Image FQIN |
| .ParentId | Full SHA of parent image ID, or null (string) |
| .ReadOnly | Same as .IsReadOnly |
Expand Down
6 changes: 3 additions & 3 deletions docs/source/markdown/podman-machine-inspect.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Print results with a Go template.
| ------------------- | --------------------------------------------------------------------- |
| .ConfigPath ... | Machine configuration file location |
| .ConnectionInfo ... | Machine connection information |
| .Created | Machine creation time (string, ISO3601) |
| .Created ... | Machine creation time (string, ISO3601) |
| .Image ... | Machine image config |
| .LastUp | Time when machine was last booted |
| .LastUp ... | Time when machine was last booted |
| .Name | Name of the machine |
| .Resources ... | Resources used by the machine |
| .Rootful | Whether the machine prefers rootful or rootless container execution |
| .SSHConfig ... | SSH configuration info for communicating with machine |
| .State ... | Machine state |
| .State | Machine state |
| .UserModeNetworking | Whether this machine uses user-mode networking |

#### **--help**
Expand Down
8 changes: 4 additions & 4 deletions docs/source/markdown/podman-network-inspect.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ Pretty-print networks to JSON or using a Go template.

| **Placeholder** | **Description** |
|--------------------|-------------------------------------------|
| .Created | Timestamp when the network was created |
| .Created ... | Timestamp when the network was created |
| .DNSEnabled | Network has dns enabled (boolean) |
| .Driver | Network driver |
| .ID | Network ID |
| .Internal | Network is internal (boolean) |
| .IPAMOptions | Network ipam options |
| .IPAMOptions ... | Network ipam options |
| .IPv6Enabled | Network has ipv6 subnet (boolean) |
| .Labels | Network labels |
| .Labels ... | Network labels |
| .Name | Network name |
| .NetworkDNSServers | Array of DNS servers used in this network |
| .NetworkInterface | Name of the network interface on the host |
| .Options | Network options |
| .Options ... | Network options |
| .Routes | List of static routes for this network |
| .Subnets | List of subnets on this network |

Expand Down
6 changes: 3 additions & 3 deletions docs/source/markdown/podman-network-ls.1.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,18 @@ Valid placeholders for the Go template are listed below:

| **Placeholder** | **Description** |
|--------------------|-------------------------------------------|
| .Created | Timestamp when the network was created |
| .Created ... | Timestamp when the network was created |
| .DNSEnabled | Network has dns enabled (boolean) |
| .Driver | Network driver |
| .ID | Network ID |
| .Internal | Network is internal (boolean) |
| .IPAMOptions | Network ipam options |
| .IPAMOptions ... | Network ipam options |
| .IPv6Enabled | Network has ipv6 subnet (boolean) |
| .Labels | Network labels |
| .Name | Network name |
| .NetworkDNSServers | Array of DNS servers used in this network |
| .NetworkInterface | Name of the network interface on the host |
| .Options | Network options |
| .Options ... | Network options |
| .Routes | List of static routes for this network |
| .Subnets | List of subnets on this network |

Expand Down
4 changes: 2 additions & 2 deletions docs/source/markdown/podman-pod-inspect.1.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Valid placeholders for the Go template are listed below:
| .CPUShares | CPU Shares |
| .CreateCgroup | Whether cgroup was created |
| .CreateCommand | Create command |
| .Created | Time when the pod was created |
| .Created ... | Time when the pod was created |
| .CreateInfra | Whether infrastructure created |
| .Devices | Devices |
| .ExitPolicy | Exit policy |
Expand All @@ -43,7 +43,7 @@ Valid placeholders for the Go template are listed below:
| .InfraConfig ... | Infra config (contains further fields) |
| .InfraContainerID | Pod infrastructure ID |
| .InspectPodData ... | Nested structure, for experts only |
| .Labels | Pod labels |
| .Labels ... | Pod labels |
| .LockNumber | Number of the pod's Libpod lock |
| .MemoryLimit | Memory limit, bytes |
| .MemorySwap | Memory swap limit, in bytes |
Expand Down
3 changes: 2 additions & 1 deletion docs/source/markdown/podman-pod-ps.1.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ Valid placeholders for the Go template are listed below:
| .Created | Creation time of pod |
| .ID | Container ID |
| .InfraID | Pod infra container ID |
| .Labels | All the labels assigned to the pod |
| .Label *string* | Specified label of the pod |
| .Labels ... | All the labels assigned to the pod |
| .Name | Name of pod |
| .Networks | Show all networks connected to the infra container |
| .NumberOfContainers | Show the number of containers attached to pod |
Expand Down
5 changes: 3 additions & 2 deletions docs/source/markdown/podman-ps.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Valid placeholders for the Go template are listed below:
| .AutoRemove | If true, containers are removed on exit |
| .CIDFile | Container ID File |
| .Command | Quoted command used |
| .Created | Creation time for container, Y-M-D H:M:S |
| .Created ... | Creation time for container, Y-M-D H:M:S |
| .CreatedAt | Creation time for container (same as above) |
| .CreatedHuman | Creation time, relative |
| .ExitCode | Container exit code |
Expand All @@ -84,7 +84,8 @@ Valid placeholders for the Go template are listed below:
| .Image | Image Name/ID |
| .ImageID | Image ID |
| .IsInfra | "true" if infra container |
| .Labels | All the labels assigned to the container |
| .Label *string* | Specified label of the container |
| .Labels ... | All the labels assigned to the container |
| .Mounts | Volumes mounted in the container |
| .Names | Name of container |
| .Networks | Show all networks connected to the container |
Expand Down
8 changes: 4 additions & 4 deletions docs/source/markdown/podman-secret-inspect.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ Format secret output using Go template.

| **Placeholder** | **Description** |
|--------------------------|-------------------------------------------------------------------|
| .CreatedAt | When secret was created (relative timestamp, human-readable) |
| .CreatedAt ... | When secret was created (relative timestamp, human-readable) |
| .ID | ID of secret |
| .SecretData | Secret Data (Displayed only with --showsecret option) |
| .Spec ... | Details of secret |
| .Spec.Driver | Driver info |
| .Spec.Driver ... | Driver info |
| .Spec.Driver.Name | Driver name (string) |
| .Spec.Driver.Options ... | Driver options (map of driver-specific options) |
| .Spec.Labels | Labels for this secret |
| .Spec.Labels ... | Labels for this secret |
| .Spec.Name | Name of secret |
| .UpdatedAt | When secret was last updated (relative timestamp, human-readable) |
| .UpdatedAt ... | When secret was last updated (relative timestamp, human-readable) |

#### **--help**

Expand Down
8 changes: 4 additions & 4 deletions docs/source/markdown/podman-secret-ls.1.md.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ Valid placeholders for the Go template are listed below:

| **Placeholder** | **Description** |
| ------------------------ | ----------------------------------------------------------------- |
| .CreatedAt | When secret was created (relative timestamp, human-readable) |
| .CreatedAt ... | When secret was created (relative timestamp, human-readable) |
| .ID | ID of secret |
| .SecretData | Secret Data (Displayed only with --showsecret option) |
| .Spec ... | Details of secret |
| .Spec.Driver | Driver info |
| .Spec.Driver ... | Driver info |
| .Spec.Driver.Name | Driver name (string) |
| .Spec.Driver.Options ... | Driver options (map of driver-specific options) |
| .Spec.Labels | Labels for this secret |
| .Spec.Labels ... | Labels for this secret |
| .Spec.Name | Name of secret |
| .UpdatedAt | When secret was last updated (relative timestamp, human-readable) |
| .UpdatedAt ... | When secret was last updated (relative timestamp, human-readable) |

@@option noheading

Expand Down
8 changes: 4 additions & 4 deletions docs/source/markdown/podman-volume-inspect.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ Valid placeholders for the Go template are listed below:
| **Placeholder** | **Description** |
| ------------------- | ------------------------------------------------------ |
| .Anonymous | Indicates whether volume is anonymous |
| .CreatedAt | Volume creation time |
| .CreatedAt ... | Volume creation time |
| .Driver | Volume driver |
| .GID | GID the volume was created with |
| .Labels | Label information associated with the volume |
| .Labels ... | Label information associated with the volume |
| .LockNumber | Number of the volume's Libpod lock |
| .MountCount | Number of times the volume is mounted |
| .Mountpoint | Source of volume mount point |
| .Name | Volume name |
| .NeedsChown | Indicates volume needs to be chowned on first use |
| .NeedsCopyUp | Indicates volume needs dest data copied up on first use|
| .Options | Volume options |
| .Options ... | Volume options |
| .Scope | Volume scope |
| .Status | Status of the volume |
| .Status ... | Status of the volume |
| .StorageID | StorageID of the volume |
| .Timeout | Timeout of the volume |
| .UID | UID the volume was created with |
Expand Down
Loading

0 comments on commit eb77462

Please sign in to comment.