Skip to content

Commit

Permalink
feat: make injector livenessProbe and readinessProbe configurable and…
Browse files Browse the repository at this point in the history 
… add configurable startupProbe (#852)
  • Loading branch information
@thyton
thyton authored Mar 16, 2023
1 parent f4f05aa commit 9328917
Show file tree
Hide file tree
Showing 4 changed files with 187 additions and 10 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Changes:

Features:
* server: New `extraPorts` option for adding ports to the Vault server statefulset [GH-841](https://github.com/hashicorp/vault-helm/pull/841)
* injector: Make livenessProbe and readinessProbe configurable and add configurable startupProbe [GH-852](https://github.com/hashicorp/vault-helm/pull/852)

## 0.23.0 (November 28th, 2022)

Expand Down
30 changes: 20 additions & 10 deletions templates/injector-deployment.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,21 +130,31 @@ spec:
path: /health/ready
port: {{ .Values.injector.port }}
scheme: HTTPS
failureThreshold: 2
initialDelaySeconds: 5
periodSeconds: 2
successThreshold: 1
timeoutSeconds: 5
failureThreshold: {{ .Values.injector.livenessProbe.failureThreshold }}
initialDelaySeconds: {{ .Values.injector.livenessProbe.initialDelaySeconds }}
periodSeconds: {{ .Values.injector.livenessProbe.periodSeconds }}
successThreshold: {{ .Values.injector.livenessProbe.successThreshold }}
timeoutSeconds: {{ .Values.injector.livenessProbe.timeoutSeconds }}
readinessProbe:
httpGet:
path: /health/ready
port: {{ .Values.injector.port }}
scheme: HTTPS
failureThreshold: 2
initialDelaySeconds: 5
periodSeconds: 2
successThreshold: 1
timeoutSeconds: 5
failureThreshold: {{ .Values.injector.readinessProbe.failureThreshold }}
initialDelaySeconds: {{ .Values.injector.readinessProbe.initialDelaySeconds }}
periodSeconds: {{ .Values.injector.readinessProbe.periodSeconds }}
successThreshold: {{ .Values.injector.readinessProbe.successThreshold }}
timeoutSeconds: {{ .Values.injector.readinessProbe.timeoutSeconds }}
startupProbe:
httpGet:
path: /health/ready
port: {{ .Values.injector.port }}
scheme: HTTPS
failureThreshold: {{ .Values.injector.startupProbe.failureThreshold }}
initialDelaySeconds: {{ .Values.injector.startupProbe.initialDelaySeconds }}
periodSeconds: {{ .Values.injector.startupProbe.periodSeconds }}
successThreshold: {{ .Values.injector.startupProbe.successThreshold }}
timeoutSeconds: {{ .Values.injector.startupProbe.timeoutSeconds }}
{{- if .Values.injector.certs.secretName }}
volumeMounts:
- name: webhook-certs
Expand Down
129 changes: 129 additions & 0 deletions test/unit/injector-deployment.bats
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,135 @@ load _helpers
[ "${value}" = "auth/k8s" ]
}

@test "injector/deployment: default livenessProbe settings" {
cd `chart_dir`
local object=$(helm template \
--show-only templates/injector-deployment.yaml \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].livenessProbe' | tee /dev/stderr)

local actual=$(echo "$object" | yq '.failureThreshold' | tee /dev/stderr)
[ "${actual}" = "2" ]
local actual=$(echo "$object" | yq '.initialDelaySeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
local actual=$(echo "$object" | yq '.periodSeconds' | tee /dev/stderr)
[ "${actual}" = "2" ]
local actual=$(echo "$object" | yq '.successThreshold' | tee /dev/stderr)
[ "${actual}" = "1" ]
local actual=$(echo "$object" | yq '.timeoutSeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
}

@test "injector/deployment: can set livenessProbe settings" {
cd `chart_dir`
local object=$(helm template \
--show-only templates/injector-deployment.yaml \
--set 'injector.livenessProbe.failureThreshold=100' \
--set 'injector.livenessProbe.initialDelaySeconds=100' \
--set 'injector.livenessProbe.periodSeconds=100' \
--set 'injector.livenessProbe.successThreshold=100' \
--set 'injector.livenessProbe.timeoutSeconds=100' \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].livenessProbe' | tee /dev/stderr)

local actual=$(echo "$object" | yq '.failureThreshold' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.initialDelaySeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.periodSeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.successThreshold' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.timeoutSeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
}

@test "injector/deployment: default readinessProbe settings" {
cd `chart_dir`
local object=$(helm template \
--show-only templates/injector-deployment.yaml \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].readinessProbe' | tee /dev/stderr)

local actual=$(echo "$object" | yq '.failureThreshold' | tee /dev/stderr)
[ "${actual}" = "2" ]
local actual=$(echo "$object" | yq '.initialDelaySeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
local actual=$(echo "$object" | yq '.periodSeconds' | tee /dev/stderr)
[ "${actual}" = "2" ]
local actual=$(echo "$object" | yq '.successThreshold' | tee /dev/stderr)
[ "${actual}" = "1" ]
local actual=$(echo "$object" | yq '.timeoutSeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
}

@test "injector/deployment: can set readinessProbe settings" {
cd `chart_dir`
local object=$(helm template \
--show-only templates/injector-deployment.yaml \
--set 'injector.readinessProbe.failureThreshold=100' \
--set 'injector.readinessProbe.initialDelaySeconds=100' \
--set 'injector.readinessProbe.periodSeconds=100' \
--set 'injector.readinessProbe.successThreshold=100' \
--set 'injector.readinessProbe.timeoutSeconds=100' \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].readinessProbe' | tee /dev/stderr)

local actual=$(echo "$object" | yq '.failureThreshold' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.initialDelaySeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.periodSeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.successThreshold' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.timeoutSeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
}

@test "injector/deployment: default startupProbe settings" {
cd `chart_dir`
local object=$(helm template \
--show-only templates/injector-deployment.yaml \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].startupProbe' | tee /dev/stderr)

local actual=$(echo "$object" | yq '.failureThreshold' | tee /dev/stderr)
[ "${actual}" = "12" ]
local actual=$(echo "$object" | yq '.initialDelaySeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
local actual=$(echo "$object" | yq '.periodSeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
local actual=$(echo "$object" | yq '.successThreshold' | tee /dev/stderr)
[ "${actual}" = "1" ]
local actual=$(echo "$object" | yq '.timeoutSeconds' | tee /dev/stderr)
[ "${actual}" = "5" ]
}

@test "injector/deployment: can set startupProbe settings" {
cd `chart_dir`
local object=$(helm template \
--show-only templates/injector-deployment.yaml \
--set 'injector.startupProbe.failureThreshold=100' \
--set 'injector.startupProbe.initialDelaySeconds=100' \
--set 'injector.startupProbe.periodSeconds=100' \
--set 'injector.startupProbe.successThreshold=100' \
--set 'injector.startupProbe.timeoutSeconds=100' \
. | tee /dev/stderr |
yq -r '.spec.template.spec.containers[0].startupProbe' | tee /dev/stderr)

local actual=$(echo "$object" | yq '.failureThreshold' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.initialDelaySeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.periodSeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.successThreshold' | tee /dev/stderr)
[ "${actual}" = "100" ]
local actual=$(echo "$object" | yq '.timeoutSeconds' | tee /dev/stderr)
[ "${actual}" = "100" ]
}

@test "injector/deployment: default logLevel" {
cd `chart_dir`
local object=$(helm template \
Expand Down
37 changes: 37 additions & 0 deletions values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,43 @@ injector:
exitOnRetryFailure: true
staticSecretRenderInterval: ""

# Used to define custom livenessProbe settings
livenessProbe:
# When a probe fails, Kubernetes will try failureThreshold times before giving up
failureThreshold: 2
# Number of seconds after the container has started before probe initiates
initialDelaySeconds: 5
# How often (in seconds) to perform the probe
periodSeconds: 2
# Minimum consecutive successes for the probe to be considered successful after having failed
successThreshold: 1
# Number of seconds after which the probe times out.
timeoutSeconds: 5
# Used to define custom readinessProbe settings
readinessProbe:
# When a probe fails, Kubernetes will try failureThreshold times before giving up
failureThreshold: 2
# Number of seconds after the container has started before probe initiates
initialDelaySeconds: 5
# How often (in seconds) to perform the probe
periodSeconds: 2
# Minimum consecutive successes for the probe to be considered successful after having failed
successThreshold: 1
# Number of seconds after which the probe times out.
timeoutSeconds: 5
# Used to define custom startupProbe settings
startupProbe:
# When a probe fails, Kubernetes will try failureThreshold times before giving up
failureThreshold: 12
# Number of seconds after the container has started before probe initiates
initialDelaySeconds: 5
# How often (in seconds) to perform the probe
periodSeconds: 5
# Minimum consecutive successes for the probe to be considered successful after having failed
successThreshold: 1
# Number of seconds after which the probe times out.
timeoutSeconds: 5

# Mount Path of the Vault Kubernetes Auth Method.
authPath: "auth/kubernetes"

Expand Down

0 comments on commit 9328917

Please sign in to comment.