Mautic README

charts/mautic/Chart.yaml

@@ -1,8 +1,10 @@
 apiVersion: v2
-appVersion: "1.0"
+appVersion: "v4-apache"
 description: A Helm chart for Mautic, a marketing automation tool
 name: mautic
-version: 0.1.0
+version: 0.1.1
+icon: https://avatars.githubusercontent.com/u/5543677?s=400&v=4
+home: https://www.mautic.org/
 keywords:
   - marketing
   - mautic

charts/mautic/README.md

@@ -1,37 +1,60 @@
 # mautic
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square)
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square)
 
-A Helm chart for Kubernetes
+A Helm chart for Mautic, a marketing automation tool
 
-## TL;DR;
+**Homepage:** <https://www.mautic.org/>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Yann-J | <yann.jouanique@gmail.com> |  |
+
+## Source Code
+
+* <https://github.com/one-acre-fund/oaf-public-charts/tree/main/charts/mautic>
+
+## TL;DR
+
+[Mautic](https://www.mautic.org/) is an open-source marketing campaign automation tool.
 
 ```console
 $ helm repo add one-acre-fund https://one-acre-fund.github.io/oaf-public-charts
-$ helm install my-release one-acre-fund/kobotoolbox
+$ helm install my-release one-acre-fund/mautic
 ```
 
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.bitnami.com/bitnami | mariadb | ~11.4.6 |
+
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
-| extraEnvs | object | `{}` | See https://hub.docker.com/r/mautic/mautic |
+| extraEnvs | object | `{}` | Dictionary of env vars, see https://hub.docker.com/r/mautic/mautic for possible values |
+| extraSecretEnvs | object | `{}` | Same as `extraEnvs` but passed as a secret |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
 | image.repository | string | `"mautic/mautic"` |  |
 | image.tag | string | `"v4-apache"` |  |
 | imagePullSecrets | list | `[]` |  |
-| ingress.annotations."kubernetes.io/tls-acme" | string | `"true"` |  |
-| ingress.enabled | bool | `true` |  |
-| ingress.hosts[0].host | string | `"mautic.example.com"` |  |
-| ingress.hosts[0].paths[0] | string | `"/"` |  |
-| ingress.tls | list | `[]` |  |
-| mariadb.auth.database | string | `"mautic"` |  |
-| mariadb.enabled | bool | `true` |  |
+| ingress | object | see `values.yaml` | Ingress definition |
+| ingress.enabled | bool | `true` | Enable ingress? |
+| mariadb | object | see `values.yaml` | Mariadb subchart configuration, see https://artifacthub.io/packages/helm/bitnami/mariadb for docs |
+| mariadb.enabled | bool | `true` | Enable Mariadb chart? |
 | nodeSelector | object | `{}` |  |
-| replicaCount | int | `1` |  |
+| persistence.existingClaim | string | `""` |  |
+| probes | object | See `values.yaml` | Probes definitions |
+| replicaCount | int | `1` | __WARNING__: if using multiple nodes, you will need to use a ReadWriteMany storage class |
 | resources | object | `{}` |  |
 | service.port | int | `80` |  |
 | service.type | string | `"ClusterIP"` |  |
 | strategy.type | string | `"Recreate"` | Since we are mounting a volume, using Recreate to avoid double-mounting |
-| tolerations | list | `[]` |  |
+| tolerations | list | `[]` |  |
+| volume.enabled | bool | `true` |  |
+| volume.spec.accessModes[0] | string | `"ReadWriteOnce"` |  |
+| volume.spec.resources.requests.storage | string | `"1Gi"` |  |

charts/mautic/README.md.gotmpl

@@ -11,13 +11,15 @@
 
 {{ template "chart.sourcesSection" . }}
 
-## TL;DR;
+## TL;DR
+
+[Mautic](https://www.mautic.org/) is an open-source marketing campaign automation tool.
 
 ```console
 $ helm repo add one-acre-fund https://one-acre-fund.github.io/oaf-public-charts
-$ helm install my-release one-acre-fund/kobotoolbox
+$ helm install my-release one-acre-fund/mautic
 ```
 
 {{ template "chart.requirementsSection" . }}
 
-{{ template "chart.valuesSection" . }}
+{{ template "chart.valuesSection" . }}

charts/mautic/values.yaml

@@ -1,8 +1,4 @@
-# Default values for mautic.
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
-
-# -- WARNING: if using multiple nodes, you will need to use a ReadWriteMany storage class
+# -- __WARNING__: if using multiple nodes, you will need to use a ReadWriteMany storage class
 replicaCount: 1
 
 image:
@@ -16,7 +12,10 @@ service:
   type: ClusterIP
   port: 80
 
+# -- Ingress definition
+# @default -- see `values.yaml`
 ingress:
+  # -- Enable ingress?
   enabled: true
   annotations:
     # kubernetes.io/ingress.class: nginx
@@ -67,10 +66,12 @@ strategy:
   # -- Since we are mounting a volume, using Recreate to avoid double-mounting
   type: Recreate
 
-# -- See https://hub.docker.com/r/mautic/mautic
+# -- Dictionary of env vars, see https://hub.docker.com/r/mautic/mautic for possible values
 extraEnvs: {}
-# -- See https://hub.docker.com/r/mautic/mautic
+
+# -- Same as `extraEnvs` but passed as a secret
 extraSecretEnvs: {}
+
 #  MAUTIC_CONFIG_DEBUG: "1"
 
 #  MAUTIC_DB_HOST: ... (defaults to the IP and port of the linked mysql container)
@@ -97,22 +98,32 @@ extraSecretEnvs: {}
 #  MAUTIC_ADMIN_FIRSTNAME: The first name of your initial admin user
 #  MAUTIC_ADMIN_LASTNAME: The last name of your initial admin user
 
+# -- Probes definitions
+# @default -- See `values.yaml`
 probes:
-  {}
-  # startupProbe:
-  #   httpGet:
-  #     path: /
-  #     port: http
-  # readinessProbe:
-  #   httpGet:
-  #     path: /
-  #     port: http
-  # livenessProbe:
-  #   httpGet:
-  #     path: /
-  #     port: http
-
+  startupProbe:
+    httpGet:
+      path: /
+      port: http
+    failureThreshold: 30
+    periodSeconds: 10
+  readinessProbe:
+    httpGet:
+      path: /
+      port: http
+    failureThreshold: 5
+    periodSeconds: 5
+  livenessProbe:
+    httpGet:
+      path: /
+      port: http
+    failureThreshold: 5
+    periodSeconds: 5
+
+# -- Mariadb subchart configuration, see https://artifacthub.io/packages/helm/bitnami/mariadb for docs
+# @default -- see `values.yaml`
 mariadb:
+  # -- Enable Mariadb chart?
   enabled: true
   auth:
     database: mautic