Skip to content

Commit

Permalink
Merge pull request #23841 from jakecorrenti/defaultmachine
Browse files Browse the repository at this point in the history
Add disclaimer in `podman machine info` manpage
  • Loading branch information
openshift-merge-bot[bot] authored Sep 4, 2024
2 parents 2963854 + 8eb7eff commit 57efe1d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
6 changes: 6 additions & 0 deletions docs/source/markdown/podman-machine-info.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ podman\-machine\-info - Display machine host info
Display information pertaining to the machine host.
Rootless only, as all `podman machine` commands can be only be used with rootless Podman.

*Note*: The `DefaultMachine` field in the `Host` output does not suggest that
one can set a default podman machine via system connections. This value represents
the current active system connection associated with a podman machine. Regardless
of the default system connection, the default podman machine will always be
`podman-machine-default`.

## OPTIONS

#### **--format**, **-f**=*format*
Expand Down
10 changes: 8 additions & 2 deletions pkg/domain/entities/machine.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,14 @@ type MachineInfo struct {

// MachineHostInfo contains info on the machine host
type MachineHostInfo struct {
Arch string `json:"Arch"`
CurrentMachine string `json:"CurrentMachine"`
Arch string `json:"Arch"`
CurrentMachine string `json:"CurrentMachine"`
// TODO(6.0): Change `DefaultName` to `ActiveMachineConnection` to fix address
// confusion as shown in https://github.com/containers/podman/issues/23353.
// The name `DefaultMachine` can cause confusion with the user in thinking that
// they can set a default podman machine via system connections. However,
// regardless of which system connection is default, the default podman machine
// will always be podman-machine-default.
DefaultMachine string `json:"DefaultMachine"`
EventsDir string `json:"EventsDir"`
MachineConfigDir string `json:"MachineConfigDir"`
Expand Down

1 comment on commit 57efe1d

@packit-as-a-service
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

podman-next COPR build failed. @containers/packit-build please check.

Please sign in to comment.