summaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2021-03-25 10:35:43 -0500
committerbaude <bbaude@redhat.com>2021-03-27 10:08:11 -0500
commit7a79f708a4521ba7c42da83a204a01ace010ace3 (patch)
tree42e4128908fa127d158ad0673b033740d416d1f4 /docs/source/markdown
parentec47312eebf11abcf74b5bf06df19ee2fb7b8afd (diff)
downloadpodman-7a79f708a4521ba7c42da83a204a01ace010ace3.tar.gz
podman-7a79f708a4521ba7c42da83a204a01ace010ace3.tar.bz2
podman-7a79f708a4521ba7c42da83a204a01ace010ace3.zip
Podman machine enhancements
Podman machine remove is now called `rm`. Podman machine create now supports resizing the image to the value of --disk-size as provided. The default is to 10G. Added systemd unit file on guest via ignition that sends a Ready message to the host over a virtio-socket so that we know when the VM is booted and ready for use. Podman machine commands no longer require a VM name as an argument. A default VM name is defined and if no VM name is provided as a arg, the default will be used. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/podman-machine-init.1.md4
-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.md2
-rw-r--r--docs/source/markdown/podman-machine-start.1.md2
-rw-r--r--docs/source/markdown/podman-machine-stop.1.md2
-rw-r--r--docs/source/markdown/podman-machine.1.md8
6 files changed, 16 insertions, 12 deletions
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)