summaryrefslogtreecommitdiff
path: root/docs/kpod-inspect.1.md
blob: d3927cd3710058a625554cfde214499c57fd658e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
% kpod(1) kpod-inspect - Display a container or image's configuration
% Dan Walsh
# kpod-inspect "1" "July 2017" "kpod"

## NAME
kpod inspect - Display a container or image's configuration

## SYNOPSIS
**kpod** **inspect** [*options* [...]] name

## DESCRIPTION
This displays the low-level information on containers and images identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result.

## OPTIONS

**--type, t="TYPE"**

Return data on items of the specified type.  Type can be 'container', 'image' or 'all' (default: all)

**--format, -f="FORMAT"**

Format the output using the given Go template

**--size**

Display the total file size if the type is a container


## EXAMPLE

```
# kpod inspect fedora
{
    "Id": "422dc563ca3260ad9ef5c47a1c246f5065d7f177ce51f4dd208efd82967ff182",
    "Digest": "sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611",
    "RepoTags": [
        "docker.io/library/fedora:latest"
    ],
    "RepoDigests": [
        "docker.io/library/fedora@sha256:1b9bfb4e634dc1e5c19d0fa1eb2e5a28a5c2b498e3d3e4ac742bd7f5dae08611"
    ],
    "Parent": "",
    "Comment": "",
    "Created": "2017-11-14T21:07:08.475840838Z",
    "Config": {
        "Env": [
            "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
            "DISTTAG=f27container",
            "FGC=f27",
            "FBR=f27"
        ]
    },
    "Version": "17.06.2-ce",
    "Author": "[Adam Miller \u003cmaxamillion@fedoraproject.org\u003e] [Patrick Uiterwijk \u003cpatrick@puiterwijk.org\u003e]",
    "Architecture": "amd64",
    "Os": "linux",
    "Size": 251722732,
    "VirtualSize": 514895140,
    "GraphDriver": {
        "Name": "overlay",
        "Data": {
            "MergedDir": "/var/lib/containers/storage/overlay/d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516/merged",
            "UpperDir": "/var/lib/containers/storage/overlay/d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516/diff",
            "WorkDir": "/var/lib/containers/storage/overlay/d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516/work"
        }
    },
    "RootFS": {
        "Type": "layers",
        "Layers": [
            "sha256:d32459d9ce237564fb93573b85cbc707600d43fbe5e46e8eeef22cad914bb516"
        ]
    },
    "Labels": null,
    "Annotations": {}
}
```

## SEE ALSO
kpod(1)

## HISTORY
July 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>