[ADD] persistence, improve gh actions

Author: alexnuttinck

.github/workflows/release.yaml

@@ -5,12 +5,18 @@ on:
   push:
     branches:
       - main
+  workflow_run:
+    workflows:
+      - Lint and Test Charts
+    types:
+      - completed
 
 jobs:
   release:
     permissions:
       contents: write
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3

Chart.yaml

@@ -1,27 +1,18 @@
 apiVersion: v2
 name: smtp4dev
 description: A Helm chart for helm-smtp4dev
-icon: https://raw.githubusercontent.com/rnwood/smtp4dev/master/logo.svg
-maintainers:
-  - name: iMio
-    url: https://imio.github.io/helm-charts/
-# 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.0.1
-
-# 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.
+version: 0.0.2
 appVersion: "3.1.4"
+keywords:
+  - smtp4dev
+  - fake smtp email server
+  - development
+sources:
+  - https://github.com/imio/helm-charts
+  - https://github.com/imio/helm-smtp4dev
+  - https://github.com/rnwood/smtp4dev
+icon: https://raw.githubusercontent.com/rnwood/smtp4dev/master/logo.svg
+maintainers:
+  - name: IMIO
+    url: https://github.com/IMIO/

README.md

@@ -1 +1,58 @@
 # Helm Chart for smtp4dev
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![version](https://img.shields.io/github/tag/IMIO/helm-smtp4dev.svg?label=release) ![test](https://github.com/IMIO/helm-smtp4dev/actions/workflows/test.yaml/badge.svg) ![release](https://github.com/IMIO/helm-smtp4dev/actions/workflows/release.yaml/badge.svg)
+
+## Introduction
+
+This [Helm](https://helm.sh/) chart installs [smtp4dev](https://github.com/rnwood/smtp4dev) in a [Kubernetes](https://kubernetes.io) cluster.
+
+## Prerequisites
+
+- Kubernetes cluster 1.19+
+- Helm 3.0.0+
+- PV provisioner support in the underlying infrastructure (Optional)
+
+## Installation
+
+### Add Helm repository
+
+```bash
+helm repo add imio https://imio.github.io/helm-charts
+helm repo update
+```
+
+### Configure the chart
+
+The following items can be set via `--set` flag during installation or configured by editing the `values.yaml` directly (need to download the chart first).
+
+Feel free to modify the options in the [values.yaml file](values.yaml) before installation.
+
+### Install the chart
+
+```bash
+helm install [RELEASE_NAME] imio/smtp4dev
+```
+
+or by cloning this repository:
+
+```bash
+git clone https://github.com/imio/helm-smtp4dev.git
+cd helm-smtp4dev
+helm install smtp4dev . -f values.yaml --namespace smtp4dev --create-namespace
+```
+
+## Configuration
+
+The following table lists the configurable parameters of the smtp4dev chart and the default values.
+
+See the [values.yaml](values.yaml) file for more information.
+
+## Contributing
+
+Feel free to contribute by making a [pull request](https://github.com/imio/helm-smtp4dev/pull/new/master).
+
+Please read the official [Helm Contribution Guide](https://github.com/helm/charts/blob/master/CONTRIBUTING.md) from Helm for more information on how you can contribute to this Chart.
+
+## License
+
+[Apache License 2.0](/LICENSE)

templates/deployment.yaml

@@ -86,15 +86,19 @@ spec:
               path: /
               port: http
           resources:
-            {{- toYaml .Values.resources | nindent 12 }}
-          {{- with .Values.volumeMounts }}
+            {{- toYaml .Values.resources | nindent 12 }}          
           volumeMounts:
-            {{- toYaml . | nindent 12 }}
-          {{- end }}
-      {{- with .Values.volumes }}
+          - name: smtp4dev
+            mountPath: /smtp4dev
+            readOnly: false
       volumes:
-        {{- toYaml . | nindent 8 }}
-      {{- end }}
+        - name: smtp4dev
+        {{- if .Values.persistence.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.persistence.existingClaim | default (include "helm-smtp4dev.fullname" .) }} 
+        {{- else }}
+          emptyDir: {}
+        {{- end }}
       {{- with .Values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}

templates/pvc.yaml

@@ -0,0 +1,15 @@
+{{- if .Values.persistence.enabled }}
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: {{ include "helm-smtp4dev.fullname" . }}
+spec:
+  accessModes:
+  {{- range .Values.persistence.accessModes }}
+    - {{ . | quote }}
+  {{- end }}
+  storageClassName: {{ .Values.persistence.storageClass | quote }}
+  resources:
+    requests:
+      storage: {{ .Values.persistence.size | quote }}
+{{- end -}}

values.yaml

@@ -10,6 +10,7 @@ image:
   # Overrides the image tag whose default is the chart appVersion.
   tag: "v3"
 
+# smtp4dev configuration (env variables)
 smtp4dev:
   ServerOptions__BasePath: /smtp4dev
   ServerOptions__Hostname: smtp4dev
@@ -76,6 +77,24 @@ ingress:
   #    hosts:
   #      - chart-example.local
 
+# persistence
+persistence:
+  enabled: true
+  # A manually managed Persistent Volume and Claim
+  # Requires persistence.enabled: true
+  # If defined, PVC must be created manually before volume will be bound
+  existingClaim: ""
+  # smtp4dev data Persistent Volume Storage Class
+  # If defined, storageClassName: <storageClass>
+  # If set to "-", storageClassName: "", which disables dynamic provisioning
+  # If undefined (the default) or set to null, no storageClassName spec is
+  #   set, choosing the default provisioner.  (gp2 on AWS, standard on
+  #   GKE, AWS & OpenStack)
+  storageClass: "standard"
+  accessModes:
+    - ReadWriteOnce
+  size: 1Gi
+
 resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little