containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
podman/docs/source/markdown/options
History
Stefano Brivio aa47e05ae4 libpod: Add pasta networking mode 
Conceptually equivalent to networking by means of slirp4netns(1),
with a few practical differences:

- pasta(1) forks to background once networking is configured in the
  namespace and quits on its own once the namespace is deleted:
  file descriptor synchronisation and PID tracking are not needed

- port forwarding is configured via command line options at start-up,
  instead of an API socket: this is taken care of right away as we're
  about to start pasta

- there's no need for further selection of port forwarding modes:
  pasta behaves similarly to containers-rootlessport for local binds
  (splice() instead of read()/write() pairs, without L2-L4
  translation), and keeps the original source address for non-local
  connections like slirp4netns does

- IPv6 is not an experimental feature, and enabled by default. IPv6
  port forwarding is supported

- by default, addresses and routes are copied from the host, that is,
  container users will see the same IP address and routes as if they
  were in the init namespace context. The interface name is also
  sourced from the host upstream interface with the first default
  route in the routing table. This is also configurable as documented

- sandboxing and seccomp(2) policies cannot be disabled

- only rootless mode is supported.

See https://passt.top for more details about pasta.

Also add a link to the maintained build of pasta(1) manual as valid
in the man page cross-reference checks: that's where the man page
for the latest build actually is -- it's not on Github and it doesn't
match any existing pattern, so add it explicitly.

Signed-off-by: Stefano Brivio <sbrivio@redhat.com>
 		2022-11-08 00:16:35 +01:00
..
README.md Man pages: refactor common options: --volume 2022-09-09 08:20:31 -06:00
add-host.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
annotation.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
annotation.manifest.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
arch.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
attach.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
authfile.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
blkio-weight-device.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
blkio-weight.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cap-add.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cap-drop.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cert-dir.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cgroup-conf.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cgroup-parent.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cgroupns.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cgroups.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
chrootdirs.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cidfile.read.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cidfile.write.md remove container/pod id file along with container/pod 2022-11-03 17:07:09 +01:00
color.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
compression-format.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
conmon-pidfile.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpu-period.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpu-quota.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpu-rt-period.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpu-rt-runtime.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpu-shares.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpus.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpuset-cpus.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
cpuset-mems.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
creds.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
destroy.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
detach-keys.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
device-cgroup-rule.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
device-read-bps.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
device-read-iops.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
device-write-bps.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
device-write-iops.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
device.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
digestfile.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
disable-content-trust.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
dns-option.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
dns-search.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
dns.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
entrypoint.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
env-file.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
env-host.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
env-merge.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
env.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
expose.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
features.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
follow.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
gidmap.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
gidmap.pod.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
group-add.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
health-cmd.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
health-interval.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
health-on-failure.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
health-retries.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
health-start-period.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
health-timeout.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
hostname.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
hostname.pod.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
hostuser.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
http-proxy.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
ignore.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
image-volume.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
infra-command.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
infra-conmon-pidfile.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
infra-name.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
init-path.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
init.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
interactive.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
ip.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
ip6.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
ipc.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
label-file.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
label.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
link-local-ip.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
log-driver.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
log-opt.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
mac-address.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
memory-reservation.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
memory-swap.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
memory-swappiness.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
memory.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
mount.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
name.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
names.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
network-alias.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
network.md libpod: Add pasta networking mode 2022-11-08 00:16:35 +01:00
no-healthcheck.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
no-hosts.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
no-reset.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
no-stream.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
oom-kill-disable.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
oom-score-adj.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
os-version.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
os.pull.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
passwd-entry.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
personality.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pid.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pid.pod.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pidfile.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pids-limit.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
platform.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pod-id-file.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pod-id-file.pod.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pod.run.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
preserve-fds.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
privileged.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
publish-all.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
publish.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
pull.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
read-only-tmpfs.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
read-only.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
replace.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
requires.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
restart.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
rootfs.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
sdnotify.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
seccomp-policy.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
secret.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
shm-size.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
sig-proxy.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
sign-passphrase-file.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
signal.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
since.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
stop-signal.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
stop-timeout.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
subgidname.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
subuidname.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
sysctl.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
systemd.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
tail.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
time.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
timeout.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
timestamps.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
tls-verify.md Add --insecure,--tls-verify,--verbose flags to podman manifest inspect 2022-11-03 08:00:15 -04:00
tmpfs.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
tty.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
tz.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
uidmap.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
uidmap.pod.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
ulimit.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
umask.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
unsetenv-all.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
unsetenv.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
until.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
user.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
userns.container.md man pages: assorted underscore fixes 2022-10-31 06:43:57 -06:00
userns.pod.md man pages: assorted underscore fixes 2022-10-31 06:43:57 -06:00
uts.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
uts.pod.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
variant.container.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
variant.manifest.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
volume.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
volumes-from.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00
workdir.md markdown-preprocess: cross-reference where opts are used 2022-10-20 10:57:51 -06:00

README.md

Common Man Page Options

This subdirectory contains option (flag) names and descriptions common to multiple podman man pages. Each file is one option. The filename does not necessarily need to be identical to the option name: for instance, hostname.container.md and hostname.pod.md exist because the --hostname option is sufficiently different between podman-{create,run} and podman-pod-{create,run} to warrant living separately.

How

The files here are included in podman-*.md.in files using the @@option mechanism:

@@option foo           ! will include options/foo.md

The tool that does this is hack/markdown-preprocess. It is a python script because it needs to run on readthedocs.io. From a given .md.in file, this script will create a .md file that can then be read by go-md2man, sphinx, anything that groks markdown. This runs as part of make docs.

Special Substitutions

Some options are almost identical except for 'pod' vs 'container' differences. For those, use <<text for pods|text for containers>>. Order is immaterial: the important thing is the presence of the string "pod" in one half but not the other. The correct string will be chosen based on the filename: if the file contains -pod, such as podman-pod-create, the string with pod (case-insensitive) in it will be chosen.

The string <<subcommand>> will be replaced with the podman subcommand as determined from the filename, e.g., create for podman-create.1.md.in. This allows the shared use of examples in the option file:

    Example: podman <<subcommand>> --foo --bar

As a special case, podman-pod-X becomes just X (the "pod" is removed). This makes the pod-id-file man page more useful. To get the full subcommand including 'pod', use <<fullsubcommand>>.