1podman-pod-create(1)        General Commands Manual       podman-pod-create(1)
2
3
4

NAME

6       podman-pod-create - Create a new pod
7
8

SYNOPSIS

10       podman pod create [options]
11
12

DESCRIPTION

14       Creates an empty pod, or unit of multiple containers, and prepares it
15       to have containers added to it. The pod id is printed to STDOUT. You
16       can then use podman create --pod <pod_id|pod_name> ... to add
17       containers to the pod, and podman pod start <pod_id|pod_name> to start
18       the pod.
19
20

OPTIONS

22       --cgroup-parent=""
23
24
25       Path to cgroups under which the cgroup for the pod will be created. If
26       the path is not absolute, the path is considered to be relative to the
27       cgroups path of the init process. Cgroups will be created if they do
28       not already exist.
29
30
31       --help
32
33
34       Print usage statement
35
36
37       --infra
38
39
40       Create an infra container and associate it with the pod. An infra
41       container is a lightweight container used to coordinate the shared
42       kernel namespace of a pod. Default: true
43
44
45       --infra-command=""
46
47
48       The command that will be run to start the infra container. Default:
49       "/pause"
50
51
52       --infra-image=""
53
54
55       The image that will be created for the infra container. Default:
56       "k8s.gcr.io/pause:3.1"
57
58
59       -l, --label=[]
60
61
62       Add metadata to a pod (e.g., --label com.example.key=value)
63
64
65       --label-file=[]
66
67
68       Read in a line delimited file of labels
69
70
71       -n, --name=""
72
73
74       Assign a name to the pod
75
76
77       --podidfile=""
78
79
80       Write the pod ID to the file
81
82
83       -p, --publish=[]
84
85
86       Publish a port or range of ports from the pod to the host
87
88
89       Format: ip:hostPort:containerPort | ip::containerPort |
90       hostPort:containerPort | containerPort Both hostPort and containerPort
91       can be specified as a range of ports.  When specifying ranges for both,
92       the number of container ports in the range must match the number of
93       host ports in the range.  Use podman port to see the actual mapping:
94       podman port CONTAINER $CONTAINERPORT
95
96
97       NOTE: This cannot be modified once the pod is created.
98
99
100       --share=""
101
102
103       A comma deliminated list of kernel namespaces to share. If none or ""
104       is specified, no namespaces will be shared. The namespaces to choose
105       from are ipc, net, pid, user, uts.
106
107
108       The operator can identify a pod in three ways: UUID long identifier
109       (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
110       UUID short identifier (“f78375b1c487”) Name (“jonah”)
111
112
113       podman generates a UUID for each pod, and if a name is not assigned to
114       the container with --name then a random string name will be generated
115       for it. The name is useful any place you need to identify a pod.
116
117

EXAMPLES

119              $ podman pod create --name test
120
121              $ podman pod create --infra=false
122
123              $ podman pod create --infra-command /top
124
125              $ podman pod create --publish 8443:443
126
127
128

SEE ALSO

130       podman-pod(1)
131
132

HISTORY

134       July 2018, Originally compiled by Peter Hunt ⟨pehunt@redhat.com⟩
135
136
137
138                                                          podman-pod-create(1)