From f6638571037c3d92066540e32fa08b76ce7f1fd8 Mon Sep 17 00:00:00 2001 From: Ashley Cui Date: Thu, 25 Mar 2021 15:28:49 -0400 Subject: Rename podman machine create to init and clean up Rename podman machine create to init because we're initing a VM, not really creating it Wire up CPUs flag Suppress QEMU GUI from popping up when not in debug mode [NO TESTS NEEDED] Signed-off-by: Ashley Cui --- docs/source/markdown/podman-machine-create.1.md | 53 ------------------------- docs/source/markdown/podman-machine-init.1.md | 53 +++++++++++++++++++++++++ docs/source/markdown/podman-machine.1.md | 14 +++---- 3 files changed, 60 insertions(+), 60 deletions(-) delete mode 100644 docs/source/markdown/podman-machine-create.1.md create mode 100644 docs/source/markdown/podman-machine-init.1.md (limited to 'docs/source/markdown') diff --git a/docs/source/markdown/podman-machine-create.1.md b/docs/source/markdown/podman-machine-create.1.md deleted file mode 100644 index eb498f2dd..000000000 --- a/docs/source/markdown/podman-machine-create.1.md +++ /dev/null @@ -1,53 +0,0 @@ -% 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. - -#### **--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 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 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 diff --git a/docs/source/markdown/podman-machine.1.md b/docs/source/markdown/podman-machine.1.md index 52f212cdd..0e3c1ca34 100644 --- a/docs/source/markdown/podman-machine.1.md +++ b/docs/source/markdown/podman-machine.1.md @@ -11,13 +11,13 @@ podman\-machine - Manage Podman's virtual machine ## SUBCOMMANDS -| Command | Man Page | Description | -| ------- | ------------------------------------------------------- | ----------------------------- | -| create | [podman-machine-create(1)](podman-machine-create.1.md) | Create a new virtual machine | -| remove | [podman-machine-destroy(1)](podman-machine-remove.1.md)| Remove a virtual machine | -| ssh | [podman-machine-ssh.1.md(1)](podman-machine-ssh.1.md) | SSH into a virtual machine | -| start | [podman-machine-start(1)](podman-machine-start.1.md) | Start a virtual machine | -| stop | [podman-machine-stop(1)](podman-machine-stop.1.md) | Stop a virtual machine | +| Command | Man Page | Description | +| ------- | ------------------------------------------------------- | --------------------------------- | +| init | [podman-machine-init(1)](podman-machine-init.1.md) | Initialize a new virtual machine | +| remove | [podman-machine-remove(1)](podman-machine-remove.1.md) | Remove a virtual machine | +| ssh | [podman-machine-ssh(1)](podman-machine-ssh.1.md) | SSH into a virtual machine | +| start | [podman-machine-start(1)](podman-machine-start.1.md) | Start a virtual machine | +| stop | [podman-machine-stop(1)](podman-machine-stop.1.md) | Stop a virtual machine | ## SEE ALSO podman(1) -- cgit v1.2.3-54-g00ecf