summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2021-03-30 09:41:58 -0500
committerbaude <bbaude@redhat.com>2021-03-30 09:44:04 -0500
commitb898b19e454e01bede70f8861b49d9ccd61740e8 (patch)
tree70f9fedae2f88be63f9891594e8c499c201e3e15 /docs/source
parent5e28b35aa511e699dffb2172458fda35ac01a4d2 (diff)
downloadpodman-b898b19e454e01bede70f8861b49d9ccd61740e8.tar.gz
podman-b898b19e454e01bede70f8861b49d9ccd61740e8.tar.bz2
podman-b898b19e454e01bede70f8861b49d9ccd61740e8.zip
podman machine init --ignition-path
allow for the user to provide an alternate ignition-file rather than the auto-generated one. updated docs to describe ramifications of providing an alterate ignition file. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-machine-init.1.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-machine-init.1.md b/docs/source/markdown/podman-machine-init.1.md
index e2ed1eb10..930086ff4 100644
--- a/docs/source/markdown/podman-machine-init.1.md
+++ b/docs/source/markdown/podman-machine-init.1.md
@@ -28,7 +28,12 @@ Size of the disk for the guest VM in GB.
#### **\-\-ignition-path**
-Fully qualified path of the ignition file
+Fully qualified path of the ignition file.
+
+If an ignition file is provided, the file
+will be copied into the user's CONF_DIR and renamed. Additionally, no SSH keys will
+be generated nor will a system connection be made. It is assumed that the user will
+do these things manually or handle otherwise.
#### **\-\-image-path**