helpers

docs/kubernetes/06_my_first_helm.md

@@ -161,7 +161,7 @@ Modifions le metadata du chart :
 
 ```yaml title="Chart.yaml"
 apiVersion: v2
-name: jupyter-chart
+name: jupyter
 description: My first helm chart for Jupyter
 
 # A chart can be either an 'application' or a 'library' chart.
@@ -214,8 +214,8 @@ TEST SUITE: None
 ```bash {.no-copy}
 helm ls
 
-NAME      	NAMESPACE	REVISION	UPDATED                                	STATUS  	CHART              	APP VERSION
-my-jupyter	tuto     	1       	2025-03-12 19:38:02.264727617 +0100 CET	deployed	jupyter-chart-0.1.0	4.0.7     
+NAME      	NAMESPACE	REVISION	UPDATED                                	STATUS  	CHART             APP VERSION
+my-jupyter	tuto     	1       	2025-03-12 19:38:02.264727617 +0100 CET	deployed	jupyter-0.1.0	    4.0.7     
 ```
 
 Le chart a ce stade est disponible [ici](https://gitlab.in2p3.fr/si-apc/tp-kubernetes-si/-/tree/main/files/charts/step0/jupyter-chart).
@@ -336,9 +336,9 @@ helm history my-jupyter
 ```
 
 ```{.console .no-copy}
-REVISION        UPDATED                         STATUS          CHART                   APP VERSION     DESCRIPTION     
-1               Wed Mar 12 23:16:04 2025        superseded      jupyter-chart-0.1.0     4.0.7           Install complete
-2               Wed Mar 12 23:16:11 2025        deployed        jupyter-chart-0.1.0     4.0.7           Upgrade complete
+REVISION        UPDATED                         STATUS          CHART             APP VERSION     DESCRIPTION     
+1               Wed Mar 12 23:16:04 2025        superseded      jupyter-0.1.0     4.0.7           Install complete
+2               Wed Mar 12 23:16:11 2025        deployed        jupyter-0.1.0     4.0.7           Upgrade complete
 ```
 
 
@@ -621,3 +621,79 @@ spec:
 
 Le chart de référence à ce stade [est disponible](https://gitlab.in2p3.fr/si-apc/tp-kubernetes-si/-/tree/main/files/charts/step3)
 
+### Helpers
+
+Le fichier `_helpers.yaml` contient des définitions utilitaires. Nous allons les utiliser pour que les noms des ressources correspondent au nom du release Helm (il est fixé par instant) et pour remplacer des étiquettes de `kompose`. 
+
+Nous avons besoin d'ajouter quelques valeurs par défaut qui sont utilisées dans `_helpers.tpl` :
+
+```yaml title="jupyter-chart/values.yaml"
+nameOverride: ""
+fullnameOverride: ""
+serviceAccount:
+  create: false
+```
+
+En déploiement (diff) :
+
+```diff title="diff -u step[34]/jupyter-chart/templates/deployment.yaml"
+--- step3/jupyter-chart/templates/deployment.yaml	2025-03-25 18:13:11.522701853 +0100
++++ step4/jupyter-chart/templates/deployment.yaml	2025-03-25 18:31:24.339726299 +0100
+@@ -1,14 +1,14 @@
+ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
++  name: {{ include "jupyter-chart.fullname" . }}
+   labels:
+-    io.kompose.service: jupyter
+-  name: jupyter
++    {{- include "jupyter-chart.labels" . | nindent 4 }}
+ spec:
+   replicas: {{ .Values.replicaCount }}
+   selector:
+     matchLabels:
+-      io.kompose.service: jupyter
++      {{- include "jupyter-chart.selectorLabels" . | nindent 6 }}
+   strategy:
+     type: {{ .Values.strategy }}
+   template:
+@@ -16,7 +16,7 @@
+       annotations:
+         checksum/config: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
+       labels:
+-        io.kompose.service: jupyter
++        {{- include "jupyter-chart.labels" . | nindent 8 }}
+     spec:
+       containers:
+         - image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
+@@ -67,20 +67,21 @@
+             - name: JUPYTER_PWD
+               valueFrom:
+                 secretKeyRef:
+-                  name: jupyter-pwd
++                  name: {{ include "jupyter-chart.fullname" . }}-pwd
+                   key: password
+       restartPolicy: Always
+       volumes:
+         {{- if .Values.storage | default false }}
++        {{ $basename := include "jupyter-chart.fullname" . }}
+         {{- range $index, $volume := .Values.storage }}
+         - name: jupyter-claim{{ $index }}
+           persistentVolumeClaim:
+-            claimName: jupyter-claim{{ $index }}
++            claimName: {{ $basename }}-claim{{ $index }}
+         {{- end -}}
+         {{- end }}
+         - name: initscript
+           configMap:
+-            name: initscript
++            name: {{ include "jupyter-chart.fullname" . }}-initscript
+         - name: jupyter-confdir
+           emptyDir: {}
+```
+
+!!! info
+    Notez l'utilisation de variable `$basename`. Dans la boucle, le contexte change alors la variable `.Values` n'est plus disponible (et cela est utilisé par modèle `jupyter-chart.fullname`).
+
+??? question
+    Appliquez les mêmes changements aux autres manifests. Vous pouvez suivre ceux créés par la commande `helm create <name>` ou consulter le chart dans le [repositoire](https://gitlab.in2p3.fr/si-apc/tp-kubernetes-si/-/tree/main/files/charts/step4).
\ No newline at end of file

files/charts/step0/jupyter-chart/Chart.yaml

 apiVersion: v2
-name: jupyter-chart
+name: jupyter
 description: A Helm chart for Kubernetes
 
 # A chart can be either an 'application' or a 'library' chart.

files/charts/step1/jupyter-chart/Chart.yaml

 apiVersion: v2
-name: jupyter-chart
+name: jupyter
 description: A Helm chart for Kubernetes
 
 # A chart can be either an 'application' or a 'library' chart.

files/charts/step1/jupyter-chart/templates/deployment.yaml

@@ -46,7 +46,7 @@ spec:
             - name: jupyter-confdir
               mountPath: /home/jovyan/.jupyter
       initContainers:
-        - image: jupyter/base-notebook
+        - image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
           name: pwd-init
           command: 
             - python 

files/charts/step2/jupyter-chart/Chart.yaml

 apiVersion: v2
-name: jupyter-chart
+name: jupyter
 description: A Helm chart for Kubernetes
 
 # A chart can be either an 'application' or a 'library' chart.

files/charts/step2/jupyter-chart/templates/deployment.yaml

@@ -50,7 +50,7 @@ spec:
             - name: jupyter-confdir
               mountPath: /home/jovyan/.jupyter
       initContainers:
-        - image: jupyter/base-notebook
+        - image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
           name: pwd-init
           command: 
             - python 

files/charts/step3/jupyter-chart/Chart.yaml

 apiVersion: v2
-name: jupyter-chart
+name: jupyter
 description: A Helm chart for Kubernetes
 
 # A chart can be either an 'application' or a 'library' chart.

files/charts/step3/jupyter-chart/templates/deployment.yaml

@@ -52,7 +52,7 @@ spec:
             - name: jupyter-confdir
               mountPath: /home/jovyan/.jupyter
       initContainers:
-        - image: jupyter/base-notebook
+        - image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
           name: pwd-init
           command: 
             - python 

files/charts/step4/jupyter-chart/Chart.yaml

+apiVersion: v2
+name: jupyter
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+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.1.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. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "4.0.7"

files/charts/step4/jupyter-chart/templates/_helpers.tpl

+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "jupyter-chart.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "jupyter-chart.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "jupyter-chart.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "jupyter-chart.labels" -}}
+helm.sh/chart: {{ include "jupyter-chart.chart" . }}
+{{ include "jupyter-chart.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "jupyter-chart.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "jupyter-chart.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "jupyter-chart.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "jupyter-chart.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

files/charts/step4/jupyter-chart/templates/configmap.yaml

+apiVersion: v1
+data:
+  initpwd.py: |
+    #!/usr/bin/env python
+
+    from jupyter_server.auth import passwd
+    import os
+    import json
+
+    if os.getenv('JUPYTER_PWD') is not None:
+        pwd = passwd(os.getenv('JUPYTER_PWD'))
+
+
+        cfg_dir = os.path.join(os.getenv('HOME'), '.jupyter')
+        os.makedirs(cfg_dir, exist_ok=True)
+        cfg_json = os.path.join(cfg_dir, 'jupyter_server_config.json')
+
+        with open(cfg_json, 'w') as fd:
+            json.dump({"IdentityProvider": {"hashed_password": pwd}}, fd)
+    else:
+        print("JUPYTER_PWD environment variable is not set.")
+kind: ConfigMap
+metadata:
+  creationTimestamp: null
+  name: {{ include "jupyter-chart.fullname" . }}-initscript

files/charts/step4/jupyter-chart/templates/deployment.yaml

+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "jupyter-chart.fullname" . }}
+  labels:
+    {{- include "jupyter-chart.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "jupyter-chart.selectorLabels" . | nindent 6 }}
+  strategy:
+    type: {{ .Values.strategy }}
+  template:
+    metadata:
+      annotations:
+        checksum/config: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
+      labels:
+        {{- include "jupyter-chart.labels" . | nindent 8 }}
+    spec:
+      containers:
+        - image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
+          name: jupyter
+          resources:
+            requests:
+              cpu: {{ .Values.resources.requests.cpu }}
+              memory: {{ .Values.resources.requests.memory }}
+            limits:
+              cpu: {{ .Values.resources.limits.cpu }}
+              memory: {{ .Values.resources.limits.memory }}
+          ports:
+            - containerPort: 8888
+              protocol: TCP
+          env:
+            - name: JUPYTER_PORT
+              value: "8888"
+          livenessProbe:
+            exec:
+              command:
+              - /etc/jupyter/docker_healthcheck.py
+            initialDelaySeconds: 5
+            timeoutSeconds: 1
+            periodSeconds: 10
+            failureThreshold: 3
+          volumeMounts:
+            {{- if .Values.storage | default false -}}
+            {{- range $index, $volume := .Values.storage }}
+            - mountPath: {{ $volume.mountPath }}
+              name: jupyter-claim{{ $index }}
+            {{- end -}}
+            {{- end }}
+            - name: jupyter-confdir
+              mountPath: /home/jovyan/.jupyter
+      initContainers:
+        - image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
+          name: pwd-init
+          command: 
+            - python 
+            - /initpwd.py
+          volumeMounts:
+            - name: initscript
+              mountPath: /initpwd.py
+              subPath: initpwd.py
+            - name: jupyter-confdir
+              mountPath: /home/jovyan/.jupyter
+          env:
+            - name: JUPYTER_PWD
+              valueFrom:
+                secretKeyRef:
+                  name: {{ include "jupyter-chart.fullname" . }}-pwd
+                  key: password
+      restartPolicy: Always
+      volumes:
+        {{- if .Values.storage | default false }}
+        {{ $basename := include "jupyter-chart.fullname" . }}
+        {{- range $index, $volume := .Values.storage }}
+        - name: jupyter-claim{{ $index }}
+          persistentVolumeClaim:
+            claimName: {{ $basename }}-claim{{ $index }}
+        {{- end -}}
+        {{- end }}
+        - name: initscript
+          configMap:
+            name: {{ include "jupyter-chart.fullname" . }}-initscript
+        - name: jupyter-confdir
+          emptyDir: {}
+
+

files/charts/step4/jupyter-chart/templates/ingress.yaml

+{{ if .Values.ingress.enabled | default false -}}
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: {{ include "jupyter-chart.fullname" . }}
+  annotations:
+    ingress.kubernetes.io/ssl-redirect: "false"
+spec:
+  rules:
+  - http:
+      paths:
+      - path: /
+        pathType: Prefix
+        backend:
+          service:
+            name: {{ include "jupyter-chart.fullname" . }}
+            port:
+              number: {{ .Values.service.externalPort }}
+{{ end }}
\ No newline at end of file

files/charts/step4/jupyter-chart/templates/pvc.yaml

+{{- if .Values.storage | default false -}}
+{{ $basename := include "jupyter-chart.fullname" .}}
+{{ range $index, $volume := .Values.storage -}}
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ $basename }}-claim{{ $index }}
+spec:
+  storageClassName: {{ $volume.storageClass }}
+  accessModes:
+    - {{ $volume.accessMode }}
+  resources:
+    requests:
+      storage: {{ $volume.size }}
+{{ end }}
+{{ end }}
\ No newline at end of file

files/charts/step4/jupyter-chart/templates/secret.yaml

+apiVersion: v1
+data:
+  password: {{ .Values.auth.password | b64enc }}
+kind: Secret
+metadata:
+  creationTimestamp: null
+  name: {{ include "jupyter-chart.fullname" . }}-pwd

files/charts/step4/jupyter-chart/templates/service.yaml

+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    {{- include "jupyter-chart.labels" . | nindent 4 }}
+  name: {{ include "jupyter-chart.fullname" . }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - name: jupyterlab
+      port: {{ .Values.service.externalPort }}
+      targetPort: 8888
+  selector:
+    {{- include "jupyter-chart.selectorLabels" . | nindent 4 }}

files/charts/step4/jupyter-chart/values.yaml

+nameOverride: ""
+fullnameOverride: ""
+serviceAccount:
+  create: false
+
+replicaCount: 1
+strategy: Recreate
+image:
+  repository: jupyter/base-notebook
+  tag: lab-4.0.7
+resources:
+  requests:
+    cpu: 500m
+    memory: 500Mi
+  limits:
+    cpu: "1"
+    memory: 1024Mi
+service:
+  type: ClusterIP
+  externalPort: 8888
+storage: []
+auth:
+  password: password
+ingress:
+  enabled: true
\ No newline at end of file

files/charts/step4/values.yaml

+resources:
+  limits:
+    cpu: "2"
+
+storage:
+- storageClass: local-path
+  accessMode: ReadWriteOnce
+  size: 100Mi
+  mountPath: /home/jovyan/work/volume100
+- storageClass: local-path
+  accessMode: ReadWriteOnce
+  size: 50Mi
+  mountPath: /home/jovyan/work/volume50
\ No newline at end of file