diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/index.rst | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-pod-inspect.1.md | 51 |
2 files changed, 41 insertions, 12 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 9cc8e7af8..1c46f1c8a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,7 +2,7 @@ What is Podman? ================================== -Podman_ is a daemonless, open source, Linux native tool designed to make it easy to find, run, build, share and deploy applications using Open Containers Initiative (OCI_) Containers_ and `Container Images`_. Podman provides a command line interface (CLI) familiar to anyone who has used the Docker `Container Engine`_. Most users can simply alias Docker to Podman (`alias docker=podman`) without any problems. Similiar other common `Container Engines`_ (Docker, CRI-O, containerd), Podman relies on an OCI compliant `Container Runtime`_ (runc, crun, runv, etc) to interface with the operating system and create the running containers.This makes the running containers created by Podman nearly indistinguishable from those created by any other common container engine. +Podman_ is a daemonless, open source, Linux native tool designed to make it easy to find, run, build, share and deploy applications using Open Containers Initiative (OCI_) Containers_ and `Container Images`_. Podman provides a command line interface (CLI) familiar to anyone who has used the Docker `Container Engine`_. Most users can simply alias Docker to Podman (`alias docker=podman`) without any problems. Similar to other common `Container Engines`_ (Docker, CRI-O, containerd), Podman relies on an OCI compliant `Container Runtime`_ (runc, crun, runv, etc) to interface with the operating system and create the running containers.This makes the running containers created by Podman nearly indistinguishable from those created by any other common container engine. Containers under the control of Podman can either be run by root or by a non-privileged user. Podman manages the entire container ecosystem which includes pods, containers, container images, and container volumes using the libpod_ library. Podman specializes in all of the commands and functions that help you to maintain and modify OCI container images, such as pulling and tagging. It allows you to create, run, and maintain those containers and container images in a production environment. diff --git a/docs/source/markdown/podman-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md index 831d28259..bc04b2b32 100644 --- a/docs/source/markdown/podman-pod-inspect.1.md +++ b/docs/source/markdown/podman-pod-inspect.1.md @@ -18,21 +18,50 @@ to run pods such as CRI-O, the last started pod could be from either of those me The latest option is not supported on the remote client. +**-f**, **--format**=*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** | +| ----------------- | ----------------------------------------------------------------------------- | +| .ID | Pod ID | +| .Name | Pod name | +| .State | Pod state | +| .Hostname | Pod hostname | +| .Labels | Pod labels | +| .Created | Time when the pod was created | +| .CreateCgroup | Whether cgroup was created | +| .CgroupParent | Pod cgroup parent | +| .CgroupPath | Pod cgroup path | +| .CreateInfra | Whether infrastructure created | +| .InfraContainerID | Pod infrastructure ID | +| .SharedNamespaces | Pod shared namespaces | +| .NumContainers | Number of containers in the pod | +| .Containers | Pod containers | + ## EXAMPLE ``` # podman pod inspect foobar { - "Config": { - "id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693", - "name": "foobar", - "labels": {}, - "cgroupParent": "/libpod_parent", - "UsePodCgroup": true, - "created": "2018-08-08T11:15:18.823115347-05:00" - }, - "State": { - "CgroupPath": "" - }, + + "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", |