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

feat(k8s): refactoring Kubernetes labels #91

Merged
merged 2 commits into from
Dec 13, 2024
Merged

feat(k8s): refactoring Kubernetes labels #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ae39f9
feat(helm): refactoring Kubernetes recommended labels
nlamirault Dec 12, 2024
8c49925
feat(helm): support additional labels
nlamirault Dec 12, 2024
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
18 changes: 5 additions & 13 deletions charts/keep/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# keep

![Version: 0.1.25](https://img.shields.io/badge/Version-0.1.25-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.27.0](https://img.shields.io/badge/AppVersion-0.27.0-informational?style=flat-square)
![Version: 0.1.47](https://img.shields.io/badge/Version-0.1.47-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.31.7](https://img.shields.io/badge/AppVersion-0.31.7-informational?style=flat-square)

Keep Helm Chart

Expand All @@ -21,6 +21,7 @@ Keep Helm Chart

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| additionalLabels | object | `{}` | |
| backend.affinity | object | `{}` | |
| backend.autoscaling.enabled | bool | `false` | |
| backend.autoscaling.maxReplicas | int | `3` | |
Expand Down Expand Up @@ -86,7 +87,7 @@ Keep Helm Chart
| database.autoscaling.enabled | bool | `false` | |
| database.enabled | bool | `true` | |
| database.env[0].name | string | `"MYSQL_ALLOW_EMPTY_PASSWORD"` | |
| database.env[0].value | string | `"yes"` | |
| database.env[0].value | bool | `true` | |
| database.env[1].name | string | `"MYSQL_DATABASE"` | |
| database.env[1].value | string | `"keep"` | |
| database.env[2].name | string | `"MYSQL_PASSWORD"` | |
Expand All @@ -109,6 +110,7 @@ Keep Helm Chart
| database.pv.size | string | `"5Gi"` | |
| database.pv.storageClass | string | `""` | |
| database.pvc.enabled | bool | `true` | |
| database.pvc.retain | bool | `false` | |
| database.pvc.size | string | `"5Gi"` | |
| database.pvc.storageClass | string | `""` | |
| database.replicaCount | int | `1` | |
Expand Down Expand Up @@ -172,22 +174,12 @@ Keep Helm Chart
| global.ingress.annotations | object | `{}` | |
| global.ingress.backendPrefix | string | `"/v2"` | |
| global.ingress.className | string | `"nginx"` | |
| global.ingress.classType | string | `""` | |
| global.ingress.enabled | bool | `true` | |
| global.ingress.frontendPrefix | string | `"/"` | |
| global.ingress.hosts | list | `[]` | |
| global.ingress.tls | list | `[]` | |
| global.ingress.websocketPrefix | string | `"/websocket"` | |
| ingress-nginx.controller.admissionWebhooks.certManager.enabled | bool | `false` | |
| ingress-nginx.controller.admissionWebhooks.failurePolicy | string | `"Ignore"` | |
| ingress-nginx.controller.admissionWebhooks.patch.enabled | bool | `true` | |
| ingress-nginx.controller.admissionWebhooks.patch.image.pullPolicy | string | `"IfNotPresent"` | |
| ingress-nginx.controller.allowSnippetAnnotations | bool | `true` | |
| ingress-nginx.controller.service.annotations | object | `{}` | |
| ingress-nginx.controller.service.enabled | bool | `true` | |
| ingress-nginx.controller.service.ports.http | int | `80` | |
| ingress-nginx.controller.service.ports.https | int | `443` | |
| ingress-nginx.controller.service.type | string | `"LoadBalancer"` | |
| ingress-nginx.enabled | bool | `true` | |
| isGKE | bool | `false` | |
| nameOverride | string | `""` | |
| namespace | string | `"keep"` | |
Expand Down
6 changes: 5 additions & 1 deletion charts/keep/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ helm.sh/chart: {{ include "keep.chart" . }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
app.kubernetes.io/part-of: keep
{{- if .Values.additionalLabels }}
{{ toYaml .Values.additionalLabels }}
{{- end }}
{{- end }}

{{/*
Expand Down Expand Up @@ -186,4 +190,4 @@ Helper function for KEEP_API_URL that handles both relative and absolute URLs
{{- else -}}
{{- include "keep.fullUrl" . -}}{{- $apiUrlClient -}}
{{- end -}}
{{- end -}}
{{- end -}}
1 change: 1 addition & 0 deletions charts/keep/templates/backend-hpa.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.fullname" . }}-backend
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: backend
spec:
scaleTargetRef:
apiVersion: apps/v1
Expand Down
10 changes: 6 additions & 4 deletions charts/keep/templates/backend-route.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@ apiVersion: route.openshift.io/v1
kind: Route
metadata:
name: {{ $fullName }}
labels: {{- include "keep.labels" . | nindent 4 }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: backend
spec:
host: {{ .Values.backend.route.host }}
to:
kind: Service
name: {{ $fullName }}-backend
weight: 100
port:
port:
targetPort: {{ .Values.backend.service.port }}
wildcardPolicy: {{ .Values.backend.route.wildcardPolicy }}
tls:
{{ toYaml .Values.backend.route.tls | indent 4 }}
tls:
{{ toYaml .Values.backend.route.tls | indent 4 }}
{{- end}}
3 changes: 2 additions & 1 deletion charts/keep/templates/backend-service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ metadata:
name: {{ include "keep.fullname" . }}-backend
labels:
{{- include "keep.labels" . | nindent 4 }}
keep-component: backend-service
app.kubernetes.io/component: backend
keep-component: backend
annotations:
{{- if .Values.isGKE }}
cloud.google.com/backend-config: '{"default": "{{ include "keep.fullname" . }}-backend-backendconfig"}'
Expand Down
4 changes: 3 additions & 1 deletion charts/keep/templates/backend.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.fullname" . }}-backend
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: backend
keep-component: backend
spec:
{{- if not .Values.backend.autoscaling.enabled }}
Expand All @@ -27,7 +28,8 @@ spec:
{{- end }}
{{- end }}
labels:
{{- include "keep.selectorLabels" . | nindent 8 }}
{{- include "keep.labels" . | nindent 8 }}
app.kubernetes.io/component: backend
keep-component: backend
spec:
{{- with .Values.backend.imagePullSecrets }}
Expand Down
3 changes: 3 additions & 0 deletions charts/keep/templates/db-pv.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
apiVersion: v1
kind: PersistentVolume
metadata:
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: database
name: {{ include "keep.fullname" . }}-pv
spec:
capacity:
Expand Down
5 changes: 4 additions & 1 deletion charts/keep/templates/db-pvc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ metadata:
{{- if .Values.database.pvc.retain }}
helm.sh/resource-policy: keep
{{- end }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: database
spec:
{{- if $existingPvc }}
# Use existing PVC spec
Expand All @@ -25,4 +28,4 @@ spec:
requests:
storage: {{ .Values.database.pvc.size }}
{{- end }}
{{- end }}
{{- end }}
3 changes: 2 additions & 1 deletion charts/keep/templates/db-service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ metadata:
name: {{ include "keep.name" . }}-database
labels:
{{- include "keep.labels" . | nindent 4 }}
keep-component: database-service
app.kubernetes.io/component: database
keep-component: database
spec:
type: {{ .Values.database.service.type }}
ports:
Expand Down
4 changes: 3 additions & 1 deletion charts/keep/templates/db.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.fullname" . }}-database
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: database
keep-component: database
spec:
{{- if not .Values.database.autoscaling.enabled }}
Expand All @@ -21,7 +22,8 @@ spec:
{{- toYaml . | nindent 8 }}
{{- end }}
labels:
{{- include "keep.selectorLabels" . | nindent 8 }}
{{- include "keep.labels" . | nindent 8 }}
app.kubernetes.io/component: database
keep-component: database
spec:
{{- with .Values.database.imagePullSecrets }}
Expand Down
3 changes: 3 additions & 0 deletions charts/keep/templates/delete-secret-job.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ metadata:
annotations:
"helm.sh/hook": pre-delete
"helm.sh/hook-delete-policy": hook-succeeded,hook-failed
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: secrets
spec:
template:
spec:
Expand Down
1 change: 1 addition & 0 deletions charts/keep/templates/frontend-hpa.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.fullname" . }}-frontend
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: frontend
spec:
scaleTargetRef:
apiVersion: apps/v1
Expand Down
10 changes: 6 additions & 4 deletions charts/keep/templates/frontend-route.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@ apiVersion: route.openshift.io/v1
kind: Route
metadata:
name: {{ $fullName }}
labels: {{- include "keep.labels" . | nindent 4 }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: frontend
spec:
host: {{ .Values.frontend.route.host }}
to:
kind: Service
name: {{ $fullName }}-frontend
weight: 100
port:
port:
targetPort: {{ .Values.frontend.service.port }}
wildcardPolicy: {{ .Values.frontend.route.wildcardPolicy }}
tls:
{{ toYaml .Values.frontend.route.tls | indent 4 }}
tls:
{{ toYaml .Values.frontend.route.tls | indent 4 }}
{{- end}}
3 changes: 2 additions & 1 deletion charts/keep/templates/frontend-service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ metadata:
name: {{ include "keep.fullname" . }}-frontend
labels:
{{- include "keep.labels" . | nindent 4 }}
keep-component: frontend-service
app.kubernetes.io/component: frontend
keep-component: frontend
annotations:
{{- if .Values.isGKE }}
cloud.google.com/backend-config: '{"default": "{{ include "keep.fullname" . }}-frontend-backendconfig"}'
Expand Down
14 changes: 8 additions & 6 deletions charts/keep/templates/frontend.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.fullname" . }}-frontend
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: frontend
keep-component: frontend
spec:
{{- if not .Values.frontend.autoscaling.enabled }}
Expand All @@ -21,7 +22,8 @@ spec:
{{- toYaml . | nindent 8 }}
{{- end }}
labels:
{{- include "keep.selectorLabels" . | nindent 8 }}
{{- include "keep.labels" . | nindent 8 }}
app.kubernetes.io/component: frontend
keep-component: frontend
spec:
{{- with .Values.frontend.imagePullSecrets }}
Expand Down Expand Up @@ -51,10 +53,10 @@ spec:
- name: NEXTAUTH_URL
value: {{ include "keep.nextAuthUrl" . | quote }}
{{- range .Values.frontend.env }}
{{- if and
(ne .name "PUSHER_HOST")
(ne .name "API_URL_CLIENT")
(ne .name "API_URL")
{{- if and
(ne .name "PUSHER_HOST")
(ne .name "API_URL_CLIENT")
(ne .name "API_URL")
(ne .name "NEXTAUTH_URL") }}
- name: {{ .name }}
value: {{ .value | quote }}
Expand Down Expand Up @@ -87,4 +89,4 @@ spec:
volumes:
- name: state-volume
emptyDir: {}
{{- end }}
{{- end }}
5 changes: 3 additions & 2 deletions charts/keep/templates/ingress-haproxy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ metadata:
name: {{ $fullName }}-ingress
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: networking
annotations:
kubernetes.io/ingress.class: "haproxy"
# HAProxy timeout configurations
Expand All @@ -14,7 +15,7 @@ metadata:
haproxy-ingress.github.io/timeout-connect: "3600s"
haproxy-ingress.github.io/timeout-tunnel: "3600s"
haproxy-ingress.github.io/ssl-redirect: "false"

# Backend configurations for path rewrites + # WebSocket support
haproxy-ingress.github.io/config-backend: |
acl path_v2 path_beg {{ .Values.global.ingress.backendPrefix }}/
Expand Down Expand Up @@ -98,4 +99,4 @@ spec:
port:
number: {{ $.Values.frontend.service.port }}
{{- end }}
{{- end }}
{{- end }}
3 changes: 2 additions & 1 deletion charts/keep/templates/ingress-nginx.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ metadata:
name: {{ $fullName }}-ingress
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: networking
annotations:
{{- if or (eq .Values.global.ingress.className "nginx") (eq .Values.global.ingress.classType "nginx") }}
kubernetes.io/ingress.class: "nginx"
Expand Down Expand Up @@ -115,4 +116,4 @@ spec:
port:
number: {{ $.Values.frontend.service.port }}
{{- end }}
{{- end }}
{{- end }}
3 changes: 2 additions & 1 deletion charts/keep/templates/ingress-traefik-middleware.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ metadata:
namespace: {{ .Release.Namespace }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: networking
spec:
stripPrefix:
prefixes:
- {{ .Values.global.ingress.backendPrefix }}
- {{ .Values.global.ingress.websocketPrefix }}
{{- end }}
{{- end }}
5 changes: 3 additions & 2 deletions charts/keep/templates/ingress-traefik.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ metadata:
name: {{ $fullName }}-ingress
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: networking
annotations:
traefik.ingress.kubernetes.io/router.middlewares: {{ .Release.Namespace }}-strip-prefix@kubernetescrd
traefik.ingress.kubernetes.io/router.entrypoints: web
traefik.ingress.kubernetes.io/timeouts.idle: "3600s"
traefik.ingress.kubernetes.io/timeouts.connect: "3600s"
traefik.ingress.kubernetes.io/timeouts.read: "3600s"
traefik.ingress.kubernetes.io/timeouts.write: "3600s"

# WebSocket configuration
traefik.ingress.kubernetes.io/websockets.enabled: "true"
{{- with .Values.global.ingress.annotations }}
Expand Down Expand Up @@ -93,4 +94,4 @@ spec:
port:
number: {{ $.Values.frontend.service.port }}
{{- end }}
{{- end }}
{{- end }}
3 changes: 3 additions & 0 deletions charts/keep/templates/role-binding-secret-manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ kind: RoleBinding
metadata:
name: secret-manager-rolebinding
namespace: {{ include "keep.namespace" . }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: secrets
subjects:
- kind: ServiceAccount
name: {{ include "keep.serviceAccountName" . }}
Expand Down
3 changes: 3 additions & 0 deletions charts/keep/templates/role-secret-manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ kind: Role
metadata:
name: secret-manager-role
namespace: {{ include "keep.namespace" . }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: secrets
rules:
- apiGroups: [""]
resources: ["secrets"]
Expand Down
1 change: 1 addition & 0 deletions charts/keep/templates/serviceaccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.serviceAccountName" . }}
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: rbac
{{- with .Values.serviceAccount.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
Expand Down
1 change: 1 addition & 0 deletions charts/keep/templates/websocket-hpa.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
name: {{ include "keep.fullname" . }}-websocket
labels:
{{- include "keep.labels" . | nindent 4 }}
app.kubernetes.io/component: websocket
spec:
scaleTargetRef:
apiVersion: apps/v1
Expand Down
Loading
Loading