Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
Go dockerfossgomarkdownmemomicroblognote-takingnotesopen-sourceown-your-datareactself-hostedsqlitetimeline
feat: add helm chart (#2095)
OKIAAAAA012a5f4907b1
diff --git a/deploy/helm/.helmignore b/deploy/helm/.helmignorenew file mode 100644index 000000000..0e8a0eb36--- /dev/null+++ b/deploy/helm/.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/deploy/helm/Chart.yaml b/deploy/helm/Chart.yamlnew file mode 100644index 000000000..dc989b6cd--- /dev/null+++ b/deploy/helm/Chart.yaml@@ -0,0 +1,24 @@+apiVersion: v2+name: memos+description: A Helm chart for Kubernetes++# 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.1.0++# 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.+appVersion: "0.14.3"diff --git a/deploy/helm/README-zh.md b/deploy/helm/README-zh.mdnew file mode 100644index 000000000..e28786e9d--- /dev/null+++ b/deploy/helm/README-zh.md@@ -0,0 +1,27 @@+## 安装方式+示例+```shell+helm install memos .+```+指定`namespace`示例+```shell+helm install memos -n app .+```+## 自定义存储+修改`values.yaml`+```yaml+persistence:+ ## 如果enabled 为False, 会使用emptyDir, Pod 重建后数据可能丢失, 建议使用持久卷+ enabled: false+ storageClass: "local"+ existPersistClaim: ""+ accessMode: ReadWriteOnce+ size: 10Gi+```+`enabled` 是 `false` 时默认使用`emptyDir`++1、如果有已创建的`pvc`, 请修改`enabled`为`true`, 并修改`existPersistClaim`为`pvc`的名字+2、如果`enabled`为`true`但`existPersistClaim`为空,根据`accessMode`、`storageClass`、`size`创建pvc+++diff --git a/deploy/helm/README.md b/deploy/helm/README.mdnew file mode 100644index 000000000..c9157e50e--- /dev/null+++ b/deploy/helm/README.md@@ -0,0 +1,26 @@+## Install Steps+example+```shell+helm install memos .+```+use custom `namespace` example+```shell+helm install memos -n app .+```+## Persistence+Edit `values.yaml`+```yaml+persistence:+ ## If enabled is False, emptyDir will be used, data may be lost after Pod rebuild, it is recommended to use persistent volume+ enabled: false+ storageClass: "local"+ existPersistClaim: ""+ accessMode: ReadWriteOnce+ size: 10Gi+```+when `enabled` is `false` use `emptyDir`,+1、If has created `pvc`, Please change `enabled` to `true`, and change`existPersistClaim`to your `pvc` name+2、If `enabled` is `true` but `existPersistClaim` is empty,if will create a new `pvc` by `accessMode` `storageClass` `size`+++diff --git a/deploy/helm/templates/NOTES.txt b/deploy/helm/templates/NOTES.txtnew file mode 100644index 000000000..8a459318d--- /dev/null+++ b/deploy/helm/templates/NOTES.txt@@ -0,0 +1,22 @@+1. Get the application URL by running these commands:+{{- if .Values.ingress.enabled }}+{{- range $host := .Values.ingress.hosts }}+ {{- range .paths }}+ http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}+ {{- end }}+{{- end }}+{{- else if contains "NodePort" .Values.service.type }}+ export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "memos.fullname" . }})+ export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")+ echo http://$NODE_IP:$NODE_PORT+{{- else if contains "LoadBalancer" .Values.service.type }}+ NOTE: It may take a few minutes for the LoadBalancer IP to be available.+ You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "memos.fullname" . }}'+ export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "memos.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")+ echo http://$SERVICE_IP:{{ .Values.service.port }}+{{- else if contains "ClusterIP" .Values.service.type }}+ export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "memos.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")+ export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")+ echo "Visit http://127.0.0.1:8080 to use your application"+ kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT+{{- end }}diff --git a/deploy/helm/templates/_helpers.tpl b/deploy/helm/templates/_helpers.tplnew file mode 100644index 000000000..32725c78c--- /dev/null+++ b/deploy/helm/templates/_helpers.tpl@@ -0,0 +1,62 @@+{{/*+Expand the name of the chart.+*/}}+{{- define "memos.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 "memos.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 "memos.chart" -}}+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}+{{- end }}++{{/*+Common labels+*/}}+{{- define "memos.labels" -}}+helm.sh/chart: {{ include "memos.chart" . }}+{{ include "memos.selectorLabels" . }}+{{- if .Chart.AppVersion }}+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}+{{- end }}+app.kubernetes.io/managed-by: {{ .Release.Service }}+{{- end }}++{{/*+Selector labels+*/}}+{{- define "memos.selectorLabels" -}}+app.kubernetes.io/name: {{ include "memos.name" . }}+app.kubernetes.io/instance: {{ .Release.Name }}+{{- end }}++{{/*+Create the name of the service account to use+*/}}+{{- define "memos.serviceAccountName" -}}+{{- if .Values.serviceAccount.create }}+{{- default (include "memos.fullname" .) .Values.serviceAccount.name }}+{{- else }}+{{- default "default" .Values.serviceAccount.name }}+{{- end }}+{{- end }}diff --git a/deploy/helm/templates/deployment.yaml b/deploy/helm/templates/deployment.yamlnew file mode 100644index 000000000..7b287cdc1--- /dev/null+++ b/deploy/helm/templates/deployment.yaml@@ -0,0 +1,78 @@+apiVersion: apps/v1+kind: Deployment+metadata:+ name: {{ include "memos.fullname" . }}+ labels:+ {{- include "memos.labels" . | nindent 4 }}+spec:+ {{- if not .Values.autoscaling.enabled }}+ replicas: {{ .Values.replicaCount }}+ {{- end }}++ selector:+ matchLabels:+ {{- include "memos.selectorLabels" . | nindent 6 }}+ template:+ metadata:+ {{- with .Values.podAnnotations }}+ annotations:+ {{- toYaml . | nindent 8 }}+ {{- end }}+ labels:+ {{- include "memos.selectorLabels" . | nindent 8 }}+ spec:+ {{- with .Values.imagePullSecrets }}+ imagePullSecrets:+ {{- toYaml . | nindent 8 }}+ {{- end }}+ serviceAccountName: {{ include "memos.serviceAccountName" . }}+ securityContext:+ {{- toYaml .Values.podSecurityContext | nindent 8 }}+ volumes:+ - name: memos-data+ {{- if .Values.persistence.enabled }}+ persistentVolumeClaim:+ claimName: {{ .Values.persistence.existPersistClaim | default (include "memos.fullname" .) }}+ {{- else }}+ emptyDir: { }+ {{ end }}+ containers:+ - name: {{ .Chart.Name }}+ securityContext:+ {{- toYaml .Values.securityContext | nindent 12 }}+ image: "{{ .Values.image.repo}}/{{ .Values.image.imageName }}:{{ .Values.image.tag | default .Chart.AppVersion }}"+ imagePullPolicy: {{ .Values.image.pullPolicy }}+ ports:+ - name: http+ containerPort: 5230+ protocol: TCP+ livenessProbe:+ httpGet:+ path: /+ port: http+ readinessProbe:+ httpGet:+ path: /+ port: http+ volumeMounts:+ - name: memos-data+ mountPath: /var/opt/memos+ # avoid * cannot parse 'Port' as int: strconv.ParseInt: parsing "tcp://10.233.40.219:5230": invalid syntax+ env:+ - name: MEMOS_PORT+ value: "{{ .Values.service.port }}"+ resources:+ {{- toYaml .Values.resources | nindent 12 }}+ {{- with .Values.nodeSelector }}+ nodeSelector:+ {{- toYaml . | nindent 8 }}+ {{- end }}+ {{- with .Values.affinity }}+ affinity:+ {{- toYaml . | nindent 8 }}+ {{- end }}+ {{- with .Values.tolerations }}+ tolerations:+ {{- toYaml . | nindent 8 }}+ {{- end}}+diff --git a/deploy/helm/templates/hpa.yaml b/deploy/helm/templates/hpa.yamlnew file mode 100644index 000000000..2093dd925--- /dev/null+++ b/deploy/helm/templates/hpa.yaml@@ -0,0 +1,28 @@+{{- if .Values.autoscaling.enabled }}+apiVersion: autoscaling/v2beta1+kind: HorizontalPodAutoscaler+metadata:+ name: {{ include "memos.fullname" . }}+ labels:+ {{- include "memos.labels" . | nindent 4 }}+spec:+ scaleTargetRef:+ apiVersion: apps/v1+ kind: Deployment+ name: {{ include "memos.fullname" . }}+ minReplicas: {{ .Values.autoscaling.minReplicas }}+ maxReplicas: {{ .Values.autoscaling.maxReplicas }}+ metrics:+ {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}+ - type: Resource+ resource:+ name: cpu+ targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}+ {{- end }}+ {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}+ - type: Resource+ resource:+ name: memory+ targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}+ {{- end }}+{{- end }}diff --git a/deploy/helm/templates/ingress.yaml b/deploy/helm/templates/ingress.yamlnew file mode 100644index 000000000..94ae4b8bf--- /dev/null+++ b/deploy/helm/templates/ingress.yaml@@ -0,0 +1,61 @@+{{- if .Values.ingress.enabled -}}+{{- $fullName := include "memos.fullname" . -}}+{{- $svcPort := .Values.service.port -}}+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}+ {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}+ {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}+ {{- end }}+{{- end }}+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}+apiVersion: networking.k8s.io/v1+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}+apiVersion: networking.k8s.io/v1beta1+{{- else -}}+apiVersion: extensions/v1beta1+{{- end }}+kind: Ingress+metadata:+ name: {{ $fullName }}+ labels:+ {{- include "memos.labels" . | nindent 4 }}+ {{- with .Values.ingress.annotations }}+ annotations:+ {{- toYaml . | nindent 4 }}+ {{- end }}+spec:+ {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}+ ingressClassName: {{ .Values.ingress.className }}+ {{- end }}+ {{- if .Values.ingress.tls }}+ tls:+ {{- range .Values.ingress.tls }}+ - hosts:+ {{- range .hosts }}+ - {{ . | quote }}+ {{- end }}+ secretName: {{ .secretName }}+ {{- end }}+ {{- end }}+ rules:+ {{- range .Values.ingress.hosts }}+ - host: {{ .host | quote }}+ http:+ paths:+ {{- range .paths }}+ - path: {{ .path }}+ {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}+ pathType: {{ .pathType }}+ {{- end }}+ backend:+ {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}+ service:+ name: {{ $fullName }}+ port:+ number: {{ $svcPort }}+ {{- else }}+ serviceName: {{ $fullName }}+ servicePort: {{ $svcPort }}+ {{- end }}+ {{- end }}+ {{- end }}+{{- end }}diff --git a/deploy/helm/templates/pvc.yaml b/deploy/helm/templates/pvc.yamlnew file mode 100644index 000000000..db6166057--- /dev/null+++ b/deploy/helm/templates/pvc.yaml@@ -0,0 +1,17 @@+{{- if and .Values.persistence.enabled (not .Values.persistence.existPersistClaim) }}+kind: PersistentVolumeClaim+apiVersion: v1+metadata:+ name: {{ template "memos.fullname" . }}+ labels:+ {{- include "memos.labels" . | nindent 4 }}+spec:+ {{- if .Values.persistence.storageClass }}+ storageClassName: {{ .Values.persistence.storageClass | quote }}+ {{- end }}+ accessModes:+ - {{ .Values.persistence.accessMode | quote }}+ resources:+ requests:+ storage: {{ .Values.persistence.size | quote }}+{{- end -}}\ No newline at end of filediff --git a/deploy/helm/templates/service.yaml b/deploy/helm/templates/service.yamlnew file mode 100644index 000000000..cbca6e70b--- /dev/null+++ b/deploy/helm/templates/service.yaml@@ -0,0 +1,15 @@+apiVersion: v1+kind: Service+metadata:+ name: {{ include "memos.fullname" . }}+ labels:+ {{- include "memos.labels" . | nindent 4 }}+spec:+ type: {{ .Values.service.type }}+ ports:+ - port: {{ .Values.service.port }}+ targetPort: http+ protocol: TCP+ name: http+ selector:+ {{- include "memos.selectorLabels" . | nindent 4 }}diff --git a/deploy/helm/templates/serviceaccount.yaml b/deploy/helm/templates/serviceaccount.yamlnew file mode 100644index 000000000..35fbe4a96--- /dev/null+++ b/deploy/helm/templates/serviceaccount.yaml@@ -0,0 +1,12 @@+{{- if .Values.serviceAccount.create -}}+apiVersion: v1+kind: ServiceAccount+metadata:+ name: {{ include "memos.serviceAccountName" . }}+ labels:+ {{- include "memos.labels" . | nindent 4 }}+ {{- with .Values.serviceAccount.annotations }}+ annotations:+ {{- toYaml . | nindent 4 }}+ {{- end }}+{{- end }}diff --git a/deploy/helm/templates/tests/test-connection.yaml b/deploy/helm/templates/tests/test-connection.yamlnew file mode 100644index 000000000..77e48518b--- /dev/null+++ b/deploy/helm/templates/tests/test-connection.yaml@@ -0,0 +1,15 @@+apiVersion: v1+kind: Pod+metadata:+ name: "{{ include "memos.fullname" . }}-test-connection"+ labels:+ {{- include "memos.labels" . | nindent 4 }}+ annotations:+ "helm.sh/hook": test+spec:+ containers:+ - name: wget+ image: busybox+ command: ['wget']+ args: ['{{ include "memos.fullname" . }}:{{ .Values.service.port }}']+ restartPolicy: Neverdiff --git a/deploy/helm/values.yaml b/deploy/helm/values.yamlnew file mode 100644index 000000000..8f5a72d20--- /dev/null+++ b/deploy/helm/values.yaml@@ -0,0 +1,93 @@+# Default values for memos.+# This is a YAML-formatted file.+# Declare variables to be passed into your templates.++replicaCount: 1++image:+ repo: ghcr.io+ imageName: usememos/memos+ pullPolicy: IfNotPresent+ # Overrides the image tag whose default is the chart appVersion.+ tag: "latest"++imagePullSecrets: []+nameOverride: ""+fullnameOverride: ""++persistence:+ ## 如果enabled 为False, 会使用emptyDir, Pod 重建后数据可能丢失, 建议使用持久卷+ ## If enabled is False, emptyDir will be used, data may be lost after Pod rebuild, it is recommended to use persistent volume+ enabled: false+ storageClass: "local"+ existPersistClaim: ""+ accessMode: ReadWriteOnce+ size: 10Gi++serviceAccount:+ # Specifies whether a service account should be created+ create: true+ # 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: {}++podSecurityContext: {}+ # fsGroup: 2000++securityContext: {}+ # capabilities:+ # drop:+ # - ALL+ # readOnlyRootFilesystem: true+ # runAsNonRoot: true+ # runAsUser: 1000++service:+ type: ClusterIP+ port: 5230++ingress:+ enabled: false+ className: ""+ annotations: {}+ # kubernetes.io/ingress.class: nginx+ # kubernetes.io/tls-acme: "true"+ # traefik.ingress.kubernetes.io/router.middlewares: app-chain-authelia-auth@kubernetescrd+ hosts:+ - host: chart-example.local+ paths:+ - path: /+ pathType: Prefix+ tls: []+ # - secretName: chart-example-tls+ # hosts:+ # - chart-example.local++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+ # resources, such as Minikube. If you do want to specify resources, uncomment the following+ # lines, adjust them as necessary, and remove the curly braces after 'resources:'.+ # limits:+ # cpu: 100m+ # memory: 128Mi+ # requests:+ # cpu: 100m+ # memory: 128Mi++autoscaling:+ enabled: false+ minReplicas: 1+ maxReplicas: 100+ targetCPUUtilizationPercentage: 80+ # targetMemoryUtilizationPercentage: 80++nodeSelector: {}++tolerations: []++affinity: {}