Skip to content

Add image_id to CRI ContainerStatus message #123583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
k8s-ci-robot merged 1 commit into from
Mar 4, 2024
Merged

Add image_id to CRI ContainerStatus message #123583

k8s-ci-robot merged 1 commit into from
Mar 4, 2024

Conversation

@saschagrunert
Copy link
Member

@saschagrunert saschagrunert commented Feb 29, 2024 •
edited
Loading

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

There is a conversion function ConvertPodStatusToRunningPod, which can override the Container.ImageID into a digested reference from the ContainerStatus CRI RPC, which gets mapped from the image_ref:

kubernetes/pkg/kubelet/container/helpers.go

Lines 259 to 292 in 411c29c

// ConvertPodStatusToRunningPod returns Pod given PodStatus and container runtime string.
// TODO(random-liu): Convert PodStatus to running Pod, should be deprecated soon
func ConvertPodStatusToRunningPod(runtimeName string, podStatus *PodStatus) Pod {
runningPod := Pod{
ID: podStatus.ID,
Name: podStatus.Name,
Namespace: podStatus.Namespace,
}
for _, containerStatus := range podStatus.ContainerStatuses {
if containerStatus.State != ContainerStateRunning {
continue
}
container := &Container{
ID: containerStatus.ID,
Name: containerStatus.Name,
Image: containerStatus.Image,
ImageID: containerStatus.ImageID,
ImageRuntimeHandler: containerStatus.ImageRuntimeHandler,
Hash: containerStatus.Hash,
HashWithoutResources: containerStatus.HashWithoutResources,
State: containerStatus.State,
}
runningPod.Containers = append(runningPod.Containers, container)
}
// Populate sandboxes in kubecontainer.Pod
for _, sandbox := range podStatus.SandboxStatuses {
runningPod.Sandboxes = append(runningPod.Sandboxes, &Container{
ID: ContainerID{Type: runtimeName, ID: sandbox.Id},
State: SandboxToContainerState(sandbox.State),
})
}
return runningPod
}

To avoid that failure case, we now introduce the same image_id into the container status and let runtimes separate the fields.

We also add a note that the mapping from the digested reference of the CRI to the Kubernetes Pod API ImageID field is intentional and should not change.

Which issue(s) this PR fixes:

Follow-up on: #123508

Special notes for your reviewer:

PTAL @mrunalp @haircommander @mikebrow @kubernetes/sig-node-pr-reviews

This is not a bug, it's preventing internal API misusage to create one.

Does this PR introduce a user-facing change?

None

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

None

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. sig/node Categorizes an issue or PR as relevant to SIG Node. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Feb 29, 2024
@saschagrunert saschagrunert mentioned this pull request Feb 29, 2024
Merged
@saschagrunert saschagrunert force-pushed the image-id-container-status branch from 5424142 to 19b7947 Compare February 29, 2024 10:54
@saschagrunert saschagrunert mentioned this pull request Feb 29, 2024
Closed
@saschagrunert
Add image_id to CRI ContainerStatus message
e38531e 
There is a conversion function `ConvertPodStatusToRunningPod`, which
can override the `Container.ImageID` into a digested reference from the
`ContainerStatus` CRI RPC, which gets mapped from the `image_ref`:

https://github.com/kubernetes/kubernetes/blob/411c29c39f03687a30a8667295c61590def8fc89/pkg/kubelet/container/helpers.go#L259-L292

To avoid that failure case, we now introduce the same `image_id` into
the container status and let runtimes separate the fields.

We also add a note that the mapping from the digested reference of the
CRI to the Kubernetes Pod API `ImageID` field is intentional and should
not change.

Follow-up on: kubernetes#123508

Signed-off-by: Sascha Grunert <[email protected]>
@saschagrunert saschagrunert force-pushed the image-id-container-status branch from 19b7947 to e38531e Compare February 29, 2024 11:41
@mrunalp
Copy link
Contributor

mrunalp commented Mar 1, 2024

@mikebrow @SergeyKanzhelev ptal

@haircommander
Copy link
Contributor

haircommander commented Mar 4, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 4, 2024
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Mar 4, 2024

LGTM label has been added.

DetailsGit tree hash: 23b84deeaad2ffe9918b5d701b66ca6469283d79

@bart0sh
Copy link
Contributor

bart0sh commented Mar 4, 2024

/triage accepted
/priority important-longterm

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Mar 4, 2024
@bart0sh
Copy link
Contributor

bart0sh commented Mar 4, 2024

/cc @mrunalp @SergeyKanzhelev

mikebrow
mikebrow approved these changes Mar 4, 2024
View reviewed changes
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

LGTM

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Mar 4, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikebrow, mrunalp, saschagrunert

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2024
@k8s-ci-robot k8s-ci-robot merged commit 4ed7f6b into kubernetes:master Mar 4, 2024
@k8s-ci-robot k8s-ci-robot added this to the v1.30 milestone Mar 4, 2024
@saschagrunert saschagrunert deleted the image-id-container-status branch March 5, 2024 07:59
@haircommander haircommander mentioned this pull request May 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@endocrimes endocrimes Awaiting requested review from endocrimes

@kannon92 kannon92 Awaiting requested review from kannon92

@SergeyKanzhelev SergeyKanzhelev Awaiting requested review from SergeyKanzhelev

2 more reviewers

@mrunalp mrunalp mrunalp approved these changes

@mikebrow mikebrow mikebrow approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@haircommander haircommander

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubelet cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. release-note-none Denotes a PR that doesn't merit a release note. sig/node Categorizes an issue or PR as relevant to SIG Node. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Projects

SIG Node: code and documentation PRs
Archived in project

Milestone

v1.30

Development

Successfully merging this pull request may close these issues.

6 participants

@saschagrunert @mrunalp @haircommander @k8s-ci-robot @bart0sh @mikebrow