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

feat(datahub-gms): Enable autoscaling via HPA #517

Merged
merged 6 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
2 changes: 2 additions & 0 deletions .github/workflows/lint-test.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
name: Lint and Test Charts

on:
workflow_dispatch:
7onn marked this conversation as resolved.
Show resolved Hide resolved
push:
branches:
- master
- 7onn/autoscale-gms
7onn marked this conversation as resolved.
Show resolved Hide resolved
paths-ignore:
- '**.md'
- 'LICENSE'
Expand Down
4 changes: 2 additions & 2 deletions charts/datahub/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ description: A Helm chart for DataHub
type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
version: 0.4.34
version: 0.4.35
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application.
appVersion: 0.14.1
dependencies:
- name: datahub-gms
version: 0.2.175
version: 0.2.176
repository: file://./subcharts/datahub-gms
condition: datahub-gms.enabled
- name: datahub-frontend
Expand Down
2 changes: 1 addition & 1 deletion charts/datahub/subcharts/datahub-gms/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: A Helm chart for DataHub's datahub-gms component
type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
version: 0.2.175
version: 0.2.176
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application.
appVersion: v0.14.1
2 changes: 1 addition & 1 deletion charts/datahub/subcharts/datahub-gms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ datahub-gms
===========
A Helm chart for DataHub's datahub-gms component

Current chart version is `0.2.0`
Current chart version is `0.2.176`

## Chart Values

Expand Down
19 changes: 19 additions & 0 deletions charts/datahub/subcharts/datahub-gms/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,22 @@ Return the appropriate apiVersion for ingress.
{{- print "networking.k8s.io/v1beta1" -}}
{{- end -}}
{{- end -}}

{{/*
Return the appropriate apiVersion for HorizontalPodAutoscaler.
*/}}
{{- define "datahub-gms.hpa.apiVersion" -}}
{{- if and (.Capabilities.APIVersions.Has "autoscaling/v2") (semverCompare ">=1.23-0" .Capabilities.KubeVersion.Version) -}}
{{- print "autoscaling/v2" -}}
{{- else -}}
{{- print "autoscaling/v2beta1" -}}
{{- end -}}
{{- end -}}

{{/*
Create image registry, name and tag for a datahub component
*/}}
{{- define "datahub.image" -}}
{{- $registry := .image.registry | default .imageRegistry -}}
{{ $registry }}/{{ .image.repository }}:{{ required "Global or specific tag is required" (.image.tag | default .version) -}}
{{- end -}}
Comment on lines +89 to +95
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the root chart has a similar template. I had to copy this so I could helm template from within the subchart folder.

52 changes: 52 additions & 0 deletions charts/datahub/subcharts/datahub-gms/templates/hpa.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{{- if .Values.hpa.enabled }}
{{- $apiVersion := include "datahub-gms.hpa.apiVersion" . -}}
apiVersion: {{ $apiVersion }}
kind: HorizontalPodAutoscaler
metadata:
name: {{ include "datahub-gms.fullname" . }}
labels:
{{- include "datahub-gms.labels" . | nindent 4 }}
{{- range $key, $val := .Values.extraLabels }}
{{ $key }}: {{ $val | quote }}
{{- end }}
spec:
{{- if and (.Values.global.strict_mode) (.Values.hpa.enabled) (.Values.global.datahub.managed_ingestion.enabled) (not .Values.global.datahub_standalone_consumers_enabled) }}
{{- fail "\nHPA cannot be used in non standalone mode. Please enable standalone consumers if you wish to run multiple GMS instances and managed ingestion." }}
{{- else }}
scaleTargetRef:
apiVersion: apps/v1
kind: Deployment
name: {{ include "datahub-gms.fullname" . }}
minReplicas: {{ .Values.hpa.minReplicas }}
maxReplicas: {{ .Values.hpa.maxReplicas }}
{{- with .Values.hpa.behavior }}
behavior:
{{- toYaml . | nindent 4 }}
{{- end }}
metrics:
{{- with .Values.hpa.targetMemoryUtilizationPercentage }}
- type: Resource
resource:
name: memory
{{- if (eq $apiVersion "autoscaling/v2") }}
target:
type: Utilization
averageUtilization: {{ . }}
{{- else }}
targetAverageUtilization: {{ . }}
{{- end }}
{{- end }}
{{- with .Values.hpa.targetCPUUtilizationPercentage }}
- type: Resource
resource:
name: cpu
{{- if (eq $apiVersion "autoscaling/v2") }}
target:
type: Utilization
averageUtilization: {{ . }}
{{- else }}
targetAverageUtilization: {{ . }}
{{- end }}
{{- end }}
{{- end }}
{{- end }}
9 changes: 9 additions & 0 deletions charts/datahub/subcharts/datahub-gms/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

replicaCount: 1

hpa:
# Can only be enabled if global.datahub_standalone_consumers_enabled
enabled: false
minReplicas: 1
maxReplicas: 2
behavior: {}
targetCPUUtilizationPercentage: 100
targetMemoryUtilizationPercentage:

revisionHistoryLimit: 10

image:
Expand Down
2 changes: 1 addition & 1 deletion charts/datahub/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ global:
strict_mode: true
graph_service_impl: elasticsearch
datahub_analytics_enabled: true
datahub_standalone_consumers_enabled: false
datahub_standalone_consumers_enabled: true
7onn marked this conversation as resolved.
Show resolved Hide resolved
imageRegistry: "docker.io"

elasticsearch:
Expand Down