summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine-create.1.md
diff options
context:
space:
mode:
authorAshley Cui <acui@redhat.com>2021-03-04 15:29:12 -0500
committerbaude <bbaude@redhat.com>2021-03-25 08:41:11 -0500
commita861f6fd3ebe4fe0b63a1b550e6b99d7525228c0 (patch)
tree6d39e58da427d09e75ebbb440521d520342a0089 /docs/source/markdown/podman-machine-create.1.md
parentaf91f27d85f4104267eea493f8588f8c6a2d01e3 (diff)
downloadpodman-a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0.tar.gz
podman-a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0.tar.bz2
podman-a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0.zip
Podman machine CLI and interface stub
Podman machine will be a mac-only command that manages the VM where containers are run. Currently, only the CLI is written and the interface function for the VM management is stub for future developement The podman machine cli is only built on mac builds. Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-machine-create.1.md')
-rw-r--r--docs/source/markdown/podman-machine-create.1.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-machine-create.1.md b/docs/source/markdown/podman-machine-create.1.md
new file mode 100644
index 000000000..8282e3d56
--- /dev/null
+++ b/docs/source/markdown/podman-machine-create.1.md
@@ -0,0 +1,56 @@
+% podman-machine-create(1)
+
+## NAME
+podman\-machine\-create - Create a new virtual machine
+
+## SYNOPSIS
+**podman machine create** [*options*] *name*
+
+## DESCRIPTION
+
+Creates 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 create** creates a new Linux virtual machine where containers are run.
+
+## OPTIONS
+
+#### **--cpus**=*number*
+
+Number of CPUs.
+
+#### **--memory**, **-m**=*number*
+
+Memory (in MB).
+
+#### **--kernel-path**=*path*
+
+Print usage statement.
+
+#### **--device**=_device_[**:**_permissions_]
+
+Add a device to the virtual machine. Optional *permissions* parameter
+can be used to specify device permissions. **ro** means the device is read-only.
+
+Example: **--device=/dev/xvdc:ro**.
+
+#### **--help**
+
+Print usage statement.
+
+## EXAMPLES
+
+```
+$ podman machine create myvm
+$ podman machine create --device=/dev/xvdc:rw myvm
+$ podman machine create --memory=1024 myvm
+```
+
+## SEE ALSO
+podman-machine (1)
+
+## HISTORY
+March 2021, Originally compiled by Ashley Cui <acui@redhat.com>