From cadeba23a6435a959f1ecc1e87cebfb078406f1d Mon Sep 17 00:00:00 2001 From: Alexander Olofsson Date: Wed, 12 Aug 2020 10:58:20 +0200 Subject: [PATCH] Add chart for Element web client --- charts/element-web/.helmignore | 23 +++++ charts/element-web/Chart.yaml | 16 ++++ charts/element-web/templates/NOTES.txt | 21 +++++ charts/element-web/templates/_helpers.tpl | 70 +++++++++++++++ .../element-web/templates/configuration.yaml | 13 +++ charts/element-web/templates/deployment.yaml | 71 ++++++++++++++++ charts/element-web/templates/hpa.yaml | 28 ++++++ charts/element-web/templates/ingress.yaml | 41 +++++++++ charts/element-web/templates/service.yaml | 15 ++++ .../element-web/templates/serviceaccount.yaml | 12 +++ .../templates/tests/test-connection.yaml | 15 ++++ charts/element-web/values.yaml | 85 +++++++++++++++++++ 12 files changed, 410 insertions(+) create mode 100644 charts/element-web/.helmignore create mode 100644 charts/element-web/Chart.yaml create mode 100644 charts/element-web/templates/NOTES.txt create mode 100644 charts/element-web/templates/_helpers.tpl create mode 100644 charts/element-web/templates/configuration.yaml create mode 100644 charts/element-web/templates/deployment.yaml create mode 100644 charts/element-web/templates/hpa.yaml create mode 100644 charts/element-web/templates/ingress.yaml create mode 100644 charts/element-web/templates/service.yaml create mode 100644 charts/element-web/templates/serviceaccount.yaml create mode 100644 charts/element-web/templates/tests/test-connection.yaml create mode 100644 charts/element-web/values.yaml diff --git a/charts/element-web/.helmignore b/charts/element-web/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/element-web/.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/element-web/Chart.yaml b/charts/element-web/Chart.yaml new file mode 100644 index 0000000..980c253 --- /dev/null +++ b/charts/element-web/Chart.yaml @@ -0,0 +1,16 @@ +--- +apiVersion: v2 +name: element-web +description: | + All-in-one secure chat app for teams, friends and organisations. + Keeps conversations in your control, safe from data-mining and ads. + Talk to everyone through the open global Matrix network, protected by proper + end-to-end encryption. +icon: https://element.io/images/element-logo.svg +appVersion: 1.7.3 + +type: application +version: 0.1.0 +maintainers: + - name: Alexander Olofsson + email: ace@haxalot.com diff --git a/charts/element-web/templates/NOTES.txt b/charts/element-web/templates/NOTES.txt new file mode 100644 index 0000000..b6e3619 --- /dev/null +++ b/charts/element-web/templates/NOTES.txt @@ -0,0 +1,21 @@ +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 }}{{ . }} + {{- 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 "element-web.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 "element-web.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "element-web.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 "element-web.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/charts/element-web/templates/_helpers.tpl b/charts/element-web/templates/_helpers.tpl new file mode 100644 index 0000000..896b4cb --- /dev/null +++ b/charts/element-web/templates/_helpers.tpl @@ -0,0 +1,70 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "element-web.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 "element-web.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 }} + +{{/* +Get the correct image tag name +*/}} +{{- define "element-web.imageTag" -}} +{{- .Values.image.tag | default (printf "v%s" .Chart.AppVersion) -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "element-web.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "element-web.labels" -}} +helm.sh/chart: {{ include "element-web.chart" . }} +{{ include "element-web.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "element-web.selectorLabels" -}} +app.kubernetes.io/name: {{ include "element-web.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "element-web.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "element-web.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/element-web/templates/configuration.yaml b/charts/element-web/templates/configuration.yaml new file mode 100644 index 0000000..04bf8f2 --- /dev/null +++ b/charts/element-web/templates/configuration.yaml @@ -0,0 +1,13 @@ +{{- $m_homeserver := (dict "base_url" (required "Must specify a default homeserver" .Values.defaultServer.url) "server_name" (required "Must specify a default server name" .Values.defaultServer.name)) -}} +{{- $m_identity_server := (dict "base_url" (.Values.defaultServer.identity_url | default "https://vector.im")) -}} +{{- $default_server_config := dict "default_server_config" (dict "m.homeserver" $m_homeserver "m.identity_server" $m_identity_server) -}} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "element-web.fullname" . }} + labels: + {{- include "element-web.labels" . | nindent 4 }} +data: + config.json: | + {{- merge $default_server_config .Values.config | toJson | nindent 4 }} diff --git a/charts/element-web/templates/deployment.yaml b/charts/element-web/templates/deployment.yaml new file mode 100644 index 0000000..121f5f3 --- /dev/null +++ b/charts/element-web/templates/deployment.yaml @@ -0,0 +1,71 @@ +--- +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "element-web.fullname" . }} + labels: + {{- include "element-web.labels" . | nindent 4 }} +spec: +{{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} +{{- end }} + selector: + matchLabels: + {{- include "element-web.selectorLabels" . | nindent 6 }} + template: + metadata: + annotations: + checksum/config: {{ include (print .Template.BasePath "/configuration.yaml") . | sha256sum }} + {{- with .Values.podAnnotations }} + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "element-web.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "element-web.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ include "element-web.imageTag" . }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: 80 + protocol: TCP + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumeMounts: + - mountPath: /app/config.json + name: config + subPath: config.json + volumes: + - name: config + configMap: + name: {{ include "element-web.fullname" . }} + {{- 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/charts/element-web/templates/hpa.yaml b/charts/element-web/templates/hpa.yaml new file mode 100644 index 0000000..8e7c198 --- /dev/null +++ b/charts/element-web/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "element-web.fullname" . }} + labels: + {{- include "element-web.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "element-web.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/charts/element-web/templates/ingress.yaml b/charts/element-web/templates/ingress.yaml new file mode 100644 index 0000000..0b45a2b --- /dev/null +++ b/charts/element-web/templates/ingress.yaml @@ -0,0 +1,41 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "element-web.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- 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 "element-web.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- 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: {{ . }} + backend: + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} diff --git a/charts/element-web/templates/service.yaml b/charts/element-web/templates/service.yaml new file mode 100644 index 0000000..486d056 --- /dev/null +++ b/charts/element-web/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "element-web.fullname" . }} + labels: + {{- include "element-web.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "element-web.selectorLabels" . | nindent 4 }} diff --git a/charts/element-web/templates/serviceaccount.yaml b/charts/element-web/templates/serviceaccount.yaml new file mode 100644 index 0000000..dc669a4 --- /dev/null +++ b/charts/element-web/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "element-web.serviceAccountName" . }} + labels: + {{- include "element-web.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/element-web/templates/tests/test-connection.yaml b/charts/element-web/templates/tests/test-connection.yaml new file mode 100644 index 0000000..db8b7bf --- /dev/null +++ b/charts/element-web/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "element-web.fullname" . }}-test-connection" + labels: + {{- include "element-web.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test-success +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "element-web.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/element-web/values.yaml b/charts/element-web/values.yaml new file mode 100644 index 0000000..70516a3 --- /dev/null +++ b/charts/element-web/values.yaml @@ -0,0 +1,85 @@ +--- +replicaCount: 1 + +image: + repository: vectorim/riot-web + pullPolicy: IfNotPresent + # tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +## Default server for the Element install. (Required) +## This will configure the default_server_config block in the config.json +## Ref: https://github.com/vector-im/element-web/blob/develop/config.sample.json +## +defaultServer: + url: '' + name: '' + # identity_url: 'https://vector.im' + +## Element configuration +## Ref: https://github.com/vector-im/element-web/blob/develop/config.sample.json +## +config: {} + +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: 80 + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: [] + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +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: {}