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

[Helm] update ingress templates #7132

Merged
merged 13 commits into from
Nov 16, 2023
Merged

[Helm] update ingress templates #7132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7488685
updtae ingress templates
azhavoro Nov 13, 2023
2c373d6
apply comments
azhavoro Nov 15, 2023
14ffb2d
Fix linter
azhavoro Nov 15, 2023
2a52846
apply comments
azhavoro Nov 15, 2023
403adf6
Update helm-chart/values.yaml
azhavoro Nov 15, 2023
259f181
Update helm-chart/templates/ingress.yaml
azhavoro Nov 15, 2023
7d12e7f
Update helm-chart/templates/analytics/ingress.yaml
azhavoro Nov 15, 2023
e143bdf
update changelog
azhavoro Nov 15, 2023
fb7a737
tls
azhavoro Nov 15, 2023
b0714bc
Update helm-chart/values.yaml
azhavoro Nov 16, 2023
021aee4
set ingressClassName to 'traefik' if ingress.className is not set and…
azhavoro Nov 16, 2023
d3a1cc3
Merge branch 'develop' into az/update_helm
azhavoro Nov 16, 2023
75e4346
fixed ingressClassName and updated traefik
azhavoro Nov 16, 2023
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
17 changes: 17 additions & 0 deletions changelog.d/20231115_110934_andrey_update_helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### Changed

- \[Helm\] Minimum compatible Kubernetes version is 1.19.0.
(<https://github.com/opencv/cvat/pull/7132>)

- \[Helm\] The CVAT hostname can be configured with `ingress.hostname` option.
azhavoro marked this conversation as resolved.
Show resolved Hide resolved
(<https://github.com/opencv/cvat/pull/7132>)

- \[Helm\] `ingress.tls` configuration has been reworked.
(<https://github.com/opencv/cvat/pull/7132>)

- \[Helm\] Traefik subchart updated to 25.0.0 (appVersion v2.10.5)
(<https://github.com/opencv/cvat/pull/7132>)

### Removed
\[Helm\] `ingress.hosts` has been removed, use `ingress.hostname` instead.
(<https://github.com/opencv/cvat/pull/7132>)
5 changes: 3 additions & 2 deletions helm-chart/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
apiVersion: v2
name: cvat
kubeVersion: ">= 1.19.0"
description: A Helm chart for Kubernetes

# A chart can be either an 'application' or a 'library' chart.
Expand All @@ -15,7 +16,7 @@ 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.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.10.3
version: 0.11.0
SpecLad marked this conversation as resolved.
Show resolved Hide resolved

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down Expand Up @@ -51,7 +52,7 @@ dependencies:
condition: analytics.enabled

- name: traefik
version: 10.24.0
version: 25.0.0
repository: https://helm.traefik.io/traefik
condition: traefik.enabled

Expand Down
47 changes: 1 addition & 46 deletions helm-chart/cvat.values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,6 @@ analytics:

ingress:
enabled: true
annotations:
traefik.ingress.kubernetes.io/router.entrypoints: web
kubernetes.io/ingress.class: traefik
Comment on lines -7 to -8
Copy link
Contributor

Choose a reason for hiding this comment

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

You removed these annotations from here, but you didn't re-add them anywhere else. Is the user supposed to set them manually when enabling Traefik?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is no need to add the first line because this is the default behavior
The second line is deprecated, ingressclass is now used instead

Copy link
Contributor

@SpecLad SpecLad Nov 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

There is no need to add the first line because this is the default behavior

Okay.

The second line is deprecated, ingressclass is now used instead

Indeed, but ingress.className defaults to blank. Shouldn't it default to traefik when the traefik setting is true?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

hosts:
- host: cvat.local
paths:
- path: /api
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path: /admin
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path: /static
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path: /django-rq
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path: /git
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path: /opencv
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path: /profiler
pathType: "Prefix"
service:
name: backend-service
port: 8080
- path : /
pathType: "Prefix"
service:
name: frontend-service
port: 80

traefik:
enabled: true
53 changes: 23 additions & 30 deletions helm-chart/templates/analytics/ingress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,41 @@
{{- $version := .Capabilities.KubeVersion.GitVersion -}}
{{- if and .Values.ingress.enabled .Values.analytics.enabled -}}
{{- $fullName := include "cvat.fullname" . -}}
{{- if semverCompare ">=1.19-0" $version -}}
apiVersion: networking.k8s.io/v1
azhavoro marked this conversation as resolved.
Show resolved Hide resolved
{{- else if semverCompare ">=1.14-0" $version -}}
apiVersion: networking.k8s.io/v1beta1
{{- else -}}
apiVersion: extensions/v1beta1
{{- end }}
kind: Ingress
metadata:
name: {{ $fullName }}-analytics
namespace: {{ .Release.Namespace }}
labels:
{{- include "cvat.labels" . | nindent 4 }}
annotations:
{{- if .Values.traefik.enabled }}
traefik.ingress.kubernetes.io/router.middlewares: {{ $.Release.Namespace }}-stripprefix@kubernetescrd,
{{ $.Release.Namespace }}-forwardauth@kubernetescrd
{{- with .Values.analytics.ingress.annotations }}
{{- end }}
{{- with .Values.ingress.annotations }}
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
{{- if semverCompare ">=1.19-0" $version }}
ingressClassName: {{ .Values.ingress.className }}
{{- if .Values.ingress.className }}
ingressClassName: {{ .Values.ingress.className | toYaml }}
{{- else if and .Values.traefik.enabled .Values.traefik.ingressClass.enabled }}
ingressClassName: {{ .Values.traefik.ingressClass.name | default (include "traefik.fullname" .Subcharts.traefik) }}
{{- end }}
rules:
{{- range .Values.ingress.hosts }}
- host: {{ .host | quote }}
http:
paths:
- path: {{ $.Values.analytics.ingress.path }}
{{- if $.Values.analytics.ingress.pathType }}
pathType: {{ $.Values.analytics.ingress.pathType }}
{{- end }}
{{- if semverCompare ">=1.19-0" $version }}
backend:
service:
name: {{ $.Release.Name }}-{{ $.Values.analytics.ingress.service.name }}
port:
number: {{ $.Values.analytics.ingress.service.port }}
{{- else }}
backend:
serviceName: {{ $.Release.Name }}-{{ $.Values.analytics.ingress.service.name }}
servicePort: {{ $.Values.analytics.ingress.service.port }}
{{- end }}
{{- if .Values.ingress.tls }}
tls:
- hosts:
- {{ .Values.ingress.hostname }}
secretName: {{ .Values.ingress.tlsSecretName }}
{{- end }}
rules:
- host: {{ .Values.ingress.hostname }}
http:
paths:
- path: /analytics
pathType: Prefix
backend:
service:
name: {{ $.Release.Name }}-grafana
port:
number: 80
{{- end }}
66 changes: 27 additions & 39 deletions helm-chart/templates/ingress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
{{- $version := .Capabilities.KubeVersion.GitVersion -}}
{{- if .Values.ingress.enabled -}}
{{- $fullName := include "cvat.fullname" . -}}
{{- if semverCompare ">=1.19-0" $version -}}
apiVersion: networking.k8s.io/v1
{{- else if semverCompare ">=1.14-0" $version -}}
apiVersion: networking.k8s.io/v1beta1
{{- else -}}
apiVersion: extensions/v1beta1
{{- end }}
kind: Ingress
metadata:
name: {{ $fullName }}
Expand All @@ -19,40 +12,35 @@ metadata:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
{{- if semverCompare ">=1.19-0" $version }}
ingressClassName: {{ .Values.ingress.className }}
{{- if .Values.ingress.className }}
ingressClassName: {{ .Values.ingress.className | toYaml }}
{{- else if and .Values.traefik.enabled .Values.traefik.ingressClass.enabled }}
ingressClassName: {{ .Values.traefik.ingressClass.name | default (include "traefik.fullname" .Subcharts.traefik) }}
{{- end }}
{{- if .Values.ingress.tls }}
{{- if .Values.ingress.tls }}
tls:
{{- range .Values.ingress.tls }}
- hosts:
{{- range .hosts }}
- {{ . | quote }}
{{- end }}
secretName: {{ .secretName }}
- hosts:
- {{ .Values.ingress.hostname }}
secretName: {{ .Values.ingress.tlsSecretName }}
{{- end }}
{{- end }}
rules:
{{- range .Values.ingress.hosts }}
- host: {{ .host | quote }}
http:
paths:
{{- range .paths }}
- path: {{ .path }}
{{- if .pathType }}
pathType: {{ .pathType }}
{{- end }}
{{- if semverCompare ">=1.19-0" $version }}
backend:
service:
name: {{ $.Release.Name }}-{{ .service.name }}
port:
number: {{ .service.port }}
{{- else }}
backend:
serviceName: {{ .service.name }}
servicePort: {{ .service.port }}
{{- end }}
{{- end }}
{{- end }}
- host: {{ .Values.ingress.hostname }}
http:
paths:
{{- range tuple "api" "admin" "static" "django-rq" "profiler" }}
- path: "/{{ . }}"
pathType: Prefix
backend:
service:
name: {{ $.Release.Name }}-backend-service
port:
number: 8080
{{- end }}
- path: /
pathType: Prefix
backend:
service:
name: {{ .Release.Name }}-frontend-service
port:
number: 80
{{- end }}
79 changes: 24 additions & 55 deletions helm-chart/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,15 +273,6 @@ analytics:
clickhousePassword: user
clickhouseHost: "{{ .Release.Name }}-clickhouse"

ingress:
path: /analytics
pathType: "Prefix"
annotations:
kubernetes.io/ingress.class: traefik
service:
name: grafana
port: 80

vector:
envFrom:
- secretRef:
Expand Down Expand Up @@ -364,56 +355,34 @@ grafana:
enabled: false

ingress:
## @param ingress.enabled Enable ingress resource generation for CVAT
##
enabled: false

# In case you need an ingress, write them manually in your my.values.eml, see example below:
# enabled: true
# annotations:
# traefik.ingress.kubernetes.io/router.entrypoints: web
# kubernetes.io/ingress.class: traefik
# hosts:
# - host: cvat.local
# paths:
# - path: /api
# pathType: "Prefix"
# service:
# name: backend-service
# port: 8080
# - path: /admin
# pathType: "Prefix"
# service:
# name: backend-service
# port: 8080
# - path: /static
# pathType: "Prefix"
# service:
# name: backend-service
# port: 8080
# - path: /django-rq
# pathType: "Prefix"
# service:
# name: backend-service
# port: 8080
# - path: /profiler
# pathType: "Prefix"
# service:
# name: backend-service
# port: 8080
# - path : /
# pathType: "Prefix"
# service:
# name: frontend-service
# port: 80
# tls:
# - hosts:
# - <your_domain>
# secretName: ingress-tls-cvat
SpecLad marked this conversation as resolved.
Show resolved Hide resolved
## @param ingress.hostname Host for the ingress resource
##
hostname: cvat.local
## @param ingress.annotations Additional annotations for the Ingress resource.
##
## e.g:
## annotations:
## kubernetes.io/ingress.class: nginx
##
annotations: {}
## @param ingress.className IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)
## This is supported in Kubernetes 1.18+ and required if you have more than one IngressClass marked as the default for your cluster
## ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/
##
className: ""
## @param ingress.tls Enable TLS configuration for the host defined at `ingress.hostname` parameter
## TLS certificates will be retrieved from a TLS secret defined in tlsSecretName parameter
##
tls: false
## @param ingress.tlsSecretName Specifies the name of the secret containing TLS certificates. Ignored if ingress.tls is false
##
tlsSecretName: ingress-tls-cvat

traefik:
enabled: false
service:
externalIPs:
# - "192.168.49.2"

smokescreen:
opts: ''
Loading