podman inspect add State.Health field for docker compat

[Luap99]

podman inspect shows the healthcheck status in .State.Healthcheck,
docker uses .State.Health. To make sure docker scripts work we
should add the Health key. Because we do not want to display both keys
by default we only use the new Health key. This is a breaking change
for podman users but matches what docker does. To provide some form of
compatibility users can still use --format {{.State.Healthcheck}}. It
is just not shown by default.

Fixes #11645

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Luap99

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 [Luap99]

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

[rhatdan]

LGTM

[mheon]

I'm a little iffy about this. HCs are potentially a lot of output, printing them twice seems excessive.

[Luap99]

I'm a little iffy about this. HCs are potentially a lot of output, printing them twice seems excessive.

What do you suggest instead, renaming the field to match docker will break existing podman users.

[mheon]

APIv2 should already be working, because it directly used the Docker structs, so we don't need to worry about that side of things.

Just spitballing here, but we could detect if we have a terminal attached (and thus have a user looking at the output), and not add the Docker-compat field? Any use of podman inspect that requires exact Docker compat is likely either going through the API or being scripted.

Alternatively, we could make this a breaking change for 4.0.

[jwhonce]

@mheon the compatible handler does have code to resolve the naming and type differences. See

podman/pkg/api/handlers/compat/containers.go

Line 411 in cc6a85b

if l.HasHealthCheck() && state.Status != "created" {

[TomSweeneyRedHat]

I'd vote breaking change for v4.0

[TomSweeneyRedHat]

and a few red tests

[Luap99]

I went with a different approach, I really do not want to break podman users.
I added the Health key as method, this will make --format {{.State.Health}} work correctly otherwise this field will not be included.

[rhatdan]

LGTM

[rhatdan]

Since this is Podman 4.0, why not reverse this selection, so HealthCheck will still work with Format, but our output matches Docker.

[abitrolly]

It would be better if the output matches Docker.

[umohnani8]

LGTM
@mheon PTAL for final review

[mheon]

LGTM on my end

[Luap99]

I swapped the fields as @rhatdan suggested. We now match docker by default but users can still use --format {{.State.Healthcheck}}.
This is a breaking change, therefore this commit should not be backported.

[jwhonce]

/lgtm