Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding podDistruptionBudget to consul helm chart #1316

Merged
merged 4 commits into from
Jul 8, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions charts/consul/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,20 @@ Add a special case for replicas=1, where it should default to 0 as well.
{{- end -}}
{{- end -}}

{{- define "consul.pdb.connectInject.maxUnavailable" -}}
{{- if eq (int .Values.connectInject.replicas) 1 -}}
{{ 0 }}
{{- else if .Values.connectInject.disruptionBudget.maxUnavailable -}}
{{ .Values.server.disruptionBudget.maxUnavailable -}}
{{- else -}}
{{- if eq (int .Values.connectInject.replicas) 3 -}}
{{- 1 -}}
{{- else -}}
{{- sub (div (int .Values.connectInject.replicas) 2) 1 -}}
{{- end -}}
{{- end -}}
{{- end -}}

{{/*
Inject extra environment vars in the format key:value, if populated
*/}}
Expand Down
26 changes: 26 additions & 0 deletions charts/consul/templates/connect-injector-disruptionbudget.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{{- if (and .Values.connectInject.disruptionBudget.enabled (or (and (ne (.Values.connectInject.enabled | toString) "-") .Values.connectInject.enabled) (and (eq (.Values.connectInject.enabled | toString) "-") .Values.global.enabled))) }}
# PodDisruptionBudget to prevent degrading the connectInject cluster through
# voluntary cluster changes.
{{- if .Capabilities.APIVersions.Has "policy/v1/PodDisruptionBudget" }}
apiVersion: policy/v1
{{- else }}
apiVersion: policy/v1beta1
{{- end }}
kind: PodDisruptionBudget
metadata:
name: {{ template "consul.fullname" . }}-connect-inject
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: {{ template "consul.fullname" . }}-connect-inject
name: {{ template "consul.fullname" . }}-connect-injector

namespace: {{ .Release.Namespace }}
labels:
app: {{ template "consul.name" . }}
chart: {{ template "consul.chart" . }}
heritage: {{ .Release.Service }}
release: {{ .Release.Name }}
component: connect-injector
spec:
maxUnavailable: {{ template "consul.pdb.connectInject.maxUnavailable" . }}
selector:
matchLabels:
app: {{ template "consul.name" . }}
release: "{{ .Release.Name }}"
component: connect-injector
{{- end }}
161 changes: 161 additions & 0 deletions charts/consul/test/unit/connect-injector-disruptionbudget.bats
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
#!/usr/bin/env bats

load _helpers

@test "connect-injector/DisruptionBudget: disabled by default" {
cd `chart_dir`
assert_empty helm template \
-s templates/connect-injector-disruptionbudget.yaml .
}

@test "connect-injector/DisruptionBudget: enabled with connectInject=enabled , connectInject.disruptionBudget.enabled=true and global.enabled=true " {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq 'length > 0' | tee /dev/stderr)
[ "${actual}" = "true" ]
}

@test "connect-injector/DisruptionBudget: disabled with connectInject.enabled=false" {
cd `chart_dir`
assert_empty helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.enabled=false' \
.
}

@test "connect-injector/DisruptionBudget: disabled with connectInject.disruptionBudget.enabled=false" {
cd `chart_dir`
assert_empty helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.disruptionBudget.enabled=false' \
.
}

@test "connect-injector/DisruptionBudget: disabled with global.enabled=false" {
cd `chart_dir`
assert_empty helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'global.enabled=false' \
.
}

#--------------------------------------------------------------------
# maxUnavailable

@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=1" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=1' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "0" ]
}

@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=3" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=3' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "1" ]
}

@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=4" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=4' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "1" ]
}


@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=5" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=5' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "1" ]
}

@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=6" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=6' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "2" ]
}

@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=7" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=7' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "2" ]
}

@test "connect-injector/DisruptionBudget: correct maxUnavailable with replicas=8" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--set 'connectInject.replicas=8' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq '.spec.maxUnavailable' | tee /dev/stderr)
[ "${actual}" = "3" ]
}

#--------------------------------------------------------------------
# apiVersion

@test "connect-injector/DisruptionBudget: uses policy/v1 if supported" {
cd `chart_dir`
local actual=$(helm template \
-s templates/connect-injector-disruptionbudget.yaml \
--api-versions 'policy/v1/PodDisruptionBudget' \
--set 'global.enabled=true' \
--set 'connectInject.enabled=true' \
--set 'connectInject.disruptionBudget.enabled=true' \
. | tee /dev/stderr |
yq -r '.apiVersion' | tee /dev/stderr)
[ "${actual}" = "policy/v1" ]
}
# NOTE: can't test that it uses policy/v1beta1 if policy/v1 is *not* supported
# because the supported API versions depends on the Helm version and there's
# no flag to *remove* an API version so some Helm versions will always have
# policy/v1 support and will always use that API version.

6 changes: 6 additions & 0 deletions charts/consul/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1847,6 +1847,12 @@ connectInject:
# This value is also overridable via the "consul.hashicorp.com/transparent-proxy-overwrite-probes" annotation.
# Note: This value has no effect if transparent proxy is disabled on the pod.
defaultOverwriteProbes: true

disruptionBudget:
jmurret marked this conversation as resolved.
Show resolved Hide resolved
# True if you want to turn on disruptionBudget for connectInjector deployment
enabled: false

maxUnavailable: null

# Configures metrics for Consul Connect services. All values are overridable
# via annotations on a per-pod basis.
Expand Down