From 3c057fcc0a7f0f79b322aaeaa8796f1d2c3ef64f Mon Sep 17 00:00:00 2001 From: Valentin Haudiquet Date: Mon, 11 May 2026 23:02:28 +0200 Subject: [PATCH] Add Helm chart --- .gitea/workflows/pipeline.yml | 39 ++++++++ chart/.helmignore | 28 ++++++ chart/Chart.yaml | 14 +++ chart/templates/NOTES.txt | 29 ++++++ chart/templates/_helpers.tpl | 62 ++++++++++++ chart/templates/deployment.yaml | 79 +++++++++++++++ chart/templates/ingress.yaml | 41 ++++++++ chart/templates/persistentvolume.yaml | 18 ++++ chart/templates/persistentvolumeclaim.yaml | 15 +++ chart/templates/service.yaml | 15 +++ chart/values.yaml | 106 +++++++++++++++++++++ 11 files changed, 446 insertions(+) create mode 100644 chart/.helmignore create mode 100644 chart/Chart.yaml create mode 100644 chart/templates/NOTES.txt create mode 100644 chart/templates/_helpers.tpl create mode 100644 chart/templates/deployment.yaml create mode 100644 chart/templates/ingress.yaml create mode 100644 chart/templates/persistentvolume.yaml create mode 100644 chart/templates/persistentvolumeclaim.yaml create mode 100644 chart/templates/service.yaml create mode 100644 chart/values.yaml diff --git a/.gitea/workflows/pipeline.yml b/.gitea/workflows/pipeline.yml index 721f9bc..84b408c 100644 --- a/.gitea/workflows/pipeline.yml +++ b/.gitea/workflows/pipeline.yml @@ -29,3 +29,42 @@ jobs: tags: | git.vhaudiquet.fr/vhaudiquet/vhaudiquet.fr:latest git.vhaudiquet.fr/vhaudiquet/vhaudiquet.fr:${{ github.sha }} + + lint-and-publish-chart: + runs-on: ubuntu-latest + needs: build-and-push-images + steps: + - name: Checkout repository + uses: https://gitea.com/actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install Helm + uses: azure/setup-helm@v5 + + - name: Update Chart version and appVersion + run: | + # Get base chart version from Chart.yaml + BASE_VERSION=$(grep '^version:' chart/Chart.yaml | awk '{print $2}') + # Use timestamp for ordered versions (e.g., 0.1.0-20240511.130400) + TIMESTAMP=$(date -u +"%Y%m%d.%H%M%S") + CHART_VERSION="${BASE_VERSION}-${TIMESTAMP}" + + # Update both version and appVersion + sed -i "s/^version:.*/version: \"${CHART_VERSION}\"/" chart/Chart.yaml + sed -i "s/^appVersion:.*/appVersion: \"${{ github.sha }}\"/" chart/Chart.yaml + + echo "chart_version=${CHART_VERSION}" >> $GITHUB_ENV + + - name: Lint Helm chart + run: helm lint chart/ + + - name: Package Helm chart + run: helm package chart/ + + - name: Push Helm chart to Gitea registry + run: | + curl --user ${{ github.actor }}:${{ secrets.PACKAGES_TOKEN }} \ + -X POST \ + --upload-file vhaudiquet-fr-*.tgz \ + https://git.vhaudiquet.fr/api/packages/${{ github.actor }}/helm/api/charts diff --git a/chart/.helmignore b/chart/.helmignore new file mode 100644 index 0000000..70eba6a --- /dev/null +++ b/chart/.helmignore @@ -0,0 +1,28 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. + +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ + +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ + +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ + +# Plans directory +plans/ diff --git a/chart/Chart.yaml b/chart/Chart.yaml new file mode 100644 index 0000000..cda51bd --- /dev/null +++ b/chart/Chart.yaml @@ -0,0 +1,14 @@ +apiVersion: v2 +name: vhaudiquet-fr +description: A Helm chart for deploying vhaudiquet.fr personal website + +# A chart can be either an 'application' or a 'library' chart. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates. +version: 0.1.0 + +# The appVersion is automatically updated by CI to the git commit SHA. +# Do not manually update this value - it will be overwritten during the build process. +appVersion: "" diff --git a/chart/templates/NOTES.txt b/chart/templates/NOTES.txt new file mode 100644 index 0000000..7a96bd6 --- /dev/null +++ b/chart/templates/NOTES.txt @@ -0,0 +1,29 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "vhaudiquet-fr.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "vhaudiquet-fr.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "vhaudiquet-fr.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "vhaudiquet-fr.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} + +{{- if .Values.nfs.enabled }} +2. NFS Storage Configuration: + The chart has created an NFS-based PersistentVolume and PersistentVolumeClaim. + Make sure your NFS server ({{ .Values.nfs.server }}) is accessible from the cluster + and the export path ({{ .Values.nfs.path }}) exists. +{{- end }} diff --git a/chart/templates/_helpers.tpl b/chart/templates/_helpers.tpl new file mode 100644 index 0000000..3ae1076 --- /dev/null +++ b/chart/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "vhaudiquet-fr.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 "vhaudiquet-fr.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 "vhaudiquet-fr.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "vhaudiquet-fr.labels" -}} +helm.sh/chart: {{ include "vhaudiquet-fr.chart" . }} +{{ include "vhaudiquet-fr.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "vhaudiquet-fr.selectorLabels" -}} +app.kubernetes.io/name: {{ include "vhaudiquet-fr.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "vhaudiquet-fr.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "vhaudiquet-fr.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/chart/templates/deployment.yaml b/chart/templates/deployment.yaml new file mode 100644 index 0000000..0a787c5 --- /dev/null +++ b/chart/templates/deployment.yaml @@ -0,0 +1,79 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "vhaudiquet-fr.fullname" . }} + labels: + {{- include "vhaudiquet-fr.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "vhaudiquet-fr.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "vhaudiquet-fr.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "vhaudiquet-fr.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + env: + {{- range $key, $value := .Values.env }} + - name: {{ $key }} + value: {{ $value | quote }} + {{- end }} + ports: + - name: http + containerPort: 80 + protocol: TCP + livenessProbe: + httpGet: + path: / + port: http + initialDelaySeconds: 10 + periodSeconds: 10 + readinessProbe: + httpGet: + path: / + port: http + initialDelaySeconds: 5 + periodSeconds: 10 + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- if .Values.nfs.enabled }} + volumeMounts: + - name: public-files + mountPath: {{ .Values.nfs.mountPath }} + {{- end }} + {{- if .Values.nfs.enabled }} + volumes: + - name: public-files + persistentVolumeClaim: + claimName: {{ include "vhaudiquet-fr.fullname" . }}-public + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/chart/templates/ingress.yaml b/chart/templates/ingress.yaml new file mode 100644 index 0000000..0674b08 --- /dev/null +++ b/chart/templates/ingress.yaml @@ -0,0 +1,41 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "vhaudiquet-fr.fullname" . }} + labels: + {{- include "vhaudiquet-fr.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if .Values.ingress.className }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + pathType: {{ .pathType }} + backend: + service: + name: {{ include "vhaudiquet-fr.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/chart/templates/persistentvolume.yaml b/chart/templates/persistentvolume.yaml new file mode 100644 index 0000000..7d67172 --- /dev/null +++ b/chart/templates/persistentvolume.yaml @@ -0,0 +1,18 @@ +{{- if .Values.nfs.enabled -}} +apiVersion: v1 +kind: PersistentVolume +metadata: + name: {{ include "vhaudiquet-fr.fullname" . }}-public + labels: + {{- include "vhaudiquet-fr.labels" . | nindent 4 }} +spec: + capacity: + storage: {{ .Values.nfs.storageSize }} + accessModes: + - ReadOnlyMany + persistentVolumeReclaimPolicy: Retain + storageClassName: {{ .Values.nfs.storageClassName | default (printf "%s-nfs" (include "vhaudiquet-fr.fullname" .)) }} + nfs: + server: {{ .Values.nfs.server | required "nfs.server is required when nfs.enabled is true" }} + path: {{ .Values.nfs.path }} +{{- end }} diff --git a/chart/templates/persistentvolumeclaim.yaml b/chart/templates/persistentvolumeclaim.yaml new file mode 100644 index 0000000..861bb53 --- /dev/null +++ b/chart/templates/persistentvolumeclaim.yaml @@ -0,0 +1,15 @@ +{{- if .Values.nfs.enabled -}} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ include "vhaudiquet-fr.fullname" . }}-public + labels: + {{- include "vhaudiquet-fr.labels" . | nindent 4 }} +spec: + accessModes: + - ReadOnlyMany + storageClassName: {{ .Values.nfs.storageClassName | default (printf "%s-nfs" (include "vhaudiquet-fr.fullname" .)) }} + resources: + requests: + storage: {{ .Values.nfs.storageSize }} +{{- end }} diff --git a/chart/templates/service.yaml b/chart/templates/service.yaml new file mode 100644 index 0000000..0f8f541 --- /dev/null +++ b/chart/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "vhaudiquet-fr.fullname" . }} + labels: + {{- include "vhaudiquet-fr.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "vhaudiquet-fr.selectorLabels" . | nindent 4 }} diff --git a/chart/values.yaml b/chart/values.yaml new file mode 100644 index 0000000..2e56ae7 --- /dev/null +++ b/chart/values.yaml @@ -0,0 +1,106 @@ +# Default values for vhaudiquet-fr. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# Number of replicas +replicaCount: 1 + +# Container image configuration +image: + repository: git.vhaudiquet.fr/vhaudiquet/vhaudiquet.fr + pullPolicy: IfNotPresent + # The image tag defaults to the chart appVersion (which is set to git SHA by CI). + # Override this only if you need a specific version. + tag: "" + +# Image pull secrets for private registries +imagePullSecrets: [] + +# Override the name of the chart +nameOverride: "" +fullnameOverride: "" + +# Service account configuration +serviceAccount: + # Specifies whether a service account should be created + create: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# Pod annotations +podAnnotations: {} + +# Pod security context +podSecurityContext: {} + # fsGroup: 2000 + +# Container security context +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# Service configuration +service: + type: ClusterIP + port: 80 + +# Ingress configuration +ingress: + enabled: true + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: vhaudiquet.fr + paths: + - path: / + pathType: Prefix + tls: [] + # - secretName: vhaudiquet-fr-tls + # hosts: + # - vhaudiquet.fr + +# Resource limits and requests +resources: {} + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +# Node selector +nodeSelector: {} + +# Tolerations +tolerations: [] + +# Affinity +affinity: {} + +# Environment variables +env: + NGINX_HOST: vhaudiquet.fr + NGINX_PORT: "80" + +# NFS Storage configuration for public files +nfs: + enabled: true + # NFS server IP address - REQUIRED when enabled + server: "" + # NFS export path + path: /mnt/main_storage/public + # Mount path inside the container + mountPath: /usr/share/nginx/html/public + # Storage size for PVC + storageSize: 10Gi + # Storage class name (leave empty for default) + storageClassName: ""