Skip to content

Commit dcee115

Browse files
mattfarinamattfarina
authored
Merge pull request #374 from AustinAbro321/wait-with-kstatus
H4HIP: Wait with kstatus
2 parents ad985a0 + a9a5d17 commit dcee115

File tree

1 file changed

+115
-0
lines changed

1 file changed

+115
-0
lines changed

‎hips/hip-0999.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
hip: 9999
3+
title: "Wait With kstatus"
4+
authors: [ "@austinabro321" ]
5+
created: "2024-12-06"
6+
type: "feature"
7+
status: "draft"
8+
---
9+
10+
## Abstract
11+
12+
Currently the `--wait` flag on `helm install` and `helm upgrade` does not wait for all resources to be fully reconciled, and does not wait for custom resources (CRs) at all. By replacing the wait logic with [kstatus](https://github.com/kubernetes-sigs/cli-utils/blob/master/pkg/kstatus/README.md), Helm will achieve more intuitive waits, while simplifying its code and documentation.
13+
14+
## Motivation
15+
16+
By introducing kstatus we will lower user friction with the `--wait` flag.
17+
18+
Certain workflows require custom resources to be ready. There is no way to tell Helm to wait for custom resources to be ready, so anyone with this requirement must write their own logic to wait for their custom resources. Kstatus solves this by waiting for custom resources to have [the ready condition](https://github.com/kubernetes-sigs/cli-utils/blob/master/pkg/kstatus/README.md#the-ready-condition) set to true.
19+
20+
Certain workflows requires resources to be fully reconciled, which does happen in the current `--wait` logic. For example, Helm waits for all new pods in an upgraded deployment to be ready. However, Helm does not wait for the previous pods in that deployment to be removed. Therefore, Helm will finish waiting even while old pods are still active. Since kstatus instead waits for all resources to be reconciled, the wait will not finish for a deployment until all of its new pods are ready and all of its old pods have been deleted.
21+
22+
## Rationale
23+
24+
Leveraging a existing status management library maintained by the Kubernetes team will simplify the code and documentation that Helm needs to maintain and improve the functionality of `--wait`.
25+
26+
## Specification
27+
28+
The Helm CLI will continue to use the existing `--wait` flag. The wait flag will be extended to accept `true|false|none|watcher|legacy`. When using `--wait` as flag with no argument, `--wait=true`, or `--wait=watcher` Helm will use the kstatus watcher described in this document. When using `--wait=legacy` Helm will use the current Helm 3 waiter. When using `--wait=false` or not using the `--wait` flag Helm not wait after deployments.
29+
30+
Kstatus can be used with either a poller or a watcher. The poller runs on a specified interval and only requires "list" RBAC permissions for polled resources. The watcher reacts to [watch events](https://github.com/kubernetes/kubernetes/blob/90a45563ae1bab5868ee888432fec9aac2f7f8b1/staging/src/k8s.io/apimachinery/pkg/watch/watch.go#L55-L61) and requires "list" and "watch" RBAC permissions. This proposal uses the watcher as it responds slightly faster when all resources are ready, and it is very likely that users applying or deleting resources will have "watch" permissions on their resources.
31+
32+
Any functions involving waits will be separated from the `kube.Interface` interface into the `kube.Waiter` interface. `kube.Waiter` will be embedded into `kube.Interface`. The client struct will embed the `Waiter` interface to allow calls to look like `client.Wait()` instead of `client.Waiter.Wait()`. `kube.New()` will accept a wait strategy to decide the wait implementation. There will be two implementation in the repo, `HelmWaiter` and `statusWaiter`. `HelmWaiter` is the legacy implementation. The `statusWaiter` will not be public so that if kstatus is ever deprecated or replaced a new implementation can be used without changing the public SDK.
33+
34+
The new client will look like:
35+
```go
36+
type Client struct {
37+
Factory Factory
38+
Log func(string, ...interface{})
39+
Namespace string
40+
kubeClient *kubernetes.Clientset
41+
Waiter
42+
}
43+
type WaitStrategy int
44+
const (
45+
StatusWaiter WaitStrategy = iota
46+
LegacyWaiter
47+
)
48+
func New(getter genericclioptions.RESTClientGetter, ws WaitStrategy) (*Client, error)
49+
```
50+
51+
The waiter interface will look like:
52+
```go
53+
type Waiter interface {
54+
Wait(resources ResourceList, timeout time.Duration) error
55+
WaitWithJobs(resources ResourceList, timeout time.Duration) error
56+
WaitForDelete(resources ResourceList, timeout time.Duration) error
57+
WatchUntilReady(resources ResourceList, timeout time.Duration) error
58+
}
59+
```
60+
61+
`Wait` will wait for all resources to be ready. This will include jobs, but this function not wait for jobs to be complete.
62+
63+
`WaitWithJobs` will wait for all resources to be ready and all jobs to be complete.
64+
65+
`WatchUntilReady` only waits for Pods and Jobs to complete. It is used for Helm hooks. This logic will stay the same.
66+
67+
Calls to `Wait` and `WaitWithJobs` will not wait for paused deployments. This is consistent with the current logic. This is done because otherwise `helm upgrade --wait` on a paused deployment will never be ready, see [#5789](https://github.com/helm/helm/pull/5789).
68+
69+
Kstatus does not natively output any logs. After each event, Helm will output a log message of one resources that's not ready. Only one resource is logged at a time so Helm doesn't overwhelm users with output. Note that the logs are only sent when called as a library, the CLI uses a noop logger for Kube operations.
70+
71+
## Backwards compatibility
72+
73+
Waiting for custom resources and other previously not waited for resources could lead to charts timing out when using the new logic.
74+
75+
The kstatus status watcher requires the "list" and "watch" RBAC permissions to watch a resource. The current Helm implementation only require "list" permissions for the resources they're watching. Kstatus and Helm require "list" permissions for some child resources. For instance, checking if a deployment is ready requires "list" permissions for the replicaset. There may be cases where the RBAC requirements for child resources differ between Kstatus and Helm, as an evaluation has not been conducted.
76+
77+
Kstatus also watches more resources than Helm does. A user will need "list" and "watch" permissions to every resource that they are deploying. Currently, Helm only checks readiness of certain resources. See the [IsReady function](https://github.com/helm/helm/blob/0d66425d9a745d8a289b1a5ebb6ccc744436da95/pkg/kube/ready.go#L92) for details
78+
79+
Below is the minimal set needed to watch a deployment with the status watcher. This can be verified by following instructions in this repo: https://github.com/AustinAbro321/kstatus-rbac-test.
80+
```yaml
81+
rules:
82+
- apiGroups: ["apps"]
83+
resources: ["deployments"]
84+
verbs: ["list", "watch"]
85+
- apiGroups: ["apps"]
86+
resources: ["replicasets"]
87+
verbs: ["list"]
88+
```
89+
90+
91+
## Security implications
92+
93+
Users will now need "watch" permissions on resources in their chart if the `--wait` flag is used. They will also need "list" and "watch" permissions for all resources they are deploying rather than just the resources that Helm currently waits for.
94+
95+
## How to teach this
96+
97+
Replace the [existing wait documentation](https://helm.sh/docs/intro/using_helm/) by explaining that we use kstatus and pointing to the [kstatus documentation](https://github.com/kubernetes-sigs/cli-utils/blob/master/pkg/kstatus/README.md). This comes with the added benefit of not needing to maintain Helm specific wait documentation.
98+
99+
## Reference implementation
100+
101+
seen here - https://github.com/helm/helm/pull/13604
102+
103+
## Rejected ideas
104+
105+
TBD
106+
107+
## Open issues
108+
109+
[8661](https://github.com/helm/helm/issues/8661)
110+
111+
## References
112+
113+
existing wait documentation - https://helm.sh/docs/intro/using_helm/
114+
kstatus documentation - https://github.com/kubernetes-sigs/cli-utils/blob/master/pkg/kstatus/README.md
115+
Zarf kstatus implementation - https://github.com/zarf-dev/zarf/blob/main/src/internal/healthchecks/healthchecks.go

0 commit comments

Comments
 (0)