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.

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

Document known Conditions (especially ResourcesHealthy) and how to consume them #104

Open
idoru opened this issue Jul 10, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@idoru
Copy link
Contributor

idoru commented Jul 10, 2022

Docs for Deliverable and Workload (e.g. https://cartographer.sh/docs/v0.4.0/reference/workload/) show that they have a Status containing Conditions. Similarly so for their Resources.Conditions.

The values of Conditions that may appear in this list (condition types, possible condition statuses and reasons) are not documented anywhere.

Whilst Condition itself a generic, core k8s concept, intrinsic cartographer behavior for conditions like Ready, or cartographer feature-specific behavior for conditions like Healthy are not, and we should enumerate the condition types that cartographer knowingly populates. This became painfully obvious when trying to understand how to meaningfully consume the outcome of a Template's healthRules.

In doing so, to allow them to be easily consumed, we should:

  • offer clear explanation for the condition's meaning
  • enumerate possible condition Status values, and what they mean in the context of this condition
  • enumerate possible condition Reason values, and what they mean in the context of this condition, and where the next place to look

This may have some overlap with this existing doc: https://cartographer.sh/docs/v0.4.0/troubleshooting/

@idoru idoru added the documentation Improvements or additions to documentation label Jul 10, 2022
@idoru idoru moved this to Pre-IPM in Cartographer OSS Jul 10, 2022
@squeedee
Copy link
Member

Use generative docs to ensure all are captured in the crd ref.

@karayim karayim moved this from Pre-IPM to Todo in Cartographer OSS Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

3 participants
@squeedee @idoru and others