Class: PodmanPod
Manage Podman pods
URI: containers:PodmanPod
classDiagram
class PodmanPod
IacModule <|-- PodmanPod
PodmanPod : add_host
PodmanPod ..> string : add_host
PodmanPod : cgroup_parent
PodmanPod ..> string : cgroup_parent
PodmanPod : cpus
PodmanPod ..> string : cpus
PodmanPod : cpuset_cpus
PodmanPod ..> string : cpuset_cpus
PodmanPod : debug
PodmanPod ..> boolean : debug
PodmanPod : device
PodmanPod ..> string : device
PodmanPod : device_read_bps
PodmanPod ..> string : device_read_bps
PodmanPod : dns
PodmanPod ..> string : dns
PodmanPod : dns_opt
PodmanPod ..> string : dns_opt
PodmanPod : dns_search
PodmanPod ..> string : dns_search
PodmanPod : executable
PodmanPod ..> string : executable
PodmanPod : generate_systemd
PodmanPod ..> MetaObject : generate_systemd
PodmanPod : gidmap
PodmanPod ..> string : gidmap
PodmanPod : hostname
PodmanPod ..> string : hostname
PodmanPod : infra
PodmanPod ..> boolean : infra
PodmanPod : infra_command
PodmanPod ..> string : infra_command
PodmanPod : infra_conmon_pidfile
PodmanPod ..> string : infra_conmon_pidfile
PodmanPod : infra_image
PodmanPod ..> string : infra_image
PodmanPod : infra_name
PodmanPod ..> string : infra_name
PodmanPod : ip
PodmanPod ..> string : ip
PodmanPod : label
PodmanPod ..> MetaObject : label
PodmanPod : label_file
PodmanPod ..> string : label_file
PodmanPod : mac_address
PodmanPod ..> string : mac_address
PodmanPod : name
PodmanPod ..> label type : name
PodmanPod : network
PodmanPod ..> string : network
PodmanPod : network_alias
PodmanPod ..> string : network_alias
PodmanPod : no_hosts
PodmanPod ..> boolean : no_hosts
PodmanPod : pid
PodmanPod ..> string : pid
PodmanPod : pod_id_file
PodmanPod ..> string : pod_id_file
PodmanPod : publish
PodmanPod ..> string : publish
PodmanPod : recreate
PodmanPod ..> boolean : recreate
PodmanPod : share
PodmanPod ..> string : share
PodmanPod : state
PodmanPod ..> ContainerStateEnum : state
PodmanPod : subgidname
PodmanPod ..> string : subgidname
PodmanPod : subuidname
PodmanPod ..> string : subuidname
PodmanPod : uidmap
PodmanPod ..> string : uidmap
PodmanPod : userns
PodmanPod ..> string : userns
PodmanPod : volume
PodmanPod ..> string : volume
Inheritance
- IacModule
- PodmanPod
Slots
Name | Cardinality and Range | Description | Inheritance |
---|---|---|---|
add_host | 0..1 xsd:string |
Add host to system | direct |
cgroup_parent | 0..1 xsd:string |
On creation, all processes are put in the cgroup that the parent process belo... | direct |
cpus | 0..1 xsd:string |
Number of CPUs | direct |
cpuset_cpus | 0..1 xsd:string |
CPUs in which to allow execution (0-3, 0,1) | direct |
debug | 0..1 xsd:string |
Return additional information which can be helpful for investigations | direct |
device | 0..1 xsd:string |
System device | direct |
device_read_bps | 0..1 xsd:string |
Limit read rate (bytes per second) from a device | direct |
dns | 0..* xsd:string |
Domain name service servers | direct |
dns_opt | 0..1 xsd:string |
DNS options | direct |
dns_search | 0..1 xsd:string |
DNS search domains | direct |
generate_systemd | 0..1 MetaObject |
Generate systemd unit file for a service | direct |
gidmap | 0..* xsd:string |
Group id mapping | direct |
hostname | 0..1 xsd:string |
label assigned to a device connected to a computer network | direct |
infra | 0..1 xsd:string |
Fundamental facilities and systems serving a country, city, or other areas | direct |
infra_command | 0..1 xsd:string |
Infrastructure command | direct |
infra_conmon_pidfile | 0..1 xsd:string |
Write the pid of the infra container’s conmon process to a file | direct |
infra_name | 0..1 xsd:string |
The name that will be used for the pod’s infra container | direct |
infra_image | 0..1 xsd:string |
The image that will be created for the infra container | direct |
ip | 0..1 xsd:string |
Principal communications protocol used for relaying datagrams (also known as ... | direct |
label | 0..1 xsd:string |
Word or phrase used for identification | direct |
label_file | 0..1 xsd:string |
Line delimited file of labels | direct |
mac_address | 0..1 xsd:string |
Unique identifier assigned to network interfaces for communications on the ph... | direct |
name | 0..1 LabelType |
A human-readable name for an attribute or entity | direct |
network | 0..1 xsd:string |
Network that allows computers to share resources and communicate with each ot... | direct |
network_alias | 0..1 xsd:string |
Add network-scoped alias | direct |
no_hosts | 0..1 xsd:boolean |
Do not create /etc/hosts | direct |
pid | 0..1 xsd:string |
number to identify each process running on a computer | direct |
pod_id_file | 0..1 xsd:string |
Write the pod ID to the file | direct |
publish | 0..* xsd:string |
Publish things to make something externally available | direct |
recreate | 0..1 xsd:boolean |
Create again | direct |
share | 0..1 xsd:string |
Computer resource made available from one host to other hosts on a computer n... | direct |
state | 0..1 xsd:string |
The way something is with respect to its main attributes | direct |
subgidname | 0..1 xsd:string |
Name from /etc/subgid | direct |
subuidname | 0..1 xsd:string |
Name from /etc/subuid | direct |
uidmap | 0..1 xsd:string |
Run the container in a new user namespace using the supplied mapping | direct |
userns | 0..1 xsd:string |
User namespaces are an isolation feature allowing processes to run with diffe... | direct |
volume | 0..1 xsd:string |
volume of a book or music release in a collection/series or a published colle... | direct |
executable | 0..1 xsd:string |
Path to podman executable if it is not in the $PATH on the machine running po... | IacModule |
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/lmodel/ucs-containers
Mappings
Mapping Type | Mapped Value |
---|---|
self | containers:PodmanPod |
native | containers:PodmanPod |
LinkML Source
Direct
name: PodmanPod
description: Manage Podman pods
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slots:
- add_host
- cgroup_parent
- cpus
- cpuset_cpus
- debug
- device
- device_read_bps
- dns
- dns_opt
- dns_search
- generate_systemd
- gidmap
- hostname
- infra
- infra_command
- infra_conmon_pidfile
- infra_name
- infra_image
- ip
- label
- label_file
- mac_address
- name
- network
- network_alias
- no_hosts
- pid
- pod_id_file
- publish
- recreate
- share
- state
- subgidname
- subuidname
- uidmap
- userns
- volume
slot_usage:
add_host:
name: add_host
description: Add a host to the /etc/hosts file shared between all containers in
the pod.
multivalued: true
domain_of:
- PodmanPod
cgroup_parent:
name: cgroup_parent
description: Path to cgroups under which the cgroup for the pod will be created.
If the path is not absolute, he path is considered to be relative to the cgroups
path of the init process. Cgroups will be created if they do not already exist.
domain_of:
- PodmanContainer
- PodmanPod
cpus:
name: cpus
description: Set the total number of CPUs delegated to the pod. Default is 0.000
which indicates that there is no limit on computation power.
domain_of:
- PodmanContainer
- PodmanPod
cpuset_cpus:
name: cpuset_cpus
description: Limit the CPUs to support execution. First CPU is numbered 0. Unlike
`cpus` this is of type string and parsed as a list of numbers. Format is 0-3,0,1
domain_of:
- PodmanContainer
- PodmanPod
debug:
name: debug
description: Return additional information which can be helpful for investigations.
ifabsent: 'False'
domain_of:
- PodmanContainer
- PodmanContainers
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanVolume
range: boolean
device:
name: device
description: Add a host device to the pod. Optional permissions parameter can
be used to specify device permissions. It is a combination of r for read, w
for write, and m for mknod(2)
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
device_read_bps:
name: device_read_bps
description: Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
dns:
name: dns
description: Set custom DNS servers in the /etc/resolv.conf file that will be
shared between all containers in the pod. A special option, “none” is allowed
which disables creation of /etc/resolv.conf for the pod.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
dns_opt:
name: dns_opt
description: Set custom DNS options in the /etc/resolv.conf file that will be
shared between all containers in the pod.
multivalued: true
domain_of:
- PodmanPod
dns_search:
name: dns_search
description: Set custom DNS search domains in the /etc/resolv.conf file that will
be shared between all containers in the pod.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
executable:
name: executable
description: Path to podman executable if it is not in the $PATH on the machine
running podman
ifabsent: string(podman)
domain_of:
- IacModule
generate_systemd:
name: generate_systemd
description: Generate systemd unit file for container.
domain_of:
- PodmanContainer
- PodmanPod
range: MetaObject
gidmap:
name: gidmap
description: GID map for the user namespace. Using this flag will run the container
with user namespace enabled. It conflicts with the `userns` and `subgidname`
flags.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
hostname:
name: hostname
description: Set a hostname to the pod
domain_of:
- PodmanContainer
- PodmanPod
infra:
name: infra
description: Create an infra container and associate it with the pod. An infra
container is a lightweight container used to coordinate the shared kernel namespace
of a pod. Default is true.
ifabsent: 'True'
domain_of:
- PodmanPod
range: boolean
infra_command:
name: infra_command
description: The command that will be run to start the infra container. Default
is “/pause”.
domain_of:
- PodmanPod
infra_conmon_pidfile:
name: infra_conmon_pidfile
description: Write the pid of the infra container’s conmon process to a file.
As conmon runs in a separate process than Podman, this is necessary when using
systemd to manage Podman containers and pods.
domain_of:
- PodmanPod
infra_image:
name: infra_image
description: The image that will be created for the infra container. Default is
“k8s.gcr.io/pause:3.1”.
ifabsent: string(k8s.gcr.io/pause:3.1)
domain_of:
- PodmanPod
infra_name:
name: infra_name
description: The name that will be used for the pod’s infra container.
domain_of:
- PodmanPod
ip:
name: ip
description: Set a static IP for the pod’s shared network.
domain_of:
- PodmanContainer
- PodmanPod
label:
name: label
description: Add metadata to a pod, pass dictionary of label keys and values.
domain_of:
- PodmanContainer
- PodmanPod
- PodmanVolume
range: MetaObject
label_file:
name: label_file
description: Read in a line delimited file of labels.
domain_of:
- PodmanContainer
- PodmanPod
mac_address:
name: mac_address
description: Set a static MAC address for the pod’s shared network.
domain_of:
- PodmanContainer
- PodmanPod
name:
name: name
description: Assign a name to the pod.
domain_of:
- PodmanContainer
- PodmanGenerateSystemd
- PodmanImage
- PodmanNetwork
- PodmanPod
- PodmanSecret
- PodmanVolume
- Attribute
- Entity
required: true
network:
name: network
description: Set network mode for the pod. Supported values are bridge (the default),
host (do not create a network namespace, all containers in the pod will use
the host’s network), or a list of names of CNI networks to join.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPlay
- PodmanPod
network_alias:
name: network_alias
description: Add a network-scoped alias for the pod, setting the alias for all
networks that the pod joins. To set a name only for a specific network, use
the alias option as described under the -`network` option. Network aliases work
only with the bridge networking mode. This option can be specified multiple
times.
aliases:
- '{''network_aliases'': None}'
multivalued: true
domain_of:
- PodmanPod
no_hosts:
name: no_hosts
description: Disable creation of /etc/hosts for the pod.
ifabsent: 'True'
domain_of:
- PodmanContainer
- PodmanPod
range: boolean
pid:
name: pid
description: Set the PID mode for the pod. The default is to create a private
PID namespace for the pod. Requires the PID namespace to be shared via `share`
option.
domain_of:
- PodmanContainer
- PodmanPod
pod_id_file:
name: pod_id_file
description: Write the pod ID to the file.
domain_of:
- PodmanPod
publish:
name: publish
description: Publish a port or range of ports from the pod to the host.
aliases:
- '{''ports'': None}'
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
recreate:
name: recreate
description: Use with present and started states to force the re-creation of an
existing pod.
ifabsent: 'False'
domain_of:
- PodmanContainer
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanVolume
range: boolean
share:
name: share
description: A comma delimited list of kernel namespaces to share. If none or
“” is specified, no namespaces will be shared. The namespaces to choose from
are ipc, net, pid, user, uts.
domain_of:
- PodmanPod
state:
name: state
description: This variable is set for state
domain_of:
- PodmanContainer
- PodmanImage
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanSecret
- PodmanVolume
range: ContainerStateEnum
subgidname:
name: subgidname
description: Name for GID map from the /etc/subgid file. Using this flag will
run the container with user namespace enabled. This flag conflicts with `userns`
and `gidmap`.
domain_of:
- PodmanContainer
- PodmanPod
subuidname:
name: subuidname
description: Name for UID map from the /etc/subuid file. Using this flag will
run the container with user namespace enabled. This flag conflicts with `userns`
and `uidmap`.
domain_of:
- PodmanContainer
- PodmanPod
uidmap:
name: uidmap
description: 'Run the container in a new user namespace using the supplied mapping.
This option conflicts with the `userns` and `subuidname` options. This option
provides a way to map host UIDs to container UIDs. It can be passed several
times to map different ranges.
'
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
userns:
name: userns
description: Set the user namespace mode for all the containers in a pod. It defaults
to the PODMAN_USERNS environment variable. An empty value (“”) means user namespaces
are disabled.
domain_of:
- PodmanContainer
- PodmanPod
volume:
name: volume
description: Create a bind mount.
aliases:
- volumes
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
Induced
name: PodmanPod
description: Manage Podman pods
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slot_usage:
add_host:
name: add_host
description: Add a host to the /etc/hosts file shared between all containers in
the pod.
multivalued: true
domain_of:
- PodmanPod
cgroup_parent:
name: cgroup_parent
description: Path to cgroups under which the cgroup for the pod will be created.
If the path is not absolute, he path is considered to be relative to the cgroups
path of the init process. Cgroups will be created if they do not already exist.
domain_of:
- PodmanContainer
- PodmanPod
cpus:
name: cpus
description: Set the total number of CPUs delegated to the pod. Default is 0.000
which indicates that there is no limit on computation power.
domain_of:
- PodmanContainer
- PodmanPod
cpuset_cpus:
name: cpuset_cpus
description: Limit the CPUs to support execution. First CPU is numbered 0. Unlike
`cpus` this is of type string and parsed as a list of numbers. Format is 0-3,0,1
domain_of:
- PodmanContainer
- PodmanPod
debug:
name: debug
description: Return additional information which can be helpful for investigations.
ifabsent: 'False'
domain_of:
- PodmanContainer
- PodmanContainers
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanVolume
range: boolean
device:
name: device
description: Add a host device to the pod. Optional permissions parameter can
be used to specify device permissions. It is a combination of r for read, w
for write, and m for mknod(2)
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
device_read_bps:
name: device_read_bps
description: Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
dns:
name: dns
description: Set custom DNS servers in the /etc/resolv.conf file that will be
shared between all containers in the pod. A special option, “none” is allowed
which disables creation of /etc/resolv.conf for the pod.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
dns_opt:
name: dns_opt
description: Set custom DNS options in the /etc/resolv.conf file that will be
shared between all containers in the pod.
multivalued: true
domain_of:
- PodmanPod
dns_search:
name: dns_search
description: Set custom DNS search domains in the /etc/resolv.conf file that will
be shared between all containers in the pod.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
executable:
name: executable
description: Path to podman executable if it is not in the $PATH on the machine
running podman
ifabsent: string(podman)
domain_of:
- IacModule
generate_systemd:
name: generate_systemd
description: Generate systemd unit file for container.
domain_of:
- PodmanContainer
- PodmanPod
range: MetaObject
gidmap:
name: gidmap
description: GID map for the user namespace. Using this flag will run the container
with user namespace enabled. It conflicts with the `userns` and `subgidname`
flags.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
hostname:
name: hostname
description: Set a hostname to the pod
domain_of:
- PodmanContainer
- PodmanPod
infra:
name: infra
description: Create an infra container and associate it with the pod. An infra
container is a lightweight container used to coordinate the shared kernel namespace
of a pod. Default is true.
ifabsent: 'True'
domain_of:
- PodmanPod
range: boolean
infra_command:
name: infra_command
description: The command that will be run to start the infra container. Default
is “/pause”.
domain_of:
- PodmanPod
infra_conmon_pidfile:
name: infra_conmon_pidfile
description: Write the pid of the infra container’s conmon process to a file.
As conmon runs in a separate process than Podman, this is necessary when using
systemd to manage Podman containers and pods.
domain_of:
- PodmanPod
infra_image:
name: infra_image
description: The image that will be created for the infra container. Default is
“k8s.gcr.io/pause:3.1”.
ifabsent: string(k8s.gcr.io/pause:3.1)
domain_of:
- PodmanPod
infra_name:
name: infra_name
description: The name that will be used for the pod’s infra container.
domain_of:
- PodmanPod
ip:
name: ip
description: Set a static IP for the pod’s shared network.
domain_of:
- PodmanContainer
- PodmanPod
label:
name: label
description: Add metadata to a pod, pass dictionary of label keys and values.
domain_of:
- PodmanContainer
- PodmanPod
- PodmanVolume
range: MetaObject
label_file:
name: label_file
description: Read in a line delimited file of labels.
domain_of:
- PodmanContainer
- PodmanPod
mac_address:
name: mac_address
description: Set a static MAC address for the pod’s shared network.
domain_of:
- PodmanContainer
- PodmanPod
name:
name: name
description: Assign a name to the pod.
domain_of:
- PodmanContainer
- PodmanGenerateSystemd
- PodmanImage
- PodmanNetwork
- PodmanPod
- PodmanSecret
- PodmanVolume
- Attribute
- Entity
required: true
network:
name: network
description: Set network mode for the pod. Supported values are bridge (the default),
host (do not create a network namespace, all containers in the pod will use
the host’s network), or a list of names of CNI networks to join.
multivalued: true
domain_of:
- PodmanContainer
- PodmanPlay
- PodmanPod
network_alias:
name: network_alias
description: Add a network-scoped alias for the pod, setting the alias for all
networks that the pod joins. To set a name only for a specific network, use
the alias option as described under the -`network` option. Network aliases work
only with the bridge networking mode. This option can be specified multiple
times.
aliases:
- '{''network_aliases'': None}'
multivalued: true
domain_of:
- PodmanPod
no_hosts:
name: no_hosts
description: Disable creation of /etc/hosts for the pod.
ifabsent: 'True'
domain_of:
- PodmanContainer
- PodmanPod
range: boolean
pid:
name: pid
description: Set the PID mode for the pod. The default is to create a private
PID namespace for the pod. Requires the PID namespace to be shared via `share`
option.
domain_of:
- PodmanContainer
- PodmanPod
pod_id_file:
name: pod_id_file
description: Write the pod ID to the file.
domain_of:
- PodmanPod
publish:
name: publish
description: Publish a port or range of ports from the pod to the host.
aliases:
- '{''ports'': None}'
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
recreate:
name: recreate
description: Use with present and started states to force the re-creation of an
existing pod.
ifabsent: 'False'
domain_of:
- PodmanContainer
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanVolume
range: boolean
share:
name: share
description: A comma delimited list of kernel namespaces to share. If none or
“” is specified, no namespaces will be shared. The namespaces to choose from
are ipc, net, pid, user, uts.
domain_of:
- PodmanPod
state:
name: state
description: This variable is set for state
domain_of:
- PodmanContainer
- PodmanImage
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanSecret
- PodmanVolume
range: ContainerStateEnum
subgidname:
name: subgidname
description: Name for GID map from the /etc/subgid file. Using this flag will
run the container with user namespace enabled. This flag conflicts with `userns`
and `gidmap`.
domain_of:
- PodmanContainer
- PodmanPod
subuidname:
name: subuidname
description: Name for UID map from the /etc/subuid file. Using this flag will
run the container with user namespace enabled. This flag conflicts with `userns`
and `uidmap`.
domain_of:
- PodmanContainer
- PodmanPod
uidmap:
name: uidmap
description: 'Run the container in a new user namespace using the supplied mapping.
This option conflicts with the `userns` and `subuidname` options. This option
provides a way to map host UIDs to container UIDs. It can be passed several
times to map different ranges.
'
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
userns:
name: userns
description: Set the user namespace mode for all the containers in a pod. It defaults
to the PODMAN_USERNS environment variable. An empty value (“”) means user namespaces
are disabled.
domain_of:
- PodmanContainer
- PodmanPod
volume:
name: volume
description: Create a bind mount.
aliases:
- volumes
multivalued: true
domain_of:
- PodmanContainer
- PodmanPod
attributes:
add_host:
name: add_host
description: Add a host to the /etc/hosts file shared between all containers in
the pod.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
multivalued: true
alias: add_host
owner: PodmanPod
domain_of:
- PodmanPod
range: string
cgroup_parent:
name: cgroup_parent
description: Path to cgroups under which the cgroup for the pod will be created.
If the path is not absolute, he path is considered to be relative to the cgroups
path of the init process. Cgroups will be created if they do not already exist.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: cgroup_parent
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
cpus:
name: cpus
description: Set the total number of CPUs delegated to the pod. Default is 0.000
which indicates that there is no limit on computation power.
from_schema: https://w3id.org/lmodel/ucs-core
alias: cpus
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
cpuset_cpus:
name: cpuset_cpus
description: Limit the CPUs to support execution. First CPU is numbered 0. Unlike
`cpus` this is of type string and parsed as a list of numbers. Format is 0-3,0,1
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: cpuset_cpus
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
debug:
name: debug
description: Return additional information which can be helpful for investigations.
from_schema: https://w3id.org/lmodel/ucs-core
ifabsent: 'False'
alias: debug
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanContainers
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanVolume
range: boolean
device:
name: device
description: Add a host device to the pod. Optional permissions parameter can
be used to specify device permissions. It is a combination of r for read, w
for write, and m for mknod(2)
from_schema: https://w3id.org/lmodel/ucs-core
multivalued: true
alias: device
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
device_read_bps:
name: device_read_bps
description: Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
multivalued: true
alias: device_read_bps
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
dns:
name: dns
description: Set custom DNS servers in the /etc/resolv.conf file that will be
shared between all containers in the pod. A special option, “none” is allowed
which disables creation of /etc/resolv.conf for the pod.
from_schema: https://w3id.org/lmodel/ucs-core
multivalued: true
alias: dns
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
dns_opt:
name: dns_opt
description: Set custom DNS options in the /etc/resolv.conf file that will be
shared between all containers in the pod.
from_schema: https://w3id.org/lmodel/ucs-core
multivalued: true
alias: dns_opt
owner: PodmanPod
domain_of:
- PodmanPod
range: string
dns_search:
name: dns_search
description: Set custom DNS search domains in the /etc/resolv.conf file that will
be shared between all containers in the pod.
from_schema: https://w3id.org/lmodel/ucs-core
multivalued: true
alias: dns_search
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
generate_systemd:
name: generate_systemd
description: Generate systemd unit file for container.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: generate_systemd
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: MetaObject
gidmap:
name: gidmap
description: GID map for the user namespace. Using this flag will run the container
with user namespace enabled. It conflicts with the `userns` and `subgidname`
flags.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
multivalued: true
alias: gidmap
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
hostname:
name: hostname
description: Set a hostname to the pod
from_schema: https://w3id.org/lmodel/ucs-core
slot_uri: uco-observable:hostname
alias: hostname
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
infra:
name: infra
description: Create an infra container and associate it with the pod. An infra
container is a lightweight container used to coordinate the shared kernel namespace
of a pod. Default is true.
from_schema: https://w3id.org/lmodel/ucs-core
ifabsent: 'True'
alias: infra
owner: PodmanPod
domain_of:
- PodmanPod
range: boolean
infra_command:
name: infra_command
description: The command that will be run to start the infra container. Default
is “/pause”.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: infra_command
owner: PodmanPod
domain_of:
- PodmanPod
range: string
infra_conmon_pidfile:
name: infra_conmon_pidfile
description: Write the pid of the infra container’s conmon process to a file.
As conmon runs in a separate process than Podman, this is necessary when using
systemd to manage Podman containers and pods.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: infra_conmon_pidfile
owner: PodmanPod
domain_of:
- PodmanPod
range: string
infra_name:
name: infra_name
description: The name that will be used for the pod’s infra container.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: infra_name
owner: PodmanPod
domain_of:
- PodmanPod
range: string
infra_image:
name: infra_image
description: The image that will be created for the infra container. Default is
“k8s.gcr.io/pause:3.1”.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
ifabsent: string(k8s.gcr.io/pause:3.1)
alias: infra_image
owner: PodmanPod
domain_of:
- PodmanPod
range: string
ip:
name: ip
description: Set a static IP for the pod’s shared network.
from_schema: https://w3id.org/lmodel/ucs-core
slot_uri: uco-observable:ip
alias: ip
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
label:
name: label
description: Add metadata to a pod, pass dictionary of label keys and values.
from_schema: https://w3id.org/lmodel/ucs-core
alias: label
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
- PodmanVolume
range: MetaObject
label_file:
name: label_file
description: Read in a line delimited file of labels.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: label_file
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
mac_address:
name: mac_address
description: Set a static MAC address for the pod’s shared network.
from_schema: https://w3id.org/lmodel/ucs-core
alias: mac_address
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
name:
name: name
description: Assign a name to the pod.
from_schema: https://w3id.org/lmodel/ucs-core
slot_uri: rdfs:label
alias: name
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanGenerateSystemd
- PodmanImage
- PodmanNetwork
- PodmanPod
- PodmanSecret
- PodmanVolume
- Attribute
- Entity
range: label type
required: true
network:
name: network
description: Set network mode for the pod. Supported values are bridge (the default),
host (do not create a network namespace, all containers in the pod will use
the host’s network), or a list of names of CNI networks to join.
from_schema: https://w3id.org/lmodel/ucs-core
slot_uri: uco-observable:network
multivalued: true
alias: network
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPlay
- PodmanPod
range: string
network_alias:
name: network_alias
description: Add a network-scoped alias for the pod, setting the alias for all
networks that the pod joins. To set a name only for a specific network, use
the alias option as described under the -`network` option. Network aliases work
only with the bridge networking mode. This option can be specified multiple
times.
from_schema: https://w3id.org/lmodel/ucs-containers
aliases:
- '{''network_aliases'': None}'
rank: 1000
multivalued: true
alias: network_alias
owner: PodmanPod
domain_of:
- PodmanPod
range: string
no_hosts:
name: no_hosts
description: Disable creation of /etc/hosts for the pod.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
ifabsent: 'True'
alias: no_hosts
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: boolean
pid:
name: pid
description: Set the PID mode for the pod. The default is to create a private
PID namespace for the pod. Requires the PID namespace to be shared via `share`
option.
from_schema: https://w3id.org/lmodel/ucs-core
slot_uri: uco-observable:pid
alias: pid
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
pod_id_file:
name: pod_id_file
description: Write the pod ID to the file.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: pod_id_file
owner: PodmanPod
domain_of:
- PodmanPod
range: string
publish:
name: publish
description: Publish a port or range of ports from the pod to the host.
from_schema: https://w3id.org/lmodel/ucs-core
aliases:
- '{''ports'': None}'
multivalued: true
alias: publish
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
recreate:
name: recreate
description: Use with present and started states to force the re-creation of an
existing pod.
from_schema: https://w3id.org/lmodel/ucs-core
ifabsent: 'False'
alias: recreate
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanVolume
range: boolean
share:
name: share
description: A comma delimited list of kernel namespaces to share. If none or
“” is specified, no namespaces will be shared. The namespaces to choose from
are ipc, net, pid, user, uts.
from_schema: https://w3id.org/lmodel/ucs-core
alias: share
owner: PodmanPod
domain_of:
- PodmanPod
range: string
state:
name: state
description: This variable is set for state
from_schema: https://w3id.org/lmodel/ucs-core
is_a: associationSlot
domain: Association
slot_uri: uco-observable:state
alias: state
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanImage
- PodmanNetwork
- PodmanPlay
- PodmanPod
- PodmanSecret
- PodmanVolume
range: ContainerStateEnum
subgidname:
name: subgidname
description: Name for GID map from the /etc/subgid file. Using this flag will
run the container with user namespace enabled. This flag conflicts with `userns`
and `gidmap`.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: subgidname
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
subuidname:
name: subuidname
description: Name for UID map from the /etc/subuid file. Using this flag will
run the container with user namespace enabled. This flag conflicts with `userns`
and `uidmap`.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: subuidname
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
uidmap:
name: uidmap
description: 'Run the container in a new user namespace using the supplied mapping.
This option conflicts with the `userns` and `subuidname` options. This option
provides a way to map host UIDs to container UIDs. It can be passed several
times to map different ranges.
'
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
multivalued: true
alias: uidmap
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
userns:
name: userns
description: Set the user namespace mode for all the containers in a pod. It defaults
to the PODMAN_USERNS environment variable. An empty value (“”) means user namespaces
are disabled.
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
alias: userns
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
volume:
name: volume
description: Create a bind mount.
from_schema: https://w3id.org/lmodel/ucs-core
aliases:
- volumes
is_a: nodeProperty
domain: Publication
slot_uri: uco-observable:volume
multivalued: true
alias: volume
owner: PodmanPod
domain_of:
- PodmanContainer
- PodmanPod
range: string
executable:
name: executable
description: Path to podman executable if it is not in the $PATH on the machine
running podman
from_schema: https://w3id.org/lmodel/ucs-core
ifabsent: string(podman)
alias: executable
owner: PodmanPod
domain_of:
- IacModule
range: string