From a861f6fd3ebe4fe0b63a1b550e6b99d7525228c0 Mon Sep 17 00:00:00 2001 From: Ashley Cui Date: Thu, 4 Mar 2021 15:29:12 -0500 Subject: 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 --- docs/source/markdown/podman-machine-create.1.md | 56 +++++++++++++++++++++++++ docs/source/markdown/podman-machine-start.1.md | 35 ++++++++++++++++ docs/source/markdown/podman-machine-stop.1.md | 35 ++++++++++++++++ docs/source/markdown/podman-machine.1.md | 24 +++++++++++ docs/source/markdown/podman.1.md | 1 + 5 files changed, 151 insertions(+) create mode 100644 docs/source/markdown/podman-machine-create.1.md create mode 100644 docs/source/markdown/podman-machine-start.1.md create mode 100644 docs/source/markdown/podman-machine-stop.1.md create mode 100644 docs/source/markdown/podman-machine.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 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 diff --git a/docs/source/markdown/podman-machine-start.1.md b/docs/source/markdown/podman-machine-start.1.md new file mode 100644 index 000000000..511296b11 --- /dev/null +++ b/docs/source/markdown/podman-machine-start.1.md @@ -0,0 +1,35 @@ +% podman-machine-start(1) + +## NAME +podman\-machine\-start - Start a virtual machine + +## SYNOPSIS +**podman machine start** *name* + +## DESCRIPTION + +Starts a 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 start** starts a Linux virtual machine where containers are run. + +## OPTIONS + +#### **--help** + +Print usage statement. + +## EXAMPLES + +``` +$ podman machine start myvm +``` + +## SEE ALSO +podman-machine (1) + +## HISTORY +March 2021, Originally compiled by Ashley Cui diff --git a/docs/source/markdown/podman-machine-stop.1.md b/docs/source/markdown/podman-machine-stop.1.md new file mode 100644 index 000000000..62439cbb1 --- /dev/null +++ b/docs/source/markdown/podman-machine-stop.1.md @@ -0,0 +1,35 @@ +% podman-machine-stop(1) + +## NAME +podman\-machine\-stop - Stop a virtual machine + +## SYNOPSIS +**podman machine stop** *name* + +## DESCRIPTION + +Stops a virtual machine. + +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 stop** stops a Linux virtual machine where containers are run. + +## OPTIONS + +#### **--help** + +Print usage statement. + +## EXAMPLES + +``` +$ podman machine stop 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 new file mode 100644 index 000000000..167a6a9e9 --- /dev/null +++ b/docs/source/markdown/podman-machine.1.md @@ -0,0 +1,24 @@ +% podman-machine(1) + +## NAME +podman\-machine - Manage Podman's virtual machine + +## SYNOPSIS +**podman machine** *subcommand* + +## DESCRIPTION +`podman machine` is a set of subcommands that manage Podman's virtual machine on MacOS. + +## SUBCOMMANDS + +| Command | Man Page | Description | +| ------- | ------------------------------------------------------- | ----------------------------- | +| create | [podman-machine-create(1)](podman-machine-create.1.md) | Create a new 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) + +## HISTORY +March 2021, Originally compiled by Ashley Cui diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 141d231f3..7bf7aa210 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -237,6 +237,7 @@ the exit codes follow the `chroot` standard, see below: | [podman-login(1)](podman-login.1.md) | Login to a container registry. | | [podman-logout(1)](podman-logout.1.md) | Logout of a container registry. | | [podman-logs(1)](podman-logs.1.md) | Display the logs of one or more containers. | +| [podman-machine(1)](podman-machine.1.md) | Manage Podman's virtual machine | | [podman-manifest(1)](podman-manifest.1.md) | Create and manipulate manifest lists and image indexes. | | [podman-mount(1)](podman-mount.1.md) | Mount a working container's root filesystem. | | [podman-network(1)](podman-network.1.md) | Manage Podman CNI networks. | -- cgit v1.2.3-54-g00ecf