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.

Sign up for GitHub

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

Jump to bottom

control-plane: Add possibility to manage consul sidecar resources with annotations #956

Merged
merged 1 commit into from
Jan 19, 2022
Merged

control-plane: Add possibility to manage consul sidecar resources with annotations #956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions charts/consul/templates/connect-inject-deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,16 +201,16 @@ spec:
{{- if .Values.global.consulSidecarContainer }}
{{- $consulSidecarResources := .Values.global.consulSidecarContainer.resources }}
{{- if not (kindIs "invalid" $consulSidecarResources.limits.memory) }}
-consul-sidecar-memory-limit={{ $consulSidecarResources.limits.memory }} \
-default-consul-sidecar-memory-limit={{ $consulSidecarResources.limits.memory }} \
{{- end }}
{{- if not (kindIs "invalid" $consulSidecarResources.requests.memory) }}
-consul-sidecar-memory-request={{ $consulSidecarResources.requests.memory }} \
-default-consul-sidecar-memory-request={{ $consulSidecarResources.requests.memory }} \
{{- end }}
{{- if not (kindIs "invalid" $consulSidecarResources.limits.cpu) }}
-consul-sidecar-cpu-limit={{ $consulSidecarResources.limits.cpu }} \
-default-consul-sidecar-cpu-limit={{ $consulSidecarResources.limits.cpu }} \
{{- end }}
{{- if not (kindIs "invalid" $consulSidecarResources.requests.cpu) }}
-consul-sidecar-cpu-request={{ $consulSidecarResources.requests.cpu }} \
-default-consul-sidecar-cpu-request={{ $consulSidecarResources.requests.cpu }} \
{{- end }}
{{- end }}
startupProbe:
Expand Down
40 changes: 20 additions & 20 deletions charts/consul/test/unit/connect-inject-deployment.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1165,19 +1165,19 @@ EOF
yq '.spec.template.spec.containers[0].command' | tee /dev/stderr)

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-request=25Mi"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-request=25Mi"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-request=20m"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-request=20m"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-limit=50Mi"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-limit=50Mi"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-limit=20m"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-limit=20m"))' | tee /dev/stderr)
[ "${actual}" = "true" ]
}

Expand All @@ -1194,19 +1194,19 @@ EOF
yq '.spec.template.spec.containers[0].command' | tee /dev/stderr)

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-request=100Mi"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-request=100Mi"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-request=100m"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-request=100m"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-limit=200Mi"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-limit=200Mi"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-limit=200m"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-limit=200m"))' | tee /dev/stderr)
[ "${actual}" = "true" ]
}

Expand All @@ -1223,19 +1223,19 @@ EOF
yq '.spec.template.spec.containers[0].command' | tee /dev/stderr)

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-request=0"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-request=0"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-request=0"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-request=0"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-limit=0"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-limit=0"))' | tee /dev/stderr)
[ "${actual}" = "true" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-limit=0"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-limit=0"))' | tee /dev/stderr)
[ "${actual}" = "true" ]
}

Expand All @@ -1252,19 +1252,19 @@ EOF
yq '.spec.template.spec.containers[0].command' | tee /dev/stderr)

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-request"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-request"))' | tee /dev/stderr)
[ "${actual}" = "false" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-request"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-request"))' | tee /dev/stderr)
[ "${actual}" = "false" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-limit"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-limit"))' | tee /dev/stderr)
[ "${actual}" = "false" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-limit"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-limit"))' | tee /dev/stderr)
[ "${actual}" = "false" ]
}

Expand All @@ -1278,19 +1278,19 @@ EOF
yq '.spec.template.spec.containers[0].command' | tee /dev/stderr)

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-request"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-request"))' | tee /dev/stderr)
[ "${actual}" = "false" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-request"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-request"))' | tee /dev/stderr)
[ "${actual}" = "false" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-memory-limit"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-memory-limit"))' | tee /dev/stderr)
[ "${actual}" = "false" ]

local actual=$(echo "$cmd" |
yq 'any(contains("-consul-sidecar-cpu-limit"))' | tee /dev/stderr)
yq 'any(contains("-default-consul-sidecar-cpu-limit"))' | tee /dev/stderr)
[ "${actual}" = "false" ]
}

Expand Down
6 changes: 6 additions & 0 deletions control-plane/connect-inject/annotations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ const (
annotationSidecarProxyMemoryLimit = "consul.hashicorp.com/sidecar-proxy-memory-limit"
annotationSidecarProxyMemoryRequest = "consul.hashicorp.com/sidecar-proxy-memory-request"

// annotations for consul sidecar resource limits.
annotationConsulSidecarCPULimit = "consul.hashicorp.com/consul-sidecar-cpu-limit"
annotationConsulSidecarCPURequest = "consul.hashicorp.com/consul-sidecar-cpu-request"
annotationConsulSidecarMemoryLimit = "consul.hashicorp.com/consul-sidecar-memory-limit"
annotationConsulSidecarMemoryRequest = "consul.hashicorp.com/consul-sidecar-memory-request"

// annotations for metrics to configure where Prometheus scrapes
// metrics from, whether to run a merged metrics endpoint on the consul
// sidecar, and configure the connect service metrics.
Expand Down
74 changes: 73 additions & 1 deletion control-plane/connect-inject/consul_sidecar.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"fmt"

corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
)

// consulSidecar starts the consul-sidecar command to only run
Expand All @@ -16,6 +17,11 @@ func (h *Handler) consulSidecar(pod corev1.Pod) (corev1.Container, error) {
return corev1.Container{}, err
}

resources, err := h.consulSidecarResources(pod)
if err != nil {
return corev1.Container{}, err
}

command := []string{
"consul-k8s-control-plane",
"consul-sidecar",
Expand All @@ -38,6 +44,72 @@ func (h *Handler) consulSidecar(pod corev1.Pod) (corev1.Container, error) {
},
},
Command: command,
Resources: h.ConsulSidecarResources,
Resources: resources,
}, nil
}

func (h *Handler) consulSidecarResources(pod corev1.Pod) (corev1.ResourceRequirements, error) {
resources := corev1.ResourceRequirements{
Limits: corev1.ResourceList{},
Requests: corev1.ResourceList{},
}
// zeroQuantity is used for comparison to see if a quantity was explicitly
// set.
var zeroQuantity resource.Quantity

// NOTE: We only want to set the limit/request if the default or annotation
// was explicitly set. If it's not explicitly set, it will be the zero value
// which would show up in the pod spec as being explicitly set to zero if we
// set that key, e.g. "cpu" to zero.
// We want it to not show up in the pod spec at all if if it's not explicitly
// set so that users aren't wondering why it's set to 0 when they didn't specify
// a request/limit. If they have explicitly set it to 0 then it will be set
// to 0 in the pod spec because we're doing a comparison to the zero-valued
// struct.

// CPU Limit.
if anno, ok := pod.Annotations[annotationConsulSidecarCPULimit]; ok {
cpuLimit, err := resource.ParseQuantity(anno)
if err != nil {
return corev1.ResourceRequirements{}, fmt.Errorf("parsing annotation %s:%q: %s", annotationConsulSidecarCPULimit, anno, err)
}
resources.Limits[corev1.ResourceCPU] = cpuLimit
} else if h.DefaultConsulSidecarResources.Limits[corev1.ResourceCPU] != zeroQuantity {
resources.Limits[corev1.ResourceCPU] = h.DefaultConsulSidecarResources.Limits[corev1.ResourceCPU]
}

// CPU Request.
if anno, ok := pod.Annotations[annotationConsulSidecarCPURequest]; ok {
cpuRequest, err := resource.ParseQuantity(anno)
if err != nil {
return corev1.ResourceRequirements{}, fmt.Errorf("parsing annotation %s:%q: %s", annotationConsulSidecarCPURequest, anno, err)
}
resources.Requests[corev1.ResourceCPU] = cpuRequest
} else if h.DefaultConsulSidecarResources.Requests[corev1.ResourceCPU] != zeroQuantity {
resources.Requests[corev1.ResourceCPU] = h.DefaultConsulSidecarResources.Requests[corev1.ResourceCPU]
}

// Memory Limit.
if anno, ok := pod.Annotations[annotationConsulSidecarMemoryLimit]; ok {
memoryLimit, err := resource.ParseQuantity(anno)
if err != nil {
return corev1.ResourceRequirements{}, fmt.Errorf("parsing annotation %s:%q: %s", annotationConsulSidecarMemoryLimit, anno, err)
}
resources.Limits[corev1.ResourceMemory] = memoryLimit
} else if h.DefaultConsulSidecarResources.Limits[corev1.ResourceMemory] != zeroQuantity {
resources.Limits[corev1.ResourceMemory] = h.DefaultConsulSidecarResources.Limits[corev1.ResourceMemory]
}

// Memory Request.
if anno, ok := pod.Annotations[annotationConsulSidecarMemoryRequest]; ok {
memoryRequest, err := resource.ParseQuantity(anno)
if err != nil {
return corev1.ResourceRequirements{}, fmt.Errorf("parsing annotation %s:%q: %s", annotationConsulSidecarMemoryRequest, anno, err)
}
resources.Requests[corev1.ResourceMemory] = memoryRequest
} else if h.DefaultConsulSidecarResources.Requests[corev1.ResourceMemory] != zeroQuantity {
resources.Requests[corev1.ResourceMemory] = h.DefaultConsulSidecarResources.Requests[corev1.ResourceMemory]
}

return resources, nil
}
Loading