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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb2b07c
Disambiguate Pod Phase from kubectl status...
jayunit100 May 10, 2024
a164ac2
Update content/en/docs/concepts/workloads/pods/pod-lifecycle.md
jayunit100 May 10, 2024
2040966
Update content/en/docs/concepts/workloads/pods/pod-lifecycle.md
jayunit100 May 10, 2024
cad29f1
Update content/en/docs/concepts/workloads/pods/pod-lifecycle.md
jayunit100 May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 13 additions & 3 deletions content/en/docs/concepts/workloads/pods/pod-lifecycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,18 @@ Value | Description
`Unknown` | For some reason the state of the Pod could not be obtained. This phase typically occurs due to an error in communicating with the node where the Pod should be running.

{{< note >}}
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/).

```
NAMESPACE NAME READY STATUS RESTARTS AGE
alessandras-namespace alessandras-pod 0/1 CrashLoopBackOff 200 2d9h
Comment on lines +91 to +92
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?

```

{{< /note >}}


{{< note >}}
Comment on lines +95 to +98
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)

Similar to the above example with `CrashLoopBackoff`, this `Terminating` status also not one of the Pod phases.
A Pod is granted a term to terminate gracefully, which defaults to 30 seconds.
You can use the flag `--force` to [terminate a Pod by force](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination-forced).
{{< /note >}}
Expand Down Expand Up @@ -672,4 +682,4 @@ for more details.

* For detailed information about Pod and container status in the API, see
the API reference documentation covering
[`status`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodStatus) for Pod.
[`status`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodStatus) for Pod.