diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2021-03-28 10:55:45 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-28 10:55:45 +0000 |
commit | b2e7a3e45c89132e41b0d864dbc4eacacbecf08d (patch) | |
tree | f990f0b9b079cecce73f0730ffc2c6a1fe2bec82 /docs | |
parent | 4831d4134606699615454caa1ee75e7d37ee778b (diff) | |
parent | 7a79f708a4521ba7c42da83a204a01ace010ace3 (diff) | |
download | podman-b2e7a3e45c89132e41b0d864dbc4eacacbecf08d.tar.gz podman-b2e7a3e45c89132e41b0d864dbc4eacacbecf08d.tar.bz2 podman-b2e7a3e45c89132e41b0d864dbc4eacacbecf08d.zip |
Merge pull request #9836 from baude/vmcreateresize
Podman machine enhancements
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/machine.rst | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-machine-init.1.md | 4 | ||||
-rw-r--r-- | docs/source/markdown/podman-machine-rm.1.md (renamed from docs/source/markdown/podman-machine-remove.1.md) | 10 | ||||
-rw-r--r-- | docs/source/markdown/podman-machine-ssh.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-machine-start.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-machine-stop.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-machine.1.md | 8 |
7 files changed, 17 insertions, 13 deletions
diff --git a/docs/source/machine.rst b/docs/source/machine.rst index 55df29667..be9ef1e95 100644 --- a/docs/source/machine.rst +++ b/docs/source/machine.rst @@ -3,7 +3,7 @@ Machine :doc:`init <markdown/podman-machine-init.1>` Initialize a new virtual machine -:doc:`remove <markdown/podman-machine-remove.1>` Remove a virtual machine +:doc:`rm <markdown/podman-machine-rm.1>` Remove a virtual machine :doc:`ssh <markdown/podman-machine-ssh.1>` SSH into a virtual machine :doc:`start <markdown/podman-machine-start.1>` Start a virtual machine :doc:`stop <markdown/podman-machine-stop.1>` Stop a virtual machine diff --git a/docs/source/markdown/podman-machine-init.1.md b/docs/source/markdown/podman-machine-init.1.md index 5ff07de03..be07a7bd5 100644 --- a/docs/source/markdown/podman-machine-init.1.md +++ b/docs/source/markdown/podman-machine-init.1.md @@ -22,6 +22,10 @@ tied to the Linux kernel. Number of CPUs. +#### **--disk-size**=*number* + +Size of the disk for the guest VM in GB. + #### **--ignition-path** Fully qualified path of the ignition file diff --git a/docs/source/markdown/podman-machine-remove.1.md b/docs/source/markdown/podman-machine-rm.1.md index 07763741d..4da17fdcb 100644 --- a/docs/source/markdown/podman-machine-remove.1.md +++ b/docs/source/markdown/podman-machine-rm.1.md @@ -1,17 +1,17 @@ -% podman-machine-remove(1) +% podman-machine-rm(1) ## NAME -podman\-machine\-remove - Remove a virtual machine +podman\-machine\-rm - Remove a virtual machine ## SYNOPSIS -**podman machine remove** [*options*] *name* +**podman machine rm** [*options*] [*name*] ## DESCRIPTION Remove a virtual machine and its related files. What is actually deleted depends on the virtual machine type. For all virtual machines, the generated SSH keys and the podman system connection are deleted. The ignition files -generated for that VM are also removeed as is its image file on the filesystem. +generated for that VM are also removed as is its image file on the filesystem. Users get a display of what will be deleted and are required to confirm unless the option `--force` is used. @@ -45,7 +45,7 @@ deleted. Remove a VM named "test1" ``` -$ podman machine remove test1 +$ podman machine rm test1 The following files will be deleted: diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md index bcecd1010..01cec1f57 100644 --- a/docs/source/markdown/podman-machine-ssh.1.md +++ b/docs/source/markdown/podman-machine-ssh.1.md @@ -4,7 +4,7 @@ podman\-machine\-ssh - SSH into a virtual machine ## SYNOPSIS -**podman machine ssh** [*options*] *name* [*command* [*arg* ...]] +**podman machine ssh** [*options*] [*name*] [*command* [*arg* ...]] ## DESCRIPTION diff --git a/docs/source/markdown/podman-machine-start.1.md b/docs/source/markdown/podman-machine-start.1.md index 511296b11..7f3a9f592 100644 --- a/docs/source/markdown/podman-machine-start.1.md +++ b/docs/source/markdown/podman-machine-start.1.md @@ -4,7 +4,7 @@ podman\-machine\-start - Start a virtual machine ## SYNOPSIS -**podman machine start** *name* +**podman machine start** [*name*] ## DESCRIPTION diff --git a/docs/source/markdown/podman-machine-stop.1.md b/docs/source/markdown/podman-machine-stop.1.md index 62439cbb1..f4be54511 100644 --- a/docs/source/markdown/podman-machine-stop.1.md +++ b/docs/source/markdown/podman-machine-stop.1.md @@ -4,7 +4,7 @@ podman\-machine\-stop - Stop a virtual machine ## SYNOPSIS -**podman machine stop** *name* +**podman machine stop** [*name*] ## DESCRIPTION diff --git a/docs/source/markdown/podman-machine.1.md b/docs/source/markdown/podman-machine.1.md index 0e3c1ca34..a5d3b78df 100644 --- a/docs/source/markdown/podman-machine.1.md +++ b/docs/source/markdown/podman-machine.1.md @@ -14,10 +14,10 @@ podman\-machine - Manage Podman's 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 | +| rm | [podman-machine-rm(1)](podman-machine-rm.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) |