commit 79c19ed76a732ec9d7f6101ad8e83f817035d197
parent 7cf6337605925f9e99a7e9533b4299b593e8206e
Author: MTRNord <mtrnord1@gmail.com>
Date: Thu, 21 Jul 2022 15:26:55 +0200
Add docs and readme
Diffstat:
3 files changed, 69 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# erooster
+
+  
+
+A Helm chart for the erooster mailserver
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | |
+| fullnameOverride | string | `""` | Override the full name of the installed chart. |
+| image.pullPolicy | string | `"IfNotPresent"` | |
+| image.pullSecrets | list | `[]` | Optionally specify an array of imagePullSecrets. Secrets must be manually created in the namespace. ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ |
+| image.repository | string | `"mtrnord/erooster"` | Image location to download erooster from |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| ingress.annotations | object | `{}` | Annotations to apply to the created ingress resource. |
+| ingress.className | string | `""` | Set the name of the IngressClass cluster resource (optional) |
+| ingress.enableTraefikTCPIngress | bool | `false` | Enable ingress for the mail ports (Only supporting traefik) |
+| ingress.enabled | bool | `false` | Enable the ingress |
+| ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | Hosts to listen on. |
+| ingress.tls | list | `[]` | TLS Secrets for this domain. This is required to match the tls secret for the server itself. |
+| nameOverride | string | `""` | Override part of the installed name, will still keep release name. |
+| nodeSelector | object | `{}` | |
+| podAnnotations | object | `{}` | Additional annotations for the pods |
+| podSecurityContext | object | `{}` | Security context for the pods |
+| replicaCount | int | `1` | Amount of replicas. WARNING: Currently erooster doesnt support horizontal scaling properly. |
+| resources | object | `{}` | Setup resource limits and requests |
+| securityContext | object | `{}` | Security context for the deployment |
+| service.httpPort | int | `80` | Port for the http server |
+| service.imapEncryptedPort | int | `993` | Port for the imap server (encrypted) |
+| service.imapPort | int | `143` | Port for the imap server (unencrypted) |
+| service.smtpEncryptedPort | int | `465` | Port for the smtp server (encrypted) |
+| service.smtpPort | int | `25` | Port for the smtp server (unencrypted) |
+| service.type | string | `"ClusterIP"` | Type of the Serive |
+| tolerations | list | `[]` | |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
diff --git a/templates/deployment.yaml b/templates/deployment.yaml
@@ -18,7 +18,7 @@ spec:
labels:
{{- include "erooster.selectorLabels" . | nindent 8 }}
spec:
- {{- with .Values.imagePullSecrets }}
+ {{- with .Values.image.pullSecrets }}
imagePullSecrets:
{{- toYaml . | nindent 8 }}
{{- end }}
diff --git a/values.yaml b/values.yaml
@@ -1,25 +1,33 @@
# Default values for erooster.
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
+# -- Amount of replicas. WARNING: Currently erooster doesnt support horizontal scaling properly.
replicaCount: 1
image:
+ # -- Image location to download erooster from
repository: mtrnord/erooster
pullPolicy: IfNotPresent
- # Overrides the image tag whose default is the chart appVersion.
+ # -- Overrides the image tag whose default is the chart appVersion.
tag: ""
+ # -- Optionally specify an array of imagePullSecrets.
+ # Secrets must be manually created in the namespace.
+ # ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
+ pullSecrets: []
-imagePullSecrets: []
+# -- Override part of the installed name, will still keep release name.
nameOverride: ""
+# -- Override the full name of the installed chart.
fullnameOverride: ""
+# -- Additional annotations for the pods
podAnnotations: {}
+# -- Security context for the pods
podSecurityContext:
{}
# fsGroup: 2000
+# -- Security context for the deployment
securityContext:
{}
# capabilities:
@@ -30,30 +38,42 @@ securityContext:
# runAsUser: 1000
service:
+ # -- Type of the Serive
type: ClusterIP
+ # -- Port for the http server
httpPort: 80
- smtpPort: 80
+ # -- Port for the smtp server (unencrypted)
+ smtpPort: 25
+ # -- Port for the smtp server (encrypted)
smtpEncryptedPort: 465
+ # -- Port for the imap server (unencrypted)
imapPort: 143
+ # -- Port for the imap server (encrypted)
imapEncryptedPort: 993
ingress:
+ # -- Enable the ingress
enabled: false
+ # -- Enable ingress for the mail ports (Only supporting traefik)
+ enableTraefikTCPIngress: false
+ # -- Set the name of the IngressClass cluster resource (optional)
className: ""
- annotations:
- {}
- # kubernetes.io/ingress.class: nginx
- # kubernetes.io/tls-acme: "true"
+ # -- Annotations to apply to the created ingress resource.
+ annotations: {}
+
+ # -- Hosts to listen on.
hosts:
- host: chart-example.local
paths:
- path: /
pathType: ImplementationSpecific
+ # -- TLS Secrets for this domain. This is required to match the tls secret for the server itself.
tls: []
# - secretName: chart-example-tls
# hosts:
# - chart-example.local
+# -- Setup resource limits and requests
resources:
{}
# We usually recommend not to specify default resources and to leave this as a conscious
