feat: Implement livenessProbe variables and readinessProbe variables in helm chart #2906
Conversation
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
stefanandres
force-pushed
the
probe-variable
branch
4 times, most recently
from
959aa1b
to
c468b6f
Compare
stefanandres
changed the title
stefanandres
changed the title
It's sometimes needed to configure certain timeouts. This PR makes all the settings available as helm variables. Signed-off-by: Stefan Andres <[email protected]>
stefanandres
force-pushed
the
probe-variable
branch
from
c468b6f
to
01408d7
Compare
|
I'm supportive of this change, but there are a few issues that need to be resolved:
|
| {{- with .Values.api.probes.livenessProbe }} | ||
| livenessProbe: {{- toYaml . | nindent 12 }} | ||
| {{- end }} |
There was a problem hiding this comment.
The following 8 lines are also part of the probe.
| {{- with .Values.api.probes.readinessProbe }} | ||
| readinessProbe: {{- toYaml . | nindent 12 }} | ||
| {{- end }} |
There was a problem hiding this comment.
The following 8 lines are also part of the probe.
|
Thanks for the review, I'll see that I do the changes. I would have changed other deployments if they'd already used probes, but can add placeholder for them as well. |
| @@ -85,8 +85,11 @@ spec: | |||
| - name: h2c | |||
| containerPort: 8080 | |||
| protocol: TCP | |||
|
|
|||
| {{- if .Values.api.probes.enabled }} | |||
There was a problem hiding this comment.
I think with the probes fully configurable, this option becomes redundant and should be removed from the template and the values.yaml file.
It is a breaking change, but it's a low-impact breaking change:
- Exists mainly to support local development.
- Anyone who may have disabled the probes already (in non-local dev envs), if this breaking change were to catch them by surprise, they'd be gaining new probes rather than losing anything. Whatever disruption that might cause should be easily identified and corrected.
I will of course mention a change such as this prominently in the release notes.
There was a problem hiding this comment.
It occurs to me that removing this option will require some slight modifications to hack/tilt/values.dev.yaml. You'll just have to nil out the probes for a couple of components.
| @@ -74,25 +74,13 @@ spec: | |||
| resources: | |||
| {{- toYaml .Values.api.oidc.dex.resources | nindent 10 }} | |||
| {{- if .Values.api.oidc.dex.probes.enabled }} | |||
| @@ -144,6 +144,11 @@ api: | |||
| probes: | |||
| ## @param api.probes.enabled Whether liveness and readiness probes should be included in the API server deployment. It is sometimes advantageous to disable these during local development. | |||
| enabled: true | |||
| livenessProbe: | |||
| initialDelaySeconds: 10 | |||
|
|
|||
There was a problem hiding this comment.
Nit: Killing this blank line would visually make it more obvious that readinessProbe below is a component of this block.
Running |
It's sometimes needed to configure certain timeouts. This PR makes all the settings available as helm variables.