From dabf9e8a112af2e555d9772079c3924b284182cd Mon Sep 17 00:00:00 2001
From: groundhog2k <10630407+groundhog2k@users.noreply.github.com>
Date: Thu, 3 Dec 2020 18:38:53 +0100
Subject: [PATCH] Initial mongodb chart (#92)
* Draft for mongodb chart
* Draft for mongodb chart with readme
* Finalized initial chart version
* Removed trailing spaces
* Added maintainer
---
charts/mongodb/.helmignore | 23 +++
charts/mongodb/Chart.yaml | 12 ++
charts/mongodb/README.md | 100 +++++++++++++
charts/mongodb/templates/_helpers.tpl | 62 ++++++++
charts/mongodb/templates/initdbconfig.yaml | 17 +++
charts/mongodb/templates/secureconfig.yaml | 12 ++
charts/mongodb/templates/service.yaml | 15 ++
charts/mongodb/templates/serviceaccount.yaml | 12 ++
charts/mongodb/templates/statefulset.yaml | 147 +++++++++++++++++++
charts/mongodb/values.yaml | 120 +++++++++++++++
10 files changed, 520 insertions(+)
create mode 100644 charts/mongodb/.helmignore
create mode 100644 charts/mongodb/Chart.yaml
create mode 100644 charts/mongodb/README.md
create mode 100644 charts/mongodb/templates/_helpers.tpl
create mode 100644 charts/mongodb/templates/initdbconfig.yaml
create mode 100644 charts/mongodb/templates/secureconfig.yaml
create mode 100644 charts/mongodb/templates/service.yaml
create mode 100644 charts/mongodb/templates/serviceaccount.yaml
create mode 100644 charts/mongodb/templates/statefulset.yaml
create mode 100644 charts/mongodb/values.yaml
diff --git a/charts/mongodb/.helmignore b/charts/mongodb/.helmignore
new file mode 100644
index 00000000..0e8a0eb3
--- /dev/null
+++ b/charts/mongodb/.helmignore
@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
diff --git a/charts/mongodb/Chart.yaml b/charts/mongodb/Chart.yaml
new file mode 100644
index 00000000..fe8169da
--- /dev/null
+++ b/charts/mongodb/Chart.yaml
@@ -0,0 +1,12 @@
+apiVersion: v2
+name: mongodb
+description: A Helm chart to deploy MongoDB
+
+type: application
+
+maintainers:
+ - name: groundhog2k
+
+version: 0.1.0
+
+appVersion: 4.2.11
diff --git a/charts/mongodb/README.md b/charts/mongodb/README.md
new file mode 100644
index 00000000..5d31de9e
--- /dev/null
+++ b/charts/mongodb/README.md
@@ -0,0 +1,100 @@
+# MongoDB
+
+  
+
+A Helm chart for MongoDB on Kubernetes
+
+## TL;DR
+
+```bash
+$ helm repo add groundhog2k https://groundhog2k.github.io/helm-charts/
+$ helm install my-release groundhog2k/mongodb
+```
+
+## Introduction
+
+This chart uses the original [MongoDB image from Docker Hub](https://hub.docker.com/_/mongo/) to deploy a stateful MongoDB instance in a Kubernetes cluster.
+
+It fully supports the deployment of the [ARM64v8 image of MongoDB](https://hub.docker.com/r/arm64v8/mongo/) on a ARM64 based Kubernetes cluster just by exchanging the existing `image.repository` value.
+
+
+## Prerequisites
+
+- Kubernetes 1.12+
+- Helm 3.x
+- PV provisioner support in the underlying infrastructure
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```bash
+$ helm install my-release groundhog2k/mongodb
+```
+
+## Uninstalling the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```bash
+$ helm uninstall my-release
+```
+
+## Common parameters
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| fullnameOverride | string | `""` | Fully override the deployment name |
+| nameOverride | string | `""` | Partially override the deployment name |
+
+## Deployment parameters
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
+| image.repository | string | `"mongo"` | Image name |
+| image.tag | string | `""` | Image tag |
+| imagePullSecrets | list | `[]` | Image pull secrets |
+| livenessProbe | object | `see values.yaml` | Liveness probe configuration |
+| readinessProbe | object | `see values.yaml` | Readiness probe configuration |
+| resources | object | `{}` | Resource limits and requests |
+| nodeSelector."kubernetes.io/arch" | string | `"amd64"` | Deployment node selector |
+| podAnnotations | object | `{}` | Additional pod annotations |
+| podSecurityContext | object | `see values.yaml` | Pod security context |
+| securityContext | object | `see values.yaml` | Container security context |
+| env | list | `[]` | Additional container environmment variables |
+| args | object | `{}` | Additional container command arguments |
+| serviceAccount.annotations | object | `{}` | Additional service account annotations |
+| serviceAccount.create | bool | `false` | Enable service account creation |
+| serviceAccount.name | string | `""` | Name of the service account |
+| affinity | object | `{}` | Pod affinity |
+| tolerations | list | `[]` | Pod tolerations |
+| podManagementPolicy | string | `OrderedReady` | Pod management policy |
+| updateStrategyType | string | `RollingUpdate` | Update strategy |
+| replicaCount | int | `1` | Number of replicas (Not supported - Don't change in this chart version) |
+
+## Service paramters
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| service.port | int | `27017` | MongoDB service port |
+
+## Storage parameters
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| storage.accessModes[0] | string | `"ReadWriteOnce"` | Storage access mode |
+| storage.persistentVolumeClaimName | string | `""` | PVC name when existing storage volume should be used |
+| storage.requestedSize | string | `""` | Size for new PVC, when no existing PVC is used |
+| storage.className | string | `""` | Storage class name |
+
+## MongoDB parameters
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| settings.customConfig | string | `""` | Custom MongoDB configuration block that will be mounted as file in /etc/mongo/custom.conf |
+| settings.rootUsername | string | `admin` | The root username |
+| settings.rootPassword | string | `{}` | The root users password (Random value if not specified) |
+| initUserDatabase | object | `{}` | Optional user database initialization script support |
+| initUserDatabase.dbName | string | `""` | Name of the user database |
+| initUserDatabase.script | string | `""` | Javascript block to initialize the user database |
diff --git a/charts/mongodb/templates/_helpers.tpl b/charts/mongodb/templates/_helpers.tpl
new file mode 100644
index 00000000..6b1b8c17
--- /dev/null
+++ b/charts/mongodb/templates/_helpers.tpl
@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "mongodb.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 "mongodb.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 "mongodb.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "mongodb.labels" -}}
+helm.sh/chart: {{ include "mongodb.chart" . }}
+{{ include "mongodb.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "mongodb.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "mongodb.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "mongodb.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "mongodb.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
diff --git a/charts/mongodb/templates/initdbconfig.yaml b/charts/mongodb/templates/initdbconfig.yaml
new file mode 100644
index 00000000..749c668b
--- /dev/null
+++ b/charts/mongodb/templates/initdbconfig.yaml
@@ -0,0 +1,17 @@
+{{- if or (.Values.customConfig) (.Values.initUserDatabase.script) }}
+kind: ConfigMap
+apiVersion: v1
+metadata:
+ name: {{ include "mongodb.fullname" . }}
+ labels:
+ {{- include "mongodb.labels" . | nindent 4 }}
+data:
+{{- if .Values.settings.customConfig }}
+ custom.conf: |-
+ {{- .Values.settings.customConfig | nindent 4 }}
+{{- end }}
+{{- if .Values.initUserDatabase.script }}
+ init-user-db.js: |-
+ {{- .Values.initUserDatabase.script | nindent 4 }}
+{{- end }}
+{{- end }}
diff --git a/charts/mongodb/templates/secureconfig.yaml b/charts/mongodb/templates/secureconfig.yaml
new file mode 100644
index 00000000..f2d27570
--- /dev/null
+++ b/charts/mongodb/templates/secureconfig.yaml
@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Secret
+metadata:
+ name: {{ include "mongodb.fullname" . }}
+ labels:
+ {{- include "mongodb.labels" . | nindent 4 }}
+stringData:
+ {{- if .Values.initUserDatabase.dbName }}
+ MONGO_INITDB_DATABASE: {{ .Values.initUserDatabase.dbName }}
+ {{- end }}
+ MONGO_INITDB_ROOT_USERNAME: {{ .Values.settings.rootUsername }}
+ MONGO_INITDB_ROOT_PASSWORD: {{ .Values.settings.rootPassword | default (randAlphaNum 10) }}
diff --git a/charts/mongodb/templates/service.yaml b/charts/mongodb/templates/service.yaml
new file mode 100644
index 00000000..a276e455
--- /dev/null
+++ b/charts/mongodb/templates/service.yaml
@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+ name: {{ include "mongodb.fullname" . }}
+ labels:
+ {{- include "mongodb.labels" . | nindent 4 }}
+spec:
+ type: {{ .Values.service.type }}
+ ports:
+ - port: {{ .Values.service.port }}
+ targetPort: mongodb
+ protocol: TCP
+ name: mongodb
+ selector:
+ {{- include "mongodb.selectorLabels" . | nindent 4 }}
diff --git a/charts/mongodb/templates/serviceaccount.yaml b/charts/mongodb/templates/serviceaccount.yaml
new file mode 100644
index 00000000..acce4c31
--- /dev/null
+++ b/charts/mongodb/templates/serviceaccount.yaml
@@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+ name: {{ include "mongodb.serviceAccountName" . }}
+ labels:
+ {{- include "mongodb.labels" . | nindent 4 }}
+ {{- with .Values.serviceAccount.annotations }}
+ annotations:
+ {{- toYaml . | nindent 4 }}
+ {{- end }}
+{{- end }}
diff --git a/charts/mongodb/templates/statefulset.yaml b/charts/mongodb/templates/statefulset.yaml
new file mode 100644
index 00000000..642ba391
--- /dev/null
+++ b/charts/mongodb/templates/statefulset.yaml
@@ -0,0 +1,147 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+ name: {{ include "mongodb.fullname" . }}
+ labels:
+ {{- include "mongodb.labels" . | nindent 4 }}
+spec:
+ selector:
+ matchLabels:
+ {{- include "mongodb.selectorLabels" . | nindent 6 }}
+ serviceName: {{ include "mongodb.fullname" . }}-internal
+ podManagementPolicy: {{ .Values.podManagementPolicy }}
+ replicas: {{ .Values.replicaCount }}
+ updateStrategy:
+ type: {{ .Values.updateStrategyType }}
+ template:
+ metadata:
+ {{- with .Values.podAnnotations }}
+ annotations:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
+ labels:
+ {{- include "mongodb.selectorLabels" . | nindent 8 }}
+ spec:
+ {{- with .Values.imagePullSecrets }}
+ imagePullSecrets:
+ {{- toYaml . | nindent 8 }}
+ {{- end }}
+ serviceAccountName: {{ include "mongodb.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 }}
+ ports:
+ - name: mongodb
+ containerPort: 27017
+ protocol: TCP
+ {{- if .Values.livenessProbe.enabled }}
+ livenessProbe:
+ exec:
+ command:
+ - mongo
+ - --eval
+ - "db.adminCommand('ping')"
+ initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }}
+ timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }}
+ periodSeconds: {{ .Values.livenessProbe.periodSeconds }}
+ failureThreshold: {{ .Values.livenessProbe.failureThreshold }}
+ successThreshold: {{ .Values.livenessProbe.successThreshold }}
+ {{- end }}
+ {{- if .Values.readinessProbe.enabled }}
+ readinessProbe:
+ exec:
+ command:
+ - mongo
+ - --eval
+ - "db.adminCommand('ping')"
+ initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }}
+ timeoutSeconds: {{ .Values.readinessProbe.timeoutSeconds }}
+ periodSeconds: {{ .Values.readinessProbe.periodSeconds }}
+ failureThreshold: {{ .Values.readinessProbe.failureThreshold }}
+ successThreshold: {{ .Values.readinessProbe.successThreshold }}
+ {{- end }}
+ resources:
+ {{- toYaml .Values.resources | nindent 12 }}
+ envFrom:
+ - secretRef:
+ name: {{ include "mongodb.fullname" . }}
+ {{- with .Values.env }}
+ env:
+ {{- toYaml . | nindent 12 }}
+ {{- end }}
+ args:
+ {{- range .Values.args }}
+ - {{ . }}
+ {{- end }}
+ {{- if .Values.settings.customConfig }}
+ - --config
+ - /etc/mongo/custom.conf
+ {{- end }}
+ volumeMounts:
+ - name: tmp
+ mountPath: /tmp
+ - name: mongodb-volume
+ mountPath: /data/db
+ {{- if .Values.settings.customConfig }}
+ - mountPath: /etc/mongo/custom.conf
+ subPath: custom.conf
+ name: initdbconfig
+ {{- end }}
+ {{- if .Values.initUserDatabase.script }}
+ - mountPath: /docker-entrypoint-initdb.d/init-user-db.js
+ subPath: init-user-db.js
+ name: initdbconfig
+ {{- 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 }}
+ volumes:
+ - name: tmp
+ emptyDir: {}
+ {{- if or (.Values.settings.customConfig) (.Values.initUserDatabase.script) }}
+ - name: initdbconfig
+ configMap:
+ name: {{ include "mongodb.fullname" . }}
+ defaultMode: 0440
+ {{- end }}
+ {{- if .Values.storage.persistentVolumeClaimName }}
+ - name: mongodb-volume
+ persistentVolumeClaim:
+ claimName: {{ .Values.storage.persistentVolumeClaimName }}
+ {{- else }}
+ {{- if not .Values.storage.requestedSize }}
+ - name: mongodb-volume
+ emptyDir: {}
+ {{- else }}
+ volumeClaimTemplates:
+ - metadata:
+ name: mongodb-volume
+ labels:
+ {{- include "mongodb.labels" . | nindent 10 }}
+ spec:
+ {{- with .Values.storage.accessModes }}
+ accessModes:
+ {{- toYaml . | nindent 10 }}
+ {{- end }}
+ {{- if .Values.storage.className }}
+ storageClassName: {{ .Values.storage.className }}
+ {{- end }}
+ resources:
+ requests:
+ storage: {{ .Values.storage.requestedSize }}
+ {{- end }}
+ {{- end }}
\ No newline at end of file
diff --git a/charts/mongodb/values.yaml b/charts/mongodb/values.yaml
new file mode 100644
index 00000000..f2840f86
--- /dev/null
+++ b/charts/mongodb/values.yaml
@@ -0,0 +1,120 @@
+# Default values for mongodb.
+
+## MongoDB docker image
+## use arm64v8/redis for the same image on ARM64v8
+image:
+ repository: mongo
+ pullPolicy: IfNotPresent
+ # Overrides the image tag whose default is the chart appVersion.
+ tag: ""
+
+## Pull secrets and name override options
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+## Optional service account
+serviceAccount:
+ # Specifies whether a service account should be created
+ create: false
+ # 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: ""
+
+podAnnotations: {}
+
+## Pod security options
+podSecurityContext:
+ fsGroup: 999
+
+## Don't touch - no other options supported in V0.1.0 of this chart
+podManagementPolicy: OrderedReady
+updateStrategyType: RollingUpdate
+replicaCount: 1
+
+## Default security options to run Redis as non-root, read only container without privilege escalation
+securityContext:
+ allowPrivilegeEscalation: false
+ privileged: false
+ readOnlyRootFilesystem: true
+ runAsNonRoot: true
+ runAsGroup: 999
+ runAsUser: 999
+
+service:
+ type: ClusterIP
+ port: 27017
+
+## Resource limits and requests
+resources: {}
+ # limits:
+ # cpu: 100m
+ # memory: 128Mi
+ # requests:
+ # cpu: 100m
+ # memory: 128Mi
+
+## Default liveness probe
+livenessProbe:
+ enabled: true
+ initialDelaySeconds: 30
+ timeoutSeconds: 20
+ periodSeconds: 30
+ failureThreshold: 6
+ successThreshold: 1
+
+## Default readiness probe
+readinessProbe:
+ enabled: true
+ initialDelaySeconds: 30
+ timeoutSeconds: 20
+ periodSeconds: 30
+ failureThreshold: 5
+ successThreshold: 1
+
+## Default node type for the image
+## use arm64v8 for the arm64v8/mongo image
+nodeSelector:
+ kubernetes.io/arch: amd64
+
+## Pod tolerations
+tolerations: []
+
+## Pod affinity
+affinity: {}
+
+## Additional arguments for the container entrypoint process
+args: {}
+
+## Additional environment variables
+env: []
+
+settings:
+ ## The root username (default: admin)
+ rootUsername: "admin"
+ ## The root user password (default: a 10 char. alpahnumerical random password will be generated)
+ rootPassword:
+ ## Custom configuration (use instead of command args)
+ customConfig: |
+
+## Initializes a user database with name from dbName (default connected to test database if no dbName is specified)
+initUserDatabase:
+ ## Database name for init
+ dbName: {}
+ ## JavaScript for initialization of new database
+ script: |
+
+# Storage parameters
+# When a persistentVolumenClaimName is configured the requestedSize and accessModes will be ignored and the existing PVC based on the name will be used
+# otherwise a dynamic persistent volume will be created with PVC name of this chart and the configured requestedSize and accessModes
+# If both parameters are missing a volatile emtpyDir volume will be used as RabbitMQ storage
+storage:
+ # Set persistentVolumenClaimName to reference an existing PVC
+ persistentVolumeClaimName: {}
+ # Alternative set requestedSize to define a size for a dynamically created PVC
+ requestedSize: {}
+ accessModes:
+ - ReadWriteOnce
+ className: {}
--
GitLab