Podman machine info #14762

ashley-cui · 2022-06-28T18:20:37Z

Add podman machine info command, which displays info about the machine
host as well as version info.

Signed-off-by: Ashley Cui [email protected]

Does this PR introduce a user-facing change?

Add podman machine info command, which displays info about the machine
host as well as version info.

openshift-ci · 2022-06-28T18:20:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ashley-cui

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ashley-cui]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ashley-cui · 2022-06-28T18:21:01Z

Fixes: #14113

ashley-cui · 2022-06-28T18:22:01Z

cmd/podman/machine/info.go

+	}
+
+	host.NumberOfMachines = len(listResponse)
+	host.RemoteSocket = fmt.Sprintf("/run/user/%d/podman/podman.sock", os.Getuid())


This is the only field I'm not sure is entirely correct, please correct me if I'm wrong here.

ashley-cui · 2022-06-28T18:22:15Z

@baude @benoitf PTAL

cdoern

Is there any info to indicate whether the machine is starting? Or would that not be pertinent here, only in machine list?

cdoern · 2022-06-28T19:13:51Z

cmd/podman/machine/info.go

+	}
+
+	host.NumberOfMachines = len(listResponse)
+	host.RemoteSocket = fmt.Sprintf("/run/user/%d/podman/podman.sock", os.Getuid())


if running rootful do we need to check for /run/podman/podman.sock?

or actually given #14706 this is not an issue. That URL is right for rootless (I think)

This should be based on the valure of XDG_RUNTIME_DIR, shouldn't it?

Wouldn't that just be the same as eventSockDIr? Or is remote socket something different? @baude, thoughts?

It is defined right here for podman info ->

podman/pkg/domain/infra/abi/system.go

Line 46 in 6c4c050

uri := url.URL{

benoitf · 2022-06-29T13:56:56Z

That command is really helpful.

Few notes:

it has been said by someone else but yes I would expect to know if a Podman machine is currently starting (or stopping)
I would expect things changing to be prefixed by 'Current' maybe (or be in a sub-section)
For example RemoteSocket will change depending on the machine we start (and the same for the currently running machine RunningMachine) while arch, DefaultMachine, EventsDir, etc. are for all machines

like:
```
 "Host": {
 "NumberOfMachines": 1, 
 "currentMachine" : {
    "Name": "podman-machine-default",
    "Starting": true,
    "Running": false,
    "Stopping": false,
    "RemoteSocket": "/run/user/501/podman/podman.sock"
```

}

docs/source/markdown/podman-machine-info.1.md

pkg/machine/e2e/info_test.go

baude · 2022-06-29T14:14:19Z

would it be enough to list the machines by name and then use the statuses to determine which is "current"?

mheon · 2022-06-29T14:16:35Z

Why are we including a list of machines? That seems like a podman machine ls thing?

benoitf · 2022-06-29T14:19:27Z

I would like to have the LocalSocket as well (or 'ContainerHost' link )

because for example RemoteSocket: /run/user/501/podman/podman.sock is not so interesting while using a machine

I would prefer to know the /Users/benoitf/.local/share/containers/podman/machine/podman-machine-default/podman.sock path

baude · 2022-06-29T14:32:18Z

@mheon thanks for the reminder on machine ls; indeed, I did not want to list each machine in machine info; that is what podman machine ls is for ... i think the original idea was to give number of machines; and if a machine was running, to show that.

mheon · 2022-06-29T14:44:09Z

Number of machines/number of running, maybe? Knowing at least 1 is up is a clue to go to machine ls to check, I'd imagine.

ashley-cui · 2022-06-29T15:26:30Z

@mheon, @baude , @benoitf I'd agree that we shouldn't list machines in machine info, and I'd also prefer if we don't add any information on the machine, as that's covered by podman machine inspect. podman machine info should be generic, ie the information in podman machine info should be relevant to every machine on the system. I think if we do display the machine socket, that should be in inspect.

@mheon, Only one machine can be up at a time, so maybe a field like machineRunning that's a bool?

benoitf · 2022-06-29T15:43:18Z

I'm ok to remove all the content that is related to the current machine (like sockets, etc) (and then add it in the inspect command)

About the default machine, can we change through cli the default machine name or is it always 'podman-machine-default' ?

but I think user wants to know the current status of the machine: running, starting or stopped (Running is not enough)

because if you do podman machine info and the machine is still not displayed as RunningMachine you may try to execute podman machine start while the machine is already trying to start

I would also be interested to know if machine has failed to start (it's not running but there was a failure)

so something like

  "CurrentMachine": "podman-machine-default",
  "State|Status": "Starting|Running|Stopped|Failed|N/A...",

ashley-cui · 2022-06-29T15:53:09Z

Sure, I think default machine is the same thing as current machine. I think I would be okay with adding something like default machine state too, if the others are as well. 😄

baude · 2022-06-30T15:06:06Z

i assume current machine to mean -- the machine that is running and has nothing to do with default. And using that definition, if a machine is running, the state must be running as well. Am I viewing this differently than others? @rhatdan what so you?

rhatdan · 2022-06-30T17:25:08Z

Since we only have one machine running at a time, I would expect it to be current machine, if no machine is running then it should be default.

ashley-cui · 2022-06-30T18:48:55Z

Updated!

rhatdan · 2022-07-01T11:40:18Z

LGTM
@benoitf @baude PTAL

benoitf · 2022-07-01T11:58:24Z

I tried again the command

when I launch podman machine info without a machine I can see

Host:
  Arch: amd64
  CurrentMachine: ""
  DefaultMachine: ""
  EventsDir: /var/folders/tg/_5rxbhmj4xncz4szvpgswrmc0000gn/T/podman-run--1/podman
  MachineConfigDir: /Users/benoitf/.config/containers/podman/machine/qemu
  MachineImageDir: /Users/benoitf/.local/share/containers/podman/machine/qemu
  MachineState: ""
  NumberOfMachines: 0
  OS: darwin
  RemoteSocket: /var/folders/tg/_5rxbhmj4xncz4szvpgswrmc0000gn/T/podman-run--1/podman/podman.sock
  VMType: qemu

But the RemoteSocket path does not exists

$ ls -la /var/folders/tg/_5rxbhmj4xncz4szvpgswrmc0000gn/T/podman-run--1/podman/podman.sock
ls: /var/folders/tg/_5rxbhmj4xncz4szvpgswrmc0000gn/T/podman-run--1/podman/podman.sock: No such file or directory

on my side the socket is at
~/.local/share/containers/podman/machine/podman.sock symlink to /Users/benoitf/.local/share/containers/podman/machine/podman-machine-default/podman.sock

If I only create a machine but I don't start it
podman machine info reports

RemoteSocket: /var/folders/tg/_5rxbhmj4xncz4szvpgswrmc0000gn/T/podman-run--1/podman/podman.sock

but socket path still doesn't exists

and even if I do run the machine the path is still incorrect ?

so

the path displayed is invalid ?
I don't know if RemoteSocket should be displayed if there is no machine or if there is no machine running

as further improvement, I would like to see, if possible, (like in another enhancement) that a machine is being created/initialized

if I do podman machine init in one terminal and podman machine info in another one

I would expect to have when doing podman machine info

  ...
  CurrentMachine: podman-machine-default
  DefaultMachine: podman-machine-default
  ...
  MachineState: Creating
  NumberOfMachines: 1

ashley-cui · 2022-07-01T15:55:24Z

the path displayed is invalid ?

I don't know if RemoteSocket should be displayed if there is no machine or if there is no machine running

Hmm, okay I think then it isn't XDG_RUNTIME_DIR, let me take another look and fix it

as further improvement, I would like to see, if possible, (like in another enhancement) that a machine is being created/initialized

if I do podman machine init in one terminal and podman machine info in another one

I would expect to have when doing podman machine info
  ...
  CurrentMachine: podman-machine-default
  DefaultMachine: podman-machine-default
  ...
  MachineState: Creating
  NumberOfMachines: 1

I'm not sure if we have a creating status already, this might need to be taken a look at in another PR. Might also be a chicken-and-egg problem. as we don't know that we're creating a VM until the VM exists.. but there might be a place in the code execution were we could sneak that in, I'll give it another look in a different PR

ashley-cui · 2022-07-01T20:32:54Z

Okay, socket should be correct, but I'm not sure if we should put the sock in machine info, since now we're going into machine inspect territory, by calling inspect. WDYT @baude

TomSweeneyRedHat · 2022-07-01T23:51:53Z

docs/source/markdown/podman-machine-info.1.md

+
+```
+$ podman machine info
+$ podman machine info --format json


might be nice to have a simple go template example too.

baude · 2022-07-05T13:33:16Z

i think whether the socket exists or not is outside the scope of this PR. I would recommend that we merge this PR and have @benoitf create an issue about the sockets. One thing regarding the sockets, we intentionally do not create them unless a machine is running but for machine events, it probably does make sense.

ashley-cui · 2022-07-05T14:01:07Z

Added go template example, and removed RemoteSocket field since I think we should avoid calling machine inspect in machine info.

baude · 2022-07-05T18:02:19Z

LGTM

docs/source/markdown/podman-machine-info.1.md

pkg/machine/e2e/config_info.go

mheon · 2022-07-05T18:16:04Z

Two nits otherwise LGTM

Add podman machine info command, which displays infor about the machine host as well as version info. Signed-off-by: Ashley Cui <[email protected]>

ashley-cui · 2022-07-07T14:30:50Z

Tests are green, @containers/podman-maintainers PTAL and merge

rhatdan · 2022-07-07T14:43:21Z

/lgtm

openshift-ci bot added the release-note label Jun 28, 2022

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 28, 2022

ashley-cui commented Jun 28, 2022

View reviewed changes

ashley-cui force-pushed the machinfo branch 2 times, most recently from c7cf4bc to f6ced0d Compare June 28, 2022 18:47

cdoern reviewed Jun 28, 2022

View reviewed changes

ashley-cui force-pushed the machinfo branch 2 times, most recently from 8031ea5 to 9709bc6 Compare June 29, 2022 13:21

baude reviewed Jun 29, 2022

View reviewed changes

docs/source/markdown/podman-machine-info.1.md Outdated Show resolved Hide resolved

baude reviewed Jun 29, 2022

View reviewed changes

pkg/machine/e2e/info_test.go Show resolved Hide resolved

ashley-cui force-pushed the machinfo branch from 9709bc6 to a7b756d Compare June 30, 2022 18:48

ashley-cui force-pushed the machinfo branch from a7b756d to 36f7248 Compare June 30, 2022 19:11

ashley-cui force-pushed the machinfo branch from 36f7248 to beaf239 Compare July 1, 2022 20:31

ashley-cui force-pushed the machinfo branch from beaf239 to 157431e Compare July 1, 2022 20:47

TomSweeneyRedHat reviewed Jul 1, 2022

View reviewed changes

ashley-cui force-pushed the machinfo branch from 157431e to ad9a09e Compare July 5, 2022 13:59

mheon reviewed Jul 5, 2022

View reviewed changes

docs/source/markdown/podman-machine-info.1.md Outdated Show resolved Hide resolved

mheon reviewed Jul 5, 2022

View reviewed changes

pkg/machine/e2e/config_info.go Outdated Show resolved Hide resolved

Podman machine info

9d6efb3

Add podman machine info command, which displays infor about the machine host as well as version info. Signed-off-by: Ashley Cui <[email protected]>

ashley-cui force-pushed the machinfo branch from ad9a09e to 9d6efb3 Compare July 5, 2022 19:18

openshift-ci bot assigned rhatdan Jul 7, 2022

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2022

openshift-ci bot merged commit dd0418a into containers:main Jul 7, 2022

ashley-cui mentioned this pull request Jul 7, 2022

How to grab runtime directory ? #14113

Closed

ashley-cui deleted the machinfo branch July 15, 2022 19:27

github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 21, 2023

github-actions bot locked as resolved and limited conversation to collaborators Sep 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Podman machine info #14762

Podman machine info #14762

ashley-cui commented Jun 28, 2022

openshift-ci bot commented Jun 28, 2022

ashley-cui commented Jun 28, 2022 •

edited

Loading

ashley-cui Jun 28, 2022

ashley-cui commented Jun 28, 2022

cdoern left a comment

cdoern Jun 28, 2022 •

edited

Loading

cdoern Jun 28, 2022

rhatdan Jun 28, 2022

ashley-cui Jun 28, 2022

baude Jun 29, 2022

benoitf commented Jun 29, 2022 •

edited

Loading

baude commented Jun 29, 2022

mheon commented Jun 29, 2022

benoitf commented Jun 29, 2022 •

edited

Loading

baude commented Jun 29, 2022

mheon commented Jun 29, 2022

ashley-cui commented Jun 29, 2022

benoitf commented Jun 29, 2022 •

edited

Loading

ashley-cui commented Jun 29, 2022

baude commented Jun 30, 2022

rhatdan commented Jun 30, 2022

ashley-cui commented Jun 30, 2022

rhatdan commented Jul 1, 2022

benoitf commented Jul 1, 2022 •

edited

Loading

ashley-cui commented Jul 1, 2022 •

edited

Loading

ashley-cui commented Jul 1, 2022

TomSweeneyRedHat Jul 1, 2022

baude commented Jul 5, 2022

ashley-cui commented Jul 5, 2022

baude commented Jul 5, 2022

mheon commented Jul 5, 2022

ashley-cui commented Jul 7, 2022

rhatdan commented Jul 7, 2022

Podman machine info #14762

Podman machine info #14762

Conversation

ashley-cui commented Jun 28, 2022

Does this PR introduce a user-facing change?

openshift-ci bot commented Jun 28, 2022

ashley-cui commented Jun 28, 2022 • edited Loading

ashley-cui Jun 28, 2022

Choose a reason for hiding this comment

ashley-cui commented Jun 28, 2022

cdoern left a comment

Choose a reason for hiding this comment

cdoern Jun 28, 2022 • edited Loading

Choose a reason for hiding this comment

cdoern Jun 28, 2022

Choose a reason for hiding this comment

rhatdan Jun 28, 2022

Choose a reason for hiding this comment

ashley-cui Jun 28, 2022

Choose a reason for hiding this comment

baude Jun 29, 2022

Choose a reason for hiding this comment

benoitf commented Jun 29, 2022 • edited Loading

baude commented Jun 29, 2022

mheon commented Jun 29, 2022

benoitf commented Jun 29, 2022 • edited Loading

baude commented Jun 29, 2022

mheon commented Jun 29, 2022

ashley-cui commented Jun 29, 2022

benoitf commented Jun 29, 2022 • edited Loading

ashley-cui commented Jun 29, 2022

baude commented Jun 30, 2022

rhatdan commented Jun 30, 2022

ashley-cui commented Jun 30, 2022

rhatdan commented Jul 1, 2022

benoitf commented Jul 1, 2022 • edited Loading

ashley-cui commented Jul 1, 2022 • edited Loading

ashley-cui commented Jul 1, 2022

TomSweeneyRedHat Jul 1, 2022

Choose a reason for hiding this comment

baude commented Jul 5, 2022

ashley-cui commented Jul 5, 2022

baude commented Jul 5, 2022

mheon commented Jul 5, 2022

ashley-cui commented Jul 7, 2022

rhatdan commented Jul 7, 2022

ashley-cui commented Jun 28, 2022 •

edited

Loading

cdoern Jun 28, 2022 •

edited

Loading

benoitf commented Jun 29, 2022 •

edited

Loading

benoitf commented Jun 29, 2022 •

edited

Loading

benoitf commented Jun 29, 2022 •

edited

Loading

benoitf commented Jul 1, 2022 •

edited

Loading

ashley-cui commented Jul 1, 2022 •

edited

Loading