summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-machine.1.md
diff options
context:
space:
mode:
authorAshley Cui <acui@redhat.com>2022-06-24 10:22:25 -0400
committerAshley Cui <acui@redhat.com>2022-06-29 09:19:09 -0400
commitd9ff0fd15da268fae9744a60522ecdf94744b74a (patch)
tree4cc2cf5b9b3e15245769cdc735ba221aa7b28b1f /docs/source/markdown/podman-machine.1.md
parent4274906a80c830492e0634602350c1626288e968 (diff)
downloadpodman-d9ff0fd15da268fae9744a60522ecdf94744b74a.tar.gz
podman-d9ff0fd15da268fae9744a60522ecdf94744b74a.tar.bz2
podman-d9ff0fd15da268fae9744a60522ecdf94744b74a.zip
Only allow Rootless runs of Podman Machine
Podman Machine crashes if run as root. When creating the machine, we write the ignition so that the UID of the core user matches the UID of the user on the host. We by default, create the root user on the machine with UID 0. If the user on the host is root, the core UID and the Root UID collide, causing a the VM not to boot. [NO NEW TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-machine.1.md')
-rw-r--r--docs/source/markdown/podman-machine.1.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-machine.1.md b/docs/source/markdown/podman-machine.1.md
index e9f6c7d20..c55226e02 100644
--- a/docs/source/markdown/podman-machine.1.md
+++ b/docs/source/markdown/podman-machine.1.md
@@ -7,7 +7,14 @@ podman\-machine - Manage Podman's virtual machine
**podman machine** *subcommand*
## DESCRIPTION
-`podman machine` is a set of subcommands that manage Podman's virtual machine on macOS.
+`podman machine` is a set of subcommands that manage Podman's virtual machine.
+
+Podman on MacOS and Windows 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 must be used to manage MacOS and Windows machines,
+but can be optionally used on Linux.
+
+All `podman machine` commands are rootless only.
## SUBCOMMANDS