feat: helm-chart

feat/helm-chart

.github/workflows/helm.yml

@@ -0,0 +1,37 @@
+name: Publish Helm Chart
+on:
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+    secrets:
+      GITHUB_TOKEN:
+        required: true
+
+jobs:
+  publish-helm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+
+      - name: Package Helm chart
+        run: |
+          mkdir -p ./helm-packages
+          helm package docker/helm \
+            --version ${{ inputs.version }} \
+            --app-version ${{ inputs.version }} \
+            --destination ./helm-packages
+
+      - name: Authenticate to GitHub Packages
+        run: |
+          echo "${{ secrets.GITHUB_TOKEN }}" | helm registry login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Push Helm chart to GitHub Packages (OCI)
+        run: |
+          helm push ./helm-packages/portabase-${{ inputs.version }}.tgz oci://ghcr.io/${{ github.repository }}/charts

.github/workflows/release.yml

@@ -6,7 +6,6 @@ on:
     branches:
       - main
 
-
 permissions:
   contents: write
   packages: write
@@ -73,10 +72,19 @@ jobs:
       DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME_2 }}
       DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD_2 }}
 
+  publish-helm:
+    needs: create-release
+    uses: ./.github/workflows/helm.yml
+    with:
+      version: ${{ needs.create-release.outputs.version }}
+    secrets:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   finalize-release:
     needs:
       - create-release
       - publish-docker
+      - publish-helm
     runs-on: ubuntu-latest
     outputs:
       release_tag: ${{ steps.publish_release_step.outputs.release_tag }}
@@ -98,6 +106,7 @@ jobs:
   notify-discord:
     needs:
       - publish-docker
+      - publish-helm
       - create-release
       - finalize-release
     uses: ./.github/workflows/discord.yml

docker/helm/.helmignore

@@ -0,0 +1,17 @@
+.DS_Store
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+.project
+.idea/
+*.tmproj
+.vscode/

docker/helm/Chart.yaml

@@ -0,0 +1,28 @@
+apiVersion: v2
+name: portabase
+description: Helm chart for Portabase
+type: application
+version: 0.0.0
+appVersion: "latest"
+keywords:
+  - postgresql
+  - mariadb
+  - mongodb
+  - mysql
+  - sqlite
+  - backup
+  - database
+  - restore
+home: https://github.com/Portabase/portabase
+
+sources:
+  - https://github.com/Portabase/portabase
+  - https://github.com/Portabase/portabase/tree/main/docker/helm
+
+maintainers:
+  - name: Charles Gauthereau
+    url: https://github.com/RambokDev
+  - name: Killian Larcher
+    url: https://github.com/KillianLarcher
+
+icon: https://raw.githubusercontent.com/Portabase/portabase/main/.github/assets/logo.png

docker/helm/README.md

@@ -0,0 +1,32 @@
+# Development Notes
+
+## Check that Kubernetes is reachable locally
+
+```bash
+kubectl get nodes
+```
+
+## Install the local Portabase Helm chart
+
+```bash
+helm install portabase . \
+--set project.secret=$(openssl rand -hex 32)
+```
+
+## Check the pods
+
+```bash
+kubectl get pods
+```
+
+## Check the services
+
+```bash
+kubectl get svc
+```
+
+## If the service type is ClusterIP, expose it locally using port forwarding:
+
+```bash
+kubectl port-forward svc/portabase 8887:80
+```

docker/helm/templates/deployment.yaml

@@ -0,0 +1,33 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: portabase
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: portabase
+  template:
+    metadata:
+      labels:
+        app: portabase
+    spec:
+      containers:
+        - name: portabase
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+          ports:
+            - containerPort: 80
+          env:
+            - name: TZ
+              value: {{ .Values.timezone }}
+            - name: PROJECT_URL
+              value: {{ .Values.project.url }}
+            - name: PROJECT_SECRET
+              value: {{ .Values.project.secret }}
+          volumeMounts:
+            - name: data
+              mountPath: /data
+      volumes:
+        - name: data
+          persistentVolumeClaim:
+            claimName: portabase-data

docker/helm/templates/pvc.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: portabase-data
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: {{ .Values.persistence.size }}

docker/helm/templates/service.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: portabase
+spec:
+  type: {{ .Values.service.type }}
+  selector:
+    app: portabase
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: 80
+      nodePort: {{ .Values.service.nodePort }}

docker/helm/values.yaml

@@ -0,0 +1,47 @@
+image:
+  repository: portabase/portabase
+  tag: latest
+  pullPolicy: Always
+
+replicaCount: 1
+
+service:
+  type: ClusterIP
+  port: 80
+  targetPort: 80
+
+resources:
+  requests:
+    memory: "1Gi"
+    cpu: "1"
+  limits:
+    memory: "1Gi"
+    cpu: "1"
+
+timezone: Europe/Paris
+
+project:
+  url: http://localhost:8887
+  secret: "change_me_generate_secure_secret"
+
+persistence:
+  enabled: true
+  storageClassName: ""
+  accessMode: ReadWriteOnce
+  size: 10Gi
+  mountPath: /data
+
+ingress:
+  enabled: false
+  className: nginx
+  hosts:
+    - host: portabase.example.com
+      paths:
+        - path: /
+          pathType: Prefix
+  tls: []
+
+updateStrategy:
+  type: RollingUpdate
+  rollingUpdate:
+    partition: 0