Document conditions as a Kubernetes concept

[sftim]

This is a Feature Request

What would you like to be added

• Add a page, or section of an existing page, about conditions in Kubernetes
  • Ideally, also mention reasons.
• Add a glossary entry that references that section

Extra credit: revise existing mentions such as https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-conditions to use a glossary tooltip for the new entry.

Why is this needed
People might want to know what conditions are.
Docs authors might want to use a glossary tooltip for condition rather than explain each time.

Comments
Not sure what conditions are? Please read - but don't plagiarize - https://maelvls.dev/kubernetes-conditions/

/language en
/priority backlog
/lifecycle frozen
/sig architecture

[sftim]

/triage accepted
/help

[k8s-ci-robot]

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/triage accepted
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[sftim]

https://github.com/kubernetes/community/blob/4c9ef2d/contributors/devel/sig-architecture/api-conventions.md has some good details on conditions, too.

[reetasingh]

/assign

[sftim]

Hi @reetasingh

Would you like any help or advice to work on this issue?

[reetasingh]

Hi @reetasingh

Would you like any help or advice to work on this issue?

Hi @sftim
Yes I do have some questions.

1. If we want to add a section to existing page, which page would be appropriate for this?
2. Are we supposed to cover conditions in generic way? or should it be specific to a resource eg: Pod

[sftim]

If we want to add a section to existing page, which page would be appropriate for this?

I'd make a new page, with the URI:
https://kubernetes.io/docs/concepts/overview/working-with-objects/conditions/

If we add this page, consider also editing https://kubernetes.io/docs/concepts/overview/working-with-objects/#object-spec-and-status to link to it.

Are we supposed to cover conditions in generic way? or should it be specific to a resource eg: Pod

Generically

[a-hilaly]

Could be wroth it to take a look at kubernetes/enhancements#2537 and kubernetes/enhancements#2527

[sftim]

@a-hilaly I don't understand for whom you're saying it might be worth a look. Can you clarify?

[vaibhav2107]

@reetasingh Are you still working on this issue ?

[sftim]

If anyone would like to open a pull request to help with this, that would be helpful.

[120EE0980]

@sftim I would like to work on this issue,will open pull request soon.