diff options
author | Paul Holzinger <paul.holzinger@web.de> | 2020-11-10 14:59:34 +0100 |
---|---|---|
committer | Paul Holzinger <paul.holzinger@web.de> | 2020-11-10 15:27:08 +0100 |
commit | 52a869470530f3c6bf7820a2b63fa9e17f227a16 (patch) | |
tree | 84d2940f763b124c75dd124aecbf76ff3707f140 /docs/source/markdown/podman-play-kube.1.md | |
parent | da01191aa3526e3a77d9a055e23c318c26720785 (diff) | |
download | podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.gz podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.tar.bz2 podman-52a869470530f3c6bf7820a2b63fa9e17f227a16.zip |
Add anchors for flag names on docs.podman.io
Change the docs markdown so that flag names will be h4 headers.
Sphinx will automatically add anchors to headers. Add css to
make sure the flag names are not to big compared to the text.
The man pages also still renders fine but it looks a bit different.
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.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index 97b0dc09a..d595afb3e 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -17,7 +17,7 @@ Note: HostPath volume types created by play kube will be given an SELinux privat ## 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`. @@ -25,42 +25,42 @@ 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_. (Not available for remote commands) -**--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. -**--network**=*cni networks* +#### **--network**=*cni networks* 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"). (Not available for remote commands) -**--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 |