mirror of
https://github.com/containers/podman.git
synced 2025-07-18 01:57:24 +08:00
c60489da47
* Change all store_true or store_false to use store_bool. New behavior documented in BooleanAction docstring. * Remove any extraneous code identified by pylint in files from above. Fixes #1869 Signed-off-by: Jhon Honce <jhonce@redhat.com>
402 lines
15 KiB
Python
402 lines
15 KiB
Python
"""Implement common create container arguments together."""
|
|
|
|
from pypodman.lib import SignalAction, UnitAction
|
|
|
|
|
|
class CreateArguments():
|
|
"""Helper to add all the create flags to a command."""
|
|
|
|
@classmethod
|
|
def add_arguments(cls, parser):
|
|
"""Add CreateArguments to parser."""
|
|
parser.add_argument(
|
|
'--add-host',
|
|
action='append',
|
|
metavar='HOST',
|
|
help='Add a line to /etc/hosts.'
|
|
' The option can be set multiple times.'
|
|
' (format: hostname:ip)')
|
|
parser.add_argument(
|
|
'--annotation',
|
|
action='append',
|
|
help='Add an annotation to the container.'
|
|
'The option can be set multiple times.'
|
|
'(format: key=value)')
|
|
parser.add_argument(
|
|
'--attach',
|
|
'-a',
|
|
action='append',
|
|
metavar='FD',
|
|
help=('Attach to STDIN, STDOUT or STDERR. The option can be set'
|
|
' for each of stdin, stdout, and stderr.'))
|
|
parser.add_argument(
|
|
'--blkio-weight',
|
|
choices=range(10, 1000),
|
|
metavar='[10-1000]',
|
|
help=('Block IO weight (relative weight) accepts a'
|
|
' weight value between 10 and 1000.'))
|
|
parser.add_argument(
|
|
'--blkio-weight-device',
|
|
action='append',
|
|
metavar='WEIGHT',
|
|
help='Block IO weight, relative device weight.'
|
|
' (format: DEVICE_NAME:WEIGHT)')
|
|
parser.add_argument(
|
|
'--cap-add',
|
|
action='append',
|
|
metavar='CAP',
|
|
help=('Add Linux capabilities'
|
|
'The option can be set multiple times.'))
|
|
parser.add_argument(
|
|
'--cap-drop',
|
|
action='append',
|
|
metavar='CAP',
|
|
help=('Drop Linux capabilities'
|
|
'The option can be set multiple times.'))
|
|
parser.add_argument(
|
|
'--cgroup-parent',
|
|
metavar='PATH',
|
|
help='Path to cgroups under which the cgroup for the'
|
|
' container will be created. If the path is not'
|
|
' absolute, the path is considered to be relative'
|
|
' to the cgroups path of the init process. Cgroups'
|
|
' will be created if they do not already exist.')
|
|
parser.add_argument(
|
|
'--cidfile',
|
|
metavar='PATH',
|
|
help='Write the container ID to the file, on the remote host.')
|
|
parser.add_argument(
|
|
'--conmon-pidfile',
|
|
metavar='PATH',
|
|
help=('Write the pid of the conmon process to a file,'
|
|
' on the remote host.'))
|
|
parser.add_argument(
|
|
'--cpu-period',
|
|
type=int,
|
|
metavar='PERIOD',
|
|
help=('Limit the CPU CFS (Completely Fair Scheduler) period.'))
|
|
parser.add_argument(
|
|
'--cpu-quota',
|
|
type=int,
|
|
metavar='QUOTA',
|
|
help=('Limit the CPU CFS (Completely Fair Scheduler) quota.'))
|
|
parser.add_argument(
|
|
'--cpu-rt-period',
|
|
type=int,
|
|
metavar='PERIOD',
|
|
help=('Limit the CPU real-time period in microseconds.'))
|
|
parser.add_argument(
|
|
'--cpu-rt-runtime',
|
|
type=int,
|
|
metavar='LIMIT',
|
|
help=('Limit the CPU real-time runtime in microseconds.'))
|
|
parser.add_argument(
|
|
'--cpu-shares',
|
|
type=int,
|
|
metavar='SHARES',
|
|
help=('CPU shares (relative weight)'))
|
|
parser.add_argument(
|
|
'--cpus',
|
|
type=float,
|
|
help=('Number of CPUs. The default is 0.0 which means no limit'))
|
|
parser.add_argument(
|
|
'--cpuset-cpus',
|
|
metavar='LIST',
|
|
help=('CPUs in which to allow execution (0-3, 0,1)'))
|
|
parser.add_argument(
|
|
'--cpuset-mems',
|
|
metavar='NODES',
|
|
help=('Memory nodes (MEMs) in which to allow execution (0-3, 0,1).'
|
|
' Only effective on NUMA systems'))
|
|
parser.add_flag(
|
|
'--detach',
|
|
'-d',
|
|
help='Detached mode: run the container in the background and'
|
|
' print the new container ID. (default: False)')
|
|
parser.add_argument(
|
|
'--detach-keys',
|
|
metavar='KEY(s)',
|
|
default=4,
|
|
help='Override the key sequence for detaching a container.'
|
|
' (format: a single character [a-Z] or ctrl-<value> where'
|
|
' <value> is one of: a-z, @, ^, [, , or _)')
|
|
parser.add_argument(
|
|
'--device',
|
|
action='append',
|
|
help=('Add a host device to the container'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--device-read-bps',
|
|
action='append',
|
|
metavar='LIMIT',
|
|
help=('Limit read rate (bytes per second) from a device'
|
|
' (e.g. --device-read-bps=/dev/sda:1mb)'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--device-read-iops',
|
|
action='append',
|
|
metavar='LIMIT',
|
|
help=('Limit read rate (IO per second) from a device'
|
|
' (e.g. --device-read-iops=/dev/sda:1000)'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--device-write-bps',
|
|
action='append',
|
|
metavar='LIMIT',
|
|
help=('Limit write rate (bytes per second) to a device'
|
|
' (e.g. --device-write-bps=/dev/sda:1mb)'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--device-write-iops',
|
|
action='append',
|
|
metavar='LIMIT',
|
|
help=('Limit write rate (IO per second) to a device'
|
|
' (e.g. --device-write-iops=/dev/sda:1000)'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--dns',
|
|
action='append',
|
|
metavar='SERVER',
|
|
help=('Set custom DNS servers.'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--dns-option',
|
|
action='append',
|
|
metavar='OPT',
|
|
help=('Set custom DNS options.'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--dns-search',
|
|
action='append',
|
|
metavar='DOMAIN',
|
|
help=('Set custom DNS search domains.'
|
|
'The option can be set multiple times.'),
|
|
)
|
|
parser.add_argument(
|
|
'--entrypoint',
|
|
help=('Overwrite the default ENTRYPOINT of the image.'),
|
|
)
|
|
parser.add_argument(
|
|
'--env',
|
|
'-e',
|
|
action='append',
|
|
help=('Set environment variables.'),
|
|
)
|
|
parser.add_argument(
|
|
'--env-file',
|
|
help=('Read in a line delimited file of environment variables,'
|
|
' on the remote host.'),
|
|
)
|
|
parser.add_argument(
|
|
'--expose',
|
|
action='append',
|
|
metavar='RANGE',
|
|
help=('Expose a port, or a range of ports'
|
|
' (e.g. --expose=3300-3310) to set up port redirection.'),
|
|
)
|
|
parser.add_argument(
|
|
'--gidmap',
|
|
metavar='MAP',
|
|
action='append',
|
|
help=('GID map for the user namespace'),
|
|
)
|
|
parser.add_argument(
|
|
'--group-add',
|
|
action='append',
|
|
metavar='GROUP',
|
|
help=('Add additional groups to run as'))
|
|
parser.add_argument('--hostname', help='Container host name')
|
|
|
|
# only way for argparse to handle these options.
|
|
vol_args = {
|
|
'choices': ('bind', 'tmpfs', 'ignore'),
|
|
'metavar': 'MODE',
|
|
'type': str.lower,
|
|
'help': 'Tells podman how to handle the builtin image volumes',
|
|
}
|
|
|
|
volume_group = parser.add_mutually_exclusive_group()
|
|
volume_group.add_argument('--image-volume', **vol_args)
|
|
volume_group.add_argument('--builtin-volume', **vol_args)
|
|
|
|
parser.add_flag(
|
|
'--interactive',
|
|
'-i',
|
|
help='Keep STDIN open even if not attached.')
|
|
parser.add_argument('--ipc', help='Create namespace')
|
|
parser.add_argument(
|
|
'--kernel-memory', action=UnitAction, help='Kernel memory limit')
|
|
parser.add_argument(
|
|
'--label',
|
|
'-l',
|
|
action='append',
|
|
help=('Add metadata to a container'
|
|
' (e.g., --label com.example.key=value)'))
|
|
parser.add_argument(
|
|
'--label-file', help='Read in a line delimited file of labels')
|
|
parser.add_argument(
|
|
'--log-driver',
|
|
choices='json-file',
|
|
metavar='json-file',
|
|
default='json-file',
|
|
help='Logging driver for the container. (default: %(default)s)')
|
|
parser.add_argument(
|
|
'--log-opt',
|
|
action='append',
|
|
help='Logging driver specific options')
|
|
parser.add_argument(
|
|
'--memory', '-m', action=UnitAction, help='Memory limit')
|
|
parser.add_argument(
|
|
'--memory-reservation',
|
|
action=UnitAction,
|
|
help='Memory soft limit')
|
|
parser.add_argument(
|
|
'--memory-swap',
|
|
action=UnitAction,
|
|
help=('A limit value equal to memory plus swap.'
|
|
'Must be used with the --memory flag'))
|
|
parser.add_argument(
|
|
'--memory-swappiness',
|
|
choices=range(0, 100),
|
|
metavar='[0-100]',
|
|
help="Tune a container's memory swappiness behavior")
|
|
parser.add_argument('--name', help='Assign a name to the container')
|
|
parser.add_argument(
|
|
'--network',
|
|
'--net',
|
|
metavar='BRIDGE',
|
|
help='Set the Network mode for the container.'
|
|
' (format: bridge, host, container:UUID, ns:PATH, none)')
|
|
parser.add_flag(
|
|
'--oom-kill-disable',
|
|
help='Whether to disable OOM Killer for the container or not.')
|
|
parser.add_argument(
|
|
'--oom-score-adj',
|
|
choices=range(-1000, 1000),
|
|
metavar='[-1000-1000]',
|
|
help="Tune the host's OOM preferences for containers")
|
|
parser.add_argument(
|
|
'--pid',
|
|
help='Set the PID Namespace mode for the container.'
|
|
'(format: host, container:UUID, ns:PATH)')
|
|
parser.add_argument(
|
|
'--pids-limit',
|
|
type=int,
|
|
metavar='LIMIT',
|
|
help=("Tune the container's pids limit."
|
|
" Set -1 to have unlimited pids for the container."))
|
|
parser.add_argument('--pod', help='Run container in an existing pod')
|
|
parser.add_flag(
|
|
'--privileged',
|
|
help='Give extended privileges to this container.')
|
|
parser.add_argument(
|
|
'--publish',
|
|
'-p',
|
|
metavar='RANGE',
|
|
help="Publish a container's port, or range of ports, to the host")
|
|
parser.add_flag(
|
|
'--publish-all',
|
|
'-P',
|
|
help='Publish all exposed ports to random'
|
|
' ports on the host interfaces.')
|
|
parser.add_flag(
|
|
'--quiet',
|
|
'-q',
|
|
help='Suppress output information when pulling images')
|
|
parser.add_flag(
|
|
'--read-only',
|
|
help="Mount the container's root filesystem as read only.")
|
|
parser.add_flag(
|
|
'--rm',
|
|
help='Automatically remove the container when it exits.')
|
|
parser.add_argument(
|
|
'--rootfs',
|
|
help='If specified, the first argument refers to an'
|
|
' exploded container on the file system of remote host.')
|
|
parser.add_argument(
|
|
'--security-opt',
|
|
action='append',
|
|
metavar='OPT',
|
|
help='Set security options.')
|
|
parser.add_argument(
|
|
'--shm-size', action=UnitAction, help='Size of /dev/shm')
|
|
parser.add_flag(
|
|
'--sig-proxy',
|
|
help='Proxy signals sent to the podman run'
|
|
' command to the container process')
|
|
parser.add_argument(
|
|
'--stop-signal',
|
|
action=SignalAction,
|
|
default='TERM',
|
|
help='Signal to stop a container')
|
|
parser.add_argument(
|
|
'--stop-timeout',
|
|
metavar='TIMEOUT',
|
|
type=int,
|
|
default=10,
|
|
help='Seconds to wait on stopping container.')
|
|
parser.add_argument(
|
|
'--subgidname',
|
|
metavar='MAP',
|
|
help='Name for GID map from the /etc/subgid file')
|
|
parser.add_argument(
|
|
'--subuidname',
|
|
metavar='MAP',
|
|
help='Name for UID map from the /etc/subuid file')
|
|
parser.add_argument(
|
|
'--sysctl',
|
|
action='append',
|
|
help='Configure namespaced kernel parameters at runtime')
|
|
parser.add_argument(
|
|
'--tmpfs',
|
|
action='append',
|
|
metavar='MOUNT',
|
|
help='Create a tmpfs mount.'
|
|
' (default: rw,noexec,nosuid,nodev,size=65536k.)')
|
|
parser.add_flag(
|
|
'--tty',
|
|
'-t',
|
|
help='Allocate a pseudo-TTY for standard input of container.')
|
|
parser.add_argument(
|
|
'--uidmap',
|
|
action='append',
|
|
metavar='MAP',
|
|
help='UID map for the user namespace')
|
|
parser.add_argument(
|
|
'--ulimit',
|
|
action='append',
|
|
metavar='OPT',
|
|
help='Ulimit options',
|
|
)
|
|
parser.add_argument(
|
|
'--user',
|
|
'-u',
|
|
help='Sets the username or UID used and optionally'
|
|
' the groupname or GID for the specified command.')
|
|
parser.add_argument(
|
|
'--userns',
|
|
metavar='NAMESPACE',
|
|
help='Set the user namespace mode for the container')
|
|
parser.add_argument(
|
|
'--uts',
|
|
choices=('host', 'ns'),
|
|
type=str.lower,
|
|
help='Set the UTS mode for the container')
|
|
parser.add_argument('--volume', '-v', help='Create a bind mount.')
|
|
parser.add_argument(
|
|
'--volumes-from',
|
|
action='append',
|
|
help='Mount volumes from the specified container(s).')
|
|
parser.add_argument(
|
|
'--workdir',
|
|
'-w',
|
|
metavar='PATH',
|
|
help='Working directory inside the container')
|