Skip to content
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

Disambiguate Pod Phase from kubectl status... #46299

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Disambiguate Pod Phase from kubectl status... #46299

wants to merge 4 commits into from

Conversation

jayunit100
Copy link
Member

This PR disambiguates CrashLoopBackoff "Status" from the formal concept of the "Phase"...

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 10, 2024
@k8s-ci-robot k8s-ci-robot requested a review from sftim May 10, 2024 00:20
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign dipesh-rawat for approval. For more information see the Kubernetes Code Review Process.

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

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 language/en Issues or PRs related to English language label May 10, 2024
@k8s-ci-robot k8s-ci-robot requested a review from tengqm May 10, 2024 00:20
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label May 10, 2024
@netlify Netlify
Copy link

netlify bot commented May 10, 2024 •
edited

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit cad29f1
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/663d85fa373b7300082a0d7c
😎 Deploy Preview https://deploy-preview-46299--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sftim
sftim reviewed May 10, 2024
View reviewed changes
content/en/docs/concepts/workloads/pods/pod-lifecycle.md
Comment on lines +91 to +92
NAMESPACE NAME READY STATUS RESTARTS AGE
alessandras-namespace alessandras-pod 0/1 CrashLoopBackOff 200 2d9h
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this indentation right?

content/en/docs/concepts/workloads/pods/pod-lifecycle.md
Comment on lines +95 to +98
{{< /note >}}


{{< note >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{{< /note >}}
{{< note >}}
---

Copy link
Contributor

Choose a reason for hiding this comment

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

(this separator renders in the right color for a note callout, making it more obvious that a new callout is starting)

content/en/docs/concepts/workloads/pods/pod-lifecycle.md
When a Pod is being deleted, it is shown as `Terminating` by some kubectl commands.
This `Terminating` status is not one of the Pod phases.
When a pod is not able to stay running, it may be shown as `CrashLoopBackoff` by some kubectl commands in its `Status`.
Make sure not to confuse "Status", a display field for user intuition, with the pod "Phase", which is an explicit part of the Kubernetes data model.
Copy link
Contributor

@sftim sftim May 10, 2024 •
edited

Choose a reason for hiding this comment

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

I might write:

Suggested change
Make sure not to confuse "Status", a display field for user intuition, with the pod "Phase", which is an explicit part of the Kubernetes data model.
Make sure not to confuse _Status_, a kubectl display field for user intuition, with the pod phase.
Pod phase is an explicit part of the Kubernetes data model and of the
[Pod API](/docs/reference/kubernetes-api/workload-resources/pod-v1/).

@sftim
Copy link
Contributor

sftim commented May 10, 2024

@kubernetes/sig-node-pr-reviews how does this look?

@k8s-ci-robot k8s-ci-robot added the sig/node Categorizes an issue or PR as relevant to SIG Node. label May 10, 2024
@matthyx
Copy link
Contributor

matthyx commented May 11, 2024

I don't understand why we have lost Terminating?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@tengqm tengqm Awaiting requested review from tengqm

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/node Categorizes an issue or PR as relevant to SIG Node. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jayunit100 @k8s-ci-robot @sftim @matthyx