summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-play-kube.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-05-07 18:30:00 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-05-07 18:30:00 +0200
commit30e731ecc8e439d038bbd2b7ab964a980579acf8 (patch)
treef17f242dca7395f83cbe7cc5aff22adf37bcc9d8 /docs/source/markdown/podman-play-kube.1.md
parent5616887f62b4bed1031cdade8bd602bc2cb9d8f4 (diff)
downloadpodman-30e731ecc8e439d038bbd2b7ab964a980579acf8.tar.gz
podman-30e731ecc8e439d038bbd2b7ab964a980579acf8.tar.bz2
podman-30e731ecc8e439d038bbd2b7ab964a980579acf8.zip
Revert escaped double dash man page flag syntax
Commit 800a2e2d35 introduced a way to disable the conversion of `--`into an en dash on docs.podman.io, so the ugly workaround of escaping the dashes is no longer necessary. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-play-kube.1.md')
-rw-r--r--docs/source/markdown/podman-play-kube.1.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md
index ab2019139..98b303ae7 100644
--- a/docs/source/markdown/podman-play-kube.1.md
+++ b/docs/source/markdown/podman-play-kube.1.md
@@ -37,7 +37,7 @@ A Kubernetes PersistentVolumeClaim represents a Podman named volume. Only the Pe
## OPTIONS
-#### **\-\-authfile**=*path*
+#### **--authfile**=*path*
Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.
@@ -45,58 +45,58 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec
Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
environment variable. `export REGISTRY_AUTH_FILE=path`
-#### **\-\-cert-dir**=*path*
+#### **--cert-dir**=*path*
Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry.
Default certificates directory is _/etc/containers/certs.d_. (This option is not available with the remote Podman client)
-#### **\-\-configmap**=*path*
+#### **--configmap**=*path*
Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod.
Note: The *--configmap* option can be used multiple times or a comma-separated list of paths can be used to pass multiple Kubernetes configmap YAMLs.
-#### **\-\-creds**
+#### **--creds**
The [username[:password]] to use to authenticate with the registry if required.
If one or both values are not supplied, a command line prompt will appear and the
value can be entered. The password is entered without echo.
-#### **\-\-ip**=*IP address*
+#### **--ip**=*IP address*
Assign a static ip address to the pod. This option can be specified several times when play kube creates more than one pod.
-#### **\-\-log-driver**=driver
+#### **--log-driver**=driver
Set logging driver for all created containers.
-#### **\-\-mac-address**=*MAC address*
+#### **--mac-address**=*MAC address*
Assign a static mac address to the pod. This option can be specified several times when play kube creates more than one pod.
-#### **\-\-network**=*networks*, **\-\-net**
+#### **--network**=*networks*, **--net**
A comma-separated list of the names of CNI networks the pod should join.
-#### **\-\-quiet**, **-q**
+#### **--quiet**, **-q**
Suppress output information when pulling images
-#### **\-\-seccomp-profile-root**=*path*
+#### **--seccomp-profile-root**=*path*
Directory path for seccomp profiles (default: "/var/lib/kubelet/seccomp"). (This option is not available with the remote Podman client)
-#### **\-\-start**=*true|false*
+#### **--start**=*true|false*
Start the pod after creating it, set to false to only create it.
-#### **\-\-tls-verify**=*true|false*
+#### **--tls-verify**=*true|false*
Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true,
then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified,
TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.
-#### **\-\-help**, **-h**
+#### **--help**, **-h**
Print usage statement