[1.18] update sidecar & control plane probe defaults#5144
Open
JoshVanL wants to merge 2 commits intodapr:v1.18from
Open
[1.18] update sidecar & control plane probe defaults#5144JoshVanL wants to merge 2 commits intodapr:v1.18from
JoshVanL wants to merge 2 commits intodapr:v1.18from
Conversation
See dapr/dapr#9818 Signed-off-by: joshvanl <me@joshvanl.dev>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Dapr 1.18 documentation to reflect new default Kubernetes probe settings for the sidecar and control plane (per dapr/dapr#9818), keeping annotations/arguments and health-check guidance consistent.
Changes:
- Update default values for sidecar liveness/readiness probe annotations in the arguments/annotations reference table.
- Update Kubernetes probe examples and explanatory text in the sidecar health checks documentation to match the new defaults.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| daprdocs/content/en/reference/arguments-annotations-overview.md | Adjusts documented default values for sidecar liveness/readiness probe-related annotations. |
| daprdocs/content/en/operations/resiliency/health-checks/sidecar-health.md | Updates probe YAML examples and narrative to match new default liveness/readiness timing parameters. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+66
to
+70
| | not supported | not supported | | `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `5`| | ||
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | ||
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | ||
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | ||
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `5`| |
There was a problem hiding this comment.
The description contains a double space in “In this case”, which reads like a typo in the rendered docs. Please change it to a single space (“In this case”).
Suggested change
| | not supported | not supported | | `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `5`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `5`| | |
| | not supported | not supported | | `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `5`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `1`| | |
| | not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `5`| |
Comment on lines
115
to
+118
| httpGet: | ||
| path: v1.0/healthz | ||
| port: 3500 | ||
| initialDelaySeconds: 5 | ||
| initialDelaySeconds: 180 |
There was a problem hiding this comment.
In this Kubernetes probe example, the httpGet.path value is missing the leading / (it shows v1.0/healthz), which doesn’t match the text above (/v1.0/healthz) and is not a valid HTTP origin-form path. Update the example to use /v1.0/healthz.
Comment on lines
123
to
+126
| httpGet: | ||
| path: v1.0/healthz | ||
| port: 3500 | ||
| initialDelaySeconds: 5 | ||
| periodSeconds: 10 | ||
| timeoutSeconds : 5 | ||
| failureThreshold: 3 | ||
| initialDelaySeconds: 1 |
There was a problem hiding this comment.
In this Kubernetes probe example, the httpGet.path value is missing the leading / (it shows v1.0/healthz), which doesn’t match the text above (/v1.0/healthz) and is not a valid HTTP origin-form path. Update the example to use /v1.0/healthz.
Comment on lines
+120
to
+121
| timeoutSeconds : 3 | ||
| failureThreshold : 5 |
There was a problem hiding this comment.
The YAML snippet uses timeoutSeconds : / failureThreshold : with a space before the colon. This is non-idiomatic and can trip up copy/paste validation; align it with standard Kubernetes YAML (timeoutSeconds: / failureThreshold:).
| failureThreshold: 3 | ||
| initialDelaySeconds: 1 | ||
| periodSeconds: 1 | ||
| timeoutSeconds : 1 |
There was a problem hiding this comment.
The YAML snippet uses timeoutSeconds : with a space before the colon. Align it with standard Kubernetes YAML (timeoutSeconds:) to avoid copy/paste issues.
Signed-off-by: joshvanl <me@joshvanl.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See dapr/dapr#9818