mirror of
https://github.com/containers/podman.git
synced 2025-05-17 23:26:08 +08:00
Document podman-machine-default behavior
When no name arg is given to Podman machine commands, Podman assumes the machine name is podman-machine-default. Document this behavior. Signed-off-by: Ashley Cui <acui@redhat.com>
This commit is contained in:
@ -22,7 +22,7 @@ var (
|
|||||||
PersistentPreRunE: rootlessOnly,
|
PersistentPreRunE: rootlessOnly,
|
||||||
RunE: initMachine,
|
RunE: initMachine,
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
Example: `podman machine init myvm`,
|
Example: `podman machine init podman-machine-default`,
|
||||||
ValidArgsFunction: completion.AutocompleteNone,
|
ValidArgsFunction: completion.AutocompleteNone,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -23,7 +23,7 @@ var (
|
|||||||
PersistentPreRunE: rootlessOnly,
|
PersistentPreRunE: rootlessOnly,
|
||||||
RunE: rm,
|
RunE: rm,
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
Example: `podman machine rm myvm`,
|
Example: `podman machine rm podman-machine-default`,
|
||||||
ValidArgsFunction: autocompleteMachine,
|
ValidArgsFunction: autocompleteMachine,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
@ -22,7 +22,7 @@ var (
|
|||||||
Long: "SSH into a managed virtual machine ",
|
Long: "SSH into a managed virtual machine ",
|
||||||
PersistentPreRunE: rootlessOnly,
|
PersistentPreRunE: rootlessOnly,
|
||||||
RunE: ssh,
|
RunE: ssh,
|
||||||
Example: `podman machine ssh myvm
|
Example: `podman machine ssh podman-machine-default
|
||||||
podman machine ssh myvm echo hello`,
|
podman machine ssh myvm echo hello`,
|
||||||
ValidArgsFunction: autocompleteMachineSSH,
|
ValidArgsFunction: autocompleteMachineSSH,
|
||||||
}
|
}
|
||||||
|
@ -20,7 +20,7 @@ var (
|
|||||||
PersistentPreRunE: rootlessOnly,
|
PersistentPreRunE: rootlessOnly,
|
||||||
RunE: start,
|
RunE: start,
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
Example: `podman machine start myvm`,
|
Example: `podman machine start podman-machine-default`,
|
||||||
ValidArgsFunction: autocompleteMachine,
|
ValidArgsFunction: autocompleteMachine,
|
||||||
}
|
}
|
||||||
startOpts = machine.StartOptions{}
|
startOpts = machine.StartOptions{}
|
||||||
|
@ -20,7 +20,7 @@ var (
|
|||||||
PersistentPreRunE: rootlessOnly,
|
PersistentPreRunE: rootlessOnly,
|
||||||
RunE: stop,
|
RunE: stop,
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
Example: `podman machine stop myvm`,
|
Example: `podman machine stop podman-machine-default`,
|
||||||
ValidArgsFunction: autocompleteMachine,
|
ValidArgsFunction: autocompleteMachine,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
@ -10,6 +10,9 @@ podman\-machine\-init - Initialize a new virtual machine
|
|||||||
|
|
||||||
Initialize a new virtual machine for Podman.
|
Initialize a new virtual machine for Podman.
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then the new machine will be named `podman-machine-default`.
|
||||||
|
|
||||||
Rootless only.
|
Rootless only.
|
||||||
|
|
||||||
Podman on MacOS and Windows requires a virtual machine. This is because containers are Linux -
|
Podman on MacOS and Windows requires a virtual machine. This is because containers are Linux -
|
||||||
|
@ -4,15 +4,18 @@
|
|||||||
podman\-machine\-inspect - Inspect one or more virtual machines
|
podman\-machine\-inspect - Inspect one or more virtual machines
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
**podman machine inspect** [*options*] *name* ...
|
**podman machine inspect** [*options*] [*name*] ...
|
||||||
|
|
||||||
## DESCRIPTION
|
## DESCRIPTION
|
||||||
|
|
||||||
Inspect one or more virtual machines
|
Inspect one or more virtual machines
|
||||||
|
|
||||||
Obtain greater detail about Podman virtual machines. More than one virtual machine can be
|
Obtain greater detail about Podman virtual machines. More than one virtual machine can be
|
||||||
inspected at once.
|
inspected at once.
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then `podman-machine-default` will be inspected.
|
||||||
|
|
||||||
Rootless only.
|
Rootless only.
|
||||||
|
|
||||||
## OPTIONS
|
## OPTIONS
|
||||||
|
@ -17,6 +17,9 @@ By default, Podman machines on Mac and Linux use an rpm-ostree based distrubitio
|
|||||||
|
|
||||||
For more information, please see the [rpm-ostree docs](https://coreos.github.io/rpm-ostree/container/).
|
For more information, please see the [rpm-ostree docs](https://coreos.github.io/rpm-ostree/container/).
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then the OS changes will be applied to `podman-machine-default`.
|
||||||
|
|
||||||
## OPTIONS
|
## OPTIONS
|
||||||
|
|
||||||
#### **--help**
|
#### **--help**
|
||||||
|
@ -16,6 +16,9 @@ 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`
|
Users get a display of what will be deleted and are required to confirm unless the option `--force`
|
||||||
is used.
|
is used.
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then `podman-machine-default` will be removed.
|
||||||
|
|
||||||
Rootless only.
|
Rootless only.
|
||||||
|
|
||||||
## OPTIONS
|
## OPTIONS
|
||||||
|
@ -10,6 +10,9 @@ podman\-machine\-set - Sets a virtual machine setting
|
|||||||
|
|
||||||
Change a machine setting.
|
Change a machine setting.
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then the settings will be applied to `podman-machine-default`.
|
||||||
|
|
||||||
Rootless only.
|
Rootless only.
|
||||||
|
|
||||||
## OPTIONS
|
## OPTIONS
|
||||||
|
@ -16,6 +16,9 @@ with the virtual machine is established.
|
|||||||
|
|
||||||
The exit code from ssh command will be forwarded to the podman machine ssh caller, see [Exit Codes](#Exit-Codes).
|
The exit code from ssh command will be forwarded to the podman machine ssh caller, see [Exit Codes](#Exit-Codes).
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then `podman-machine-default` will be SSH'd into.
|
||||||
|
|
||||||
Rootless only.
|
Rootless only.
|
||||||
|
|
||||||
## OPTIONS
|
## OPTIONS
|
||||||
|
@ -17,6 +17,9 @@ 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,
|
tied to the Linux kernel. Podman machine must be used to manage MacOS and Windows machines,
|
||||||
but can be optionally used on Linux.
|
but can be optionally used on Linux.
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then `podman-machine-default` will be started.
|
||||||
|
|
||||||
Only one Podman managed VM can be active at a time. If a VM is already running,
|
Only one Podman managed VM can be active at a time. If a VM is already running,
|
||||||
`podman machine start` will return an error.
|
`podman machine start` will return an error.
|
||||||
|
|
||||||
|
@ -10,6 +10,9 @@ podman\-machine\-stop - Stop a virtual machine
|
|||||||
|
|
||||||
Stops a virtual machine.
|
Stops a virtual machine.
|
||||||
|
|
||||||
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
||||||
|
then `podman-machine-default` will be stopped.
|
||||||
|
|
||||||
Rootless only.
|
Rootless only.
|
||||||
|
|
||||||
Podman on MacOS and Windows requires a virtual machine. This is because containers are Linux -
|
Podman on MacOS and Windows requires a virtual machine. This is because containers are Linux -
|
||||||
|
Reference in New Issue
Block a user