Onyxia v4 : ui renamed to web and version bumps (#52)

* Warning : breaking changes, read README.md ! * Refactor ui to web * Repository and tag for standard renovate matching * Bump versions --------- Co-authored-by: odysseu <[email protected]>
InseeFrLab · Sep 7, 2023 · 4f9ed6c · 4f9ed6c
1 parent 3d83681
commit 4f9ed6c
Show file tree

Hide file tree

Showing 13 changed files with 130 additions and 120 deletions.
diff --git a/charts/onyxia/Chart.yaml b/charts/onyxia/Chart.yaml
@@ -14,8 +14,8 @@ 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: 3.8.4
+version: 4.0.0
 
 # 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: 2.13.19
+appVersion: 2.28.0
diff --git a/charts/onyxia/README.md b/charts/onyxia/README.md
@@ -0,0 +1,10 @@
+# Helm chart for [Onyxia](https://www.onyxia.sh/)  
+
+## Breaking changes  
+
+### v3 to v4  
+
+* `ui` block has been renamed to `web` in the values. Change your `values.yaml` file accordingly.  
+* Any resource created by helm that was suffixed by `ui` is now suffixed by `web`. This should be seamless for you unless you specifically rely on resource name for other purposes.  
+* `image.name` has been renamed to `image.repository` and `image.version` has been renamed to `image.tag` to be more standard. If you are overriding versions in either web or API you should use those new values keys.
+
diff --git a/charts/onyxia/templates/_helpers.tpl b/charts/onyxia/templates/_helpers.tpl
@@ -6,8 +6,8 @@ Expand the name of the chart.
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
-{{- define "onyxia.ui.name" -}}
-{{- printf "%s-%s" (include "onyxia.name" .) .Values.ui.name | trunc 63 | trimSuffix "-" -}}
+{{- define "onyxia.web.name" -}}
+{{- printf "%s-%s" (include "onyxia.name" .) .Values.web.name | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
 
@@ -34,8 +34,8 @@ If release name contains chart name it will be used as a full name.
 {{- end -}}
 {{- end -}}
 
-{{- define "onyxia.ui.fullname" -}}
-{{- printf "%s-%s" (include "onyxia.fullname" .) .Values.ui.name | trunc 63 | trimSuffix "-" -}}
+{{- define "onyxia.web.fullname" -}}
+{{- printf "%s-%s" (include "onyxia.fullname" .) .Values.web.name | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
 
@@ -54,8 +54,8 @@ Create chart name and version as used by the chart label.
 {{- printf "onyxia-api" -}}
 {{- end -}}
 
-{{- define "onyxia.ui.chart" -}}
-{{- printf "onyxia-ui" -}}
+{{- define "onyxia.web.chart" -}}
+{{- printf "onyxia-web" -}}
 {{- end -}}
 
 
@@ -79,9 +79,9 @@ app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end -}}
 
-{{- define "onyxia.ui.labels" -}}
-helm.sh/chart: {{ include "onyxia.ui.chart" . }}
-{{ include "onyxia.ui.selectorLabels" . }}
+{{- define "onyxia.web.labels" -}}
+helm.sh/chart: {{ include "onyxia.web.chart" . }}
+{{ include "onyxia.web.selectorLabels" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
@@ -100,8 +100,8 @@ app.kubernetes.io/name: {{ include "onyxia.api.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 
-{{- define "onyxia.ui.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "onyxia.ui.name" . }}
+{{- define "onyxia.web.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "onyxia.web.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 
@@ -115,9 +115,9 @@ app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 {{- end -}}
 
-{{- define "onyxia.ui.serviceAccountName" -}}
+{{- define "onyxia.web.serviceAccountName" -}}
 {{- if .Values.serviceAccount.create -}}
-    {{ default (include "onyxia.ui.fullname" .) .Values.serviceAccount.name }}
+    {{ default (include "onyxia.web.fullname" .) .Values.serviceAccount.name }}
 {{- else -}}
     {{ default "default" .Values.serviceAccount.name }}
 {{- end -}}

diff --git a/charts/onyxia/templates/deployment-api.yaml b/charts/onyxia/templates/deployment-api.yaml
@@ -34,7 +34,7 @@ spec:
         - name: {{ .Chart.Name }}
           securityContext:
             {{- toYaml .Values.api.securityContext | nindent 12 }}
-          image: "{{ .Values.api.image.name }}:{{ .Values.api.image.version }}"
+          image: "{{ .Values.api.image.repository }}:{{ .Values.api.image.tag }}"
           envFrom:
             - configMapRef:
                 name: {{ template "onyxia.fullname" . }}

diff --git a/charts/onyxia/templates/deployment-ui.yaml b/charts/onyxia/templates/deployment-ui.yaml
diff --git a/charts/onyxia/templates/deployment-web.yaml b/charts/onyxia/templates/deployment-web.yaml
@@ -0,0 +1,71 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "onyxia.web.fullname" . }}
+  labels:
+    {{- include "onyxia.web.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.web.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "onyxia.web.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      labels:
+        {{- include "onyxia.web.selectorLabels" . | nindent 8 }}
+{{- with .Values.web.podLabels }}
+{{ toYaml . | indent 8 }}
+{{- end }}
+    spec:
+    {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      serviceAccountName: {{ include "onyxia.web.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.web.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.web.securityContext | nindent 12 }}
+          image: "{{ .Values.web.image.repository }}:{{ .Values.web.image.tag }}"
+          imagePullPolicy: {{ .Values.web.image.pullPolicy }}
+          env:
+           {{- if .Values.web.env }}
+            {{- range $key, $value := .Values.web.env }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+            {{- end -}}
+            {{- end }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.web.containerPort }}
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.web.resources | nindent 12 }}
+          {{- if .Values.web.extraVolumeMounts }}
+          volumeMounts: {{- toYaml .Values.web.extraVolumeMounts | nindent 12 }}
+          {{- end }}
+      {{- with .Values.web.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- with .Values.web.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+    {{- with .Values.web.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+    {{- if .Values.web.extraVolumes }}
+      volumes: {{- toYaml .Values.web.extraVolumes | nindent 6 }}
+    {{- end }}
diff --git a/charts/onyxia/templates/ingress.yaml b/charts/onyxia/templates/ingress.yaml
@@ -1,9 +1,9 @@
 {{- if .Values.ingress.enabled -}}
 {{- $fullNameApi := include "onyxia.api.fullname" . -}}
-{{- $fullNameUi := include "onyxia.ui.fullname" . -}}
+{{- $fullNameWeb := include "onyxia.web.fullname" . -}}
 {{- $fullName := include "onyxia.fullname" . -}}
 {{- $svcPortApi := .Values.api.service.port -}}
-{{- $svcPortUi := .Values.ui.service.port -}}
+{{- $svcPortWeb := .Values.web.service.port -}}
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -45,8 +45,8 @@ spec:
             pathType: Prefix
             backend:
               service:
-                name: {{ $fullNameUi }}
+                name: {{ $fullNameWeb }}
                 port:
-                  number: {{ $svcPortUi }}
+                  number: {{ $svcPortWeb }}
     {{- end }}
 {{- end }}
diff --git a/charts/onyxia/templates/route-ui.yaml → charts/onyxia/templates/route-web.yaml b/charts/onyxia/templates/route-ui.yaml → charts/onyxia/templates/route-web.yaml
@@ -1,10 +1,10 @@
 {{- if .Values.route.enabled -}}
-{{- $fullNameUi := include "onyxia.ui.fullname" . -}}
+{{- $fullNameWeb := include "onyxia.web.fullname" . -}}
 {{- $fullName := include "onyxia.fullname" . -}}
 apiVersion: route.openshift.io/v1
 kind: Route
 metadata:
-  name: {{ $fullName }}-ui
+  name: {{ $fullName }}-web
   labels:
     {{- include "onyxia.labels" . | nindent 4 }}
   annotations:
@@ -16,7 +16,7 @@ spec:
   path: /
   to:
     kind: Service
-    name: {{ $fullNameUi }}
+    name: {{ $fullNameWeb }}
   tls:
     termination: {{ .Values.route.tls.termination }}
     {{- if .Values.route.tls.key }}

diff --git a/charts/onyxia/templates/service-ui.yaml b/charts/onyxia/templates/service-ui.yaml
diff --git a/charts/onyxia/templates/service-web.yaml b/charts/onyxia/templates/service-web.yaml
@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "onyxia.web.fullname" . }}
+  labels:
+    {{- include "onyxia.web.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.web.service.type }}
+  ports:
+    - port: {{ .Values.web.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "onyxia.web.selectorLabels" . | nindent 4 }}
diff --git a/...s/onyxia/templates/serviceaccount-ui.yaml → .../onyxia/templates/serviceaccount-web.yaml b/...s/onyxia/templates/serviceaccount-ui.yaml → .../onyxia/templates/serviceaccount-web.yaml
@@ -2,9 +2,9 @@
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: {{ include "onyxia.ui.serviceAccountName" . }}
+  name: {{ include "onyxia.web.serviceAccountName" . }}
   labels:
-    {{- include "onyxia.ui.labels" . | nindent 4 }}
+    {{- include "onyxia.web.labels" . | nindent 4 }}
   {{- with .Values.serviceAccount.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}

diff --git a/charts/onyxia/templates/tests/test-connection-ihm.yaml b/charts/onyxia/templates/tests/test-connection-ihm.yaml
@@ -1,15 +1,15 @@
 apiVersion: v1
 kind: Pod
 metadata:
-  name: "{{ include "onyxia.ui.fullname" . }}-test-connection"
+  name: "{{ include "onyxia.web.fullname" . }}-test-connection"
   labels:
-    {{- include "onyxia.ui.labels" . | nindent 4 }}
+    {{- include "onyxia.web.labels" . | nindent 4 }}
   annotations:
     "helm.sh/hook": test-success
 spec:
   containers:
     - name: wget
       image: busybox
       command: ['wget']
-      args: ['{{ include "onyxia.ui.fullname" . }}:{{ .Values.ui.service.port }}']
+      args: ['{{ include "onyxia.web.fullname" . }}:{{ .Values.web.service.port }}']
   restartPolicy: Never
diff --git a/charts/onyxia/values.yaml b/charts/onyxia/values.yaml
@@ -44,12 +44,12 @@ route:
     # destinationCACertificate:
   wildcardPolicy: None
 
-ui:
-  name: ui
+web:
+  name: web
   replicaCount: 1
   image:
-    name: inseefrlab/onyxia-web
-    version: 2.13.53
+    repository: inseefrlab/onyxia-web
+    tag: 2.28.0
     pullPolicy: IfNotPresent
   podLabels: {}
   podSecurityContext:
@@ -90,8 +90,8 @@ api:
   name: api
   replicaCount: 1
   image:
-    name: inseefrlab/onyxia-api
-    version: v0.27
+    repository: inseefrlab/onyxia-api
+    tag: v0.29
     pullPolicy: IfNotPresent
   contextPath: /api
   podLabels: {}