summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine-init.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-03-26 13:45:11 +0000
committerGitHub <noreply@github.com>2021-03-26 13:45:11 +0000
commit25525ff834cc979566bb09e5546ee0a72ef76a79 (patch)
tree382f7f94db7230225e2e4a23975045118b4a12da /docs/source/markdown/podman-machine-init.1.md
parent7ae1d23a380ae0c9cf4edb64ba288a8464c3cf13 (diff)
parentf6638571037c3d92066540e32fa08b76ce7f1fd8 (diff)
downloadpodman-25525ff834cc979566bb09e5546ee0a72ef76a79.tar.gz
podman-25525ff834cc979566bb09e5546ee0a72ef76a79.tar.bz2
podman-25525ff834cc979566bb09e5546ee0a72ef76a79.zip
Merge pull request #9820 from ashley-cui/machineinit
[NO TESTS NEEDED] Rename podman machine create to init and clean up
Diffstat (limited to 'docs/source/markdown/podman-machine-init.1.md')
-rw-r--r--docs/source/markdown/podman-machine-init.1.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-machine-init.1.md b/docs/source/markdown/podman-machine-init.1.md
new file mode 100644
index 000000000..5ff07de03
--- /dev/null
+++ b/docs/source/markdown/podman-machine-init.1.md
@@ -0,0 +1,53 @@
+% podman-machine-init(1)
+
+## NAME
+podman\-machine\-init - Initialize a new virtual machine
+
+## SYNOPSIS
+**podman machine init** [*options*] [*name*]
+
+## DESCRIPTION
+
+Initialize a new virtual machine for Podman.
+
+Podman on MacOS requires a virtual machine. This is because containers are Linux -
+containers do not run on any other OS because containers' core functionality are
+tied to the Linux kernel.
+
+**podman machine init** initializes a new Linux virtual machine where containers are run.
+
+## OPTIONS
+
+#### **--cpus**=*number*
+
+Number of CPUs.
+
+#### **--ignition-path**
+
+Fully qualified path of the ignition file
+
+#### **--image-path**
+
+Fully qualified path of the uncompressed image file
+
+#### **--memory**, **-m**=*number*
+
+Memory (in MB).
+
+#### **--help**
+
+Print usage statement.
+
+## EXAMPLES
+
+```
+$ podman machine init myvm
+$ podman machine init --device=/dev/xvdc:rw myvm
+$ podman machine init --memory=1024 myvm
+```
+
+## SEE ALSO
+podman-machine (1)
+
+## HISTORY
+March 2021, Originally compiled by Ashley Cui <acui@redhat.com>