kubernetes-sigs / kubernetes-sigs/cli-utils
Feature Request: kstatus: "readiness" CEL annotation (or similar)
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 178
- Forks
- 85
- PR merge metrics
- No merged PRs in 30d
Description
It looks like multiple popular ecosystems are defining their own contracts for allowing cluster operators to define the "ready" state of a resource.
Prior Art:
- Flux: https://github.com/fluxcd/flux2/tree/main/rfcs/0009-custom-health-checks
- ArgoCD: https://github.com/argoproj/argo-cd/blob/master/docs/operator-manual/health.md
- Helm: https://github.com/helm/community/pull/373 (specifically
helm.sh/readiness-successpart)
It would be beneficial if there was a standardized annotation, perhaps supporting CEL, which cluster operators/administrators and kstatus could use to define "ready" per their individual needs.
References:
- https://github.com/kubernetes-sigs/cli-utils/issues/591
- https://github.com/fluxcd/flux2/tree/main/rfcs/0009-custom-health-checks
- https://fluxcd.io/flux/components/kustomize/kustomizations/
- https://github.com/fluxcd/flux2/discussions/119
- https://github.com/helm/community/pull/373
- https://github.com/helm/helm/pull/32314
- https://argo-cd.readthedocs.io/en/stable/operator-manual/health/
- https://github.com/argoproj/argo-rollouts/issues/4672
- https://github.com/argoproj/argo-cd/issues/5722
- https://github.com/argoproj/gitops-engine/issues/48
- https://github.com/argoproj/argo-cd/issues/911
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the kstatus behavior and cli-utils issue #591, then compare the Flux, Argo CD, and Helm references listed here. Done requires an agreed readiness annotation and CEL contract, plus a clearly defined path for kstatus to use it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- backend-api-design, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100