mirror of
https://github.com/kyverno/kyverno.git
synced 2025-03-31 03:45:17 +00:00
c52f07b615
* new samples; updates * typos * add policy to restrict LoadBalancer * correct sample numbering * fix typos
42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
# Require `livenessProbe` and `readinessProbe`
|
|
|
|
Liveness and readiness probes need to be configured to correctly manage a pod's lifecycle during deployments, restarts, and upgrades.
|
|
|
|
For each pod, a periodic `livenessProbe` is performed by the kubelet to determine if the pod's containers are running or need to be restarted. A `readinessProbe` is used by services and deployments to determine if the pod is ready to receive network traffic.
|
|
|
|
In this sample policy, a validation rule checks to ensure that all Pods have both a liveness and a readiness probe defined by looking at the `periodSeconds` field. By using the annotation `pod-policies.kyverno.io/autogen-controllers`, it modifies the default behavior and ensures that only Pods originating from DaemonSet, Deployment, and StatefulSet objects are validated.
|
|
|
|
## More Information
|
|
|
|
* [Kyverno Auto-Gen Rules for Pod Controllers](https://kyverno.io/docs/writing-policies/autogen/)
|
|
* [Configure Liveness, Readiness and Startup Probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
|
|
|
|
## Policy YAML
|
|
|
|
[require_probes.yaml](best_practices/require_probes.yaml)
|
|
|
|
```yaml
|
|
apiVersion: kyverno.io/v1
|
|
kind: ClusterPolicy
|
|
metadata:
|
|
name: require-pod-probes
|
|
annotations:
|
|
pod-policies.kyverno.io/autogen-controllers: DaemonSet,Deployment,StatefulSet
|
|
spec:
|
|
validationFailureAction: audit
|
|
rules:
|
|
- name: validate-livenessProbe-readinessProbe
|
|
match:
|
|
resources:
|
|
kinds:
|
|
- Pod
|
|
validate:
|
|
message: "Liveness and readiness probes are required"
|
|
pattern:
|
|
spec:
|
|
containers:
|
|
- livenessProbe:
|
|
periodSeconds: ">0"
|
|
readinessProbe:
|
|
periodSeconds: ">0"
|
|
```
|