Added helm repo instructions + first build

README.md

@@ -104,3 +104,11 @@ It is also possible to use an alternate configuration file defined on a differen
 ```
 bin/cerebro -Dconfig.file=/some/other/dir/alternate.conf
 ```
+
+## Helm releases
+
+When building a new helm chart, run these commands from top of this repo:
+```
+(cd helm; helm package cerebro)
+helm repo index helm/ --url https://raw.githubusercontent.com/lmenezes/cerebro/master/helm/
+```

helm/cerebro/Chart.yaml

@@ -0,0 +1,11 @@
+name: cerebro
+# up release number if this chart is updated and appVersion is not. Reset release number when upping appVersion and version (as they must follow be in sync)
+version: 0.9.3-release1
+appVersion: 0.9.3
+apiVersion: v1
+description: A Helm chart for Cerebro - a web admin tool that replaces Kopf.
+home: https://github.com/lmenezes/cerebro
+icon: https://github.com/lmenezes/cerebro/blob/master/public/img/logo.png
+sources:
+ - https://github.com/lmenezes/cerebro-docker
+ - https://github.com/lmenezes/cerebro

helm/cerebro/README.md

@@ -0,0 +1,107 @@
+# ⚠️ Repo Archive Notice
+
+As of Nov 13, 2020, charts in this repo will no longer be updated.
+For more information, see the Helm Charts [Deprecation and Archive Notice](https://github.com/helm/charts#%EF%B8%8F-deprecation-and-archive-notice), and [Update](https://helm.sh/blog/charts-repo-deprecation/).
+
+# Cerebro
+
+Cerebro is an open source (MIT License) elasticsearch web admin tool built using Scala, Play Framework, AngularJS and Bootstrap.
+
+## DEPRECATION NOTICE
+
+This chart is deprecated and no longer supported.
+
+## Introduction
+
+This chart deploys Cerebro to your cluster via a Deployment and Service.
+Optionally you can also enable ingress.
+Optionally you can use cerebro provided auth by uploading a Secret with the needed env vars (don't forget to set `AUTH_TYPE`).
+
+# Prerequisites
+
+- Kubernetes 1.9+
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`, run:
+
+```bash
+$ helm install --name my-release stable/cerebro
+```
+
+After a few seconds, you should see service statuses being written to the configured output.
+
+> **Tip**: List all releases using `helm list`
+
+## Uninstalling the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```bash
+$ helm delete my-release
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+## Configuration
+
+The following table lists the configurable parameters of the cerebro chart and their default values.
+
+|             Parameter               |            Description              |                    Default                |
+|-------------------------------------|-------------------------------------|-------------------------------------------|
+| `replicaCount`                      | Number of replicas                  | `1`                                       |
+| `image.repository`                  | The image to run                    | `lmenezes/cerebro`                        |
+| `image.tag`                         | The image tag to pull               | `0.9.2`                                   |
+| `image.pullPolicy`                  | Image pull policy                   | `IfNotPresent`                            |
+| `image.pullSecrets`                 | Specify image pull secrets          | `nil` (does not add image pull secrets to deployed pods) |
+| `init.image.repository`             | The image to run                    | `docker.io/busybox`                       |
+| `init.image.tag`                    | The image tag to pull               | `musl`                                    |
+| `init.image.pullPolicy`             | Image pull policy                   | `IfNotPresent`                            |
+| `deployment.annotations`            | Annotations for deployment          | `{}`                                      |
+| `deployment.podAnnotations`         | Additional pod annotations          | `{}`                                      |
+| `deployment.labels`                 | Additional labels for deployment    | `{}`                                      |
+| `deployment.podLabels`              | Additional pod labels               | `{}`                                      |
+| `deployment.livenessProbe.enabled`  | Enable livenessProbe                | `true`                                    |
+| `deployment.readinessProbe.enabled` | Enable readinessProbe               | `true`                                    |
+| `service.type`                      | Type of Service                     | `ClusterIP`                               |
+| `service.port`                      | Port for kubernetes service         | `80`                                      |
+| `service.annotations`               | Annotations to add to the service   | `{}`                                      |
+| `service.labels`                    | Labels to add to the service        | `{}`                                      |
+| `resources.requests.cpu`            | CPU resource requests               |                                           |
+| `resources.limits.cpu`              | CPU resource limits                 |                                           |
+| `resources.requests.memory`         | Memory resource requests            |                                           |
+| `resources.limits.memory`           | Memory resource limits              |                                           |
+| `ingress`                           | Settings for ingress                | `{}`                                      |
+| `ingress.labels`                    | Labels to add to the ingress        | `{}`                                      |
+| `priorityClassName`                 | priorityClassName                   | `nil`                                     |
+| `nodeSelector`                      | Settings for nodeselector           | `{}`                                      |
+| `tolerations`                       | Settings for toleration             | `{}`                                      |
+| `affinity`                          | Settings for affinity               | `{}`                                      |
+| `env`                               | Map of env vars (key/value   )      | `{}`                                      |
+| `envFromSecretRef`                  | Reference to Secret with env vars   |                                           |
+| `config.basePath`                   | Application base path               | `/`                                       |
+| `config.restHistorySize`            | Rest request history size per user  | `50`                                      |
+| `config.hosts`                      | A list of known hosts               | `[]`                                      |
+| `config.secret`                     | Secret used to sign session cookies | `(random alphanumeric 64 length string)`  |
+| `config.tlsVerify`                  | Validate Elasticsearch cert         | `true`                                    |
+| `config.tlsCaCert`                  | CA cert to use for cert validation  | `See values.yaml`                         |
+| `securityContext`                   | Security context for pod            | `See values.yaml`                         |
+| `volumes`                           | Volumes defintion                   | `See values.yaml`                         |
+| `volumeMounts`                      | Volume mount defintion              | `See values.yaml`                         |
+
+
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
+
+```bash
+$ helm install --name my-release \
+    stable/cerebro
+```
+
+Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
+
+```bash
+$ helm install --name my-release -f values.yaml stable/cerebro
+```
+
+> **Tip**: You can use the default [values.yaml](values.yaml)

helm/cerebro/templates/NOTES.txt

@@ -0,0 +1,19 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range .Values.ingress.hosts }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "cerebro.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 svc -w {{ template "cerebro.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "cerebro.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  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={{ template "cerebro.name" . }},release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl port-forward $POD_NAME 8080:80
+{{- end }}

helm/cerebro/templates/_helpers.tpl

@@ -0,0 +1,32 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "cerebro.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 "cerebro.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 "cerebro.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}

helm/cerebro/templates/configmap.yaml

@@ -0,0 +1,77 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ template "cerebro.fullname" . }}
+  labels:
+    app: {{ template "cerebro.name" . }}
+    chart: {{ template "cerebro.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+data:
+  application.conf: |-
+    {{- if .Values.config.secret }}
+    secret = {{ .Values.config.secret | quote }}
+    {{- else }}
+    secret = {{ randAlphaNum 64 | quote }}
+    {{- end }}
+
+    {{- if .Values.config.tlsVerify }}
+    play.ws.ssl.loose.acceptAnyCertificate = false
+    {{- else }}
+    play.ws.ssl.loose.acceptAnyCertificate = true
+    {{- end }}
+    {{- if .Values.config.tlsCaCert }}
+    play.ws.ssl {
+      trustManager = {
+        stores = [
+          { type = "PEM", path = {{ .Values.config.tlsCaCert | quote }} }
+        ]
+      }
+    }
+    {{- end }}
+
+    basePath = {{ .Values.config.basePath | quote }}
+
+    pidfile.path = /dev/null
+
+    rest.history.size = {{ .Values.config.restHistorySize }}
+
+    data.path = "/var/db/cerebro/cerebro.db"
+
+    es = {
+      gzip = true
+    }
+
+    auth = {
+      # either basic or ldap
+      type: ${?AUTH_TYPE}
+      settings {
+        # LDAP
+        url = ${?LDAP_URL}
+        base-dn = ${?LDAP_BASE_DN}
+        method = ${?LDAP_METHOD}
+        user-template = ${?LDAP_USER_TEMPLATE}
+        bind-dn = ${?LDAP_BIND_DN}
+        bind-pw = ${?LDAP_BIND_PWD}
+        group-search {
+          base-dn = ${?LDAP_GROUP_BASE_DN}
+          user-attr = ${?LDAP_USER_ATTR}
+          user-attr-template = ${?LDAP_USER_ATTR_TEMPLATE}
+          group = ${?LDAP_GROUP}
+        }
+
+        # Basic auth
+        username = ${?BASIC_AUTH_USER}
+        password = ${?BASIC_AUTH_PWD}
+      }
+    }
+
+    hosts = [
+      {{- range $index, $element := .Values.config.hosts }}
+      {{ if $index }},{{ end }}
+      {
+        host = {{ $element.host | quote }}
+        name = {{ $element.name | quote }}
+      }
+      {{- end }}
+    ]

helm/cerebro/templates/deployment.yaml

@@ -0,0 +1,124 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ template "cerebro.fullname" . }}
+  labels:
+    app: {{ template "cerebro.name" . }}
+    chart: {{ template "cerebro.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+    {{- range $key, $value := .Values.deployment.labels }}
+    {{ $key }}: {{ $value | quote }}
+    {{- end }}
+{{- if .Values.deployment.annotations }}
+  annotations:
+{{ toYaml .Values.deployment.annotations | indent 4 }}
+{{- end }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
+  selector:
+    matchLabels:
+      app: {{ template "cerebro.name" . }}
+      release: {{ .Release.Name }}
+  template:
+    metadata:
+      labels:
+        app: {{ template "cerebro.name" . }}
+        release: {{ .Release.Name }}
+        {{- if .Values.deployment.podLabels }}
+        {{- toYaml .Values.deployment.podLabels | nindent 8 }}
+        {{- end }}
+      annotations:
+        checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
+        {{- if .Values.deployment.podAnnotations }}
+        {{- toYaml .Values.deployment.podAnnotations | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- if .Values.securityContext }}
+      securityContext:
+{{ toYaml .Values.securityContext | indent 8 }}
+      {{- end }}
+      {{- if .Values.image.pullSecrets }}
+      imagePullSecrets:
+      {{- range .Values.image.pullSecrets }}
+        - name: {{ . }}
+      {{- end }}
+      {{- end }}
+      {{- if .Values.priorityClassName }}
+      priorityClassName: {{ .Values.priorityClassName }}
+      {{- end }}
+      containers:
+        - name: {{ .Chart.Name }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          args: ["-Dconfig.file=/etc/cerebro/application.conf"]
+          ports:
+            - name: http
+              containerPort: 9000
+              protocol: TCP
+          volumeMounts:
+            - name: db
+              mountPath: /var/db/cerebro
+            - name: config
+              mountPath: /etc/cerebro
+            - name: logs
+              mountPath: /opt/cerebro/logs/
+            - name: tmp
+              mountPath: /tmp
+          {{- if .Values.volumeMounts }}
+{{ toYaml .Values.volumeMounts | indent 12 }}
+          {{- end }}
+          {{- if .Values.env }}
+          env:
+          {{- range $index, $element := .Values.env }}
+          - name: {{ $index | quote }}
+            value: {{ $element | quote }}
+          {{- end }}
+          {{- end }}
+          {{- if .Values.envFromSecretRef }}
+          envFrom:
+            - secretRef:
+                name: "{{ .Values.envFromSecretRef }}"
+          {{- end }}
+          {{- if .Values.deployment.livenessProbe.enabled}}
+          livenessProbe:
+            httpGet:
+              path: {{ .Values.config.basePath }}
+              port: http
+            initialDelaySeconds: 120
+          {{- end }}
+          {{- if .Values.deployment.readinessProbe.enabled}}
+          readinessProbe:
+            httpGet:
+              path: {{ .Values.config.basePath }}
+              port: http
+            initialDelaySeconds: 5
+          {{- end }}
+          resources:
+{{ toYaml .Values.resources | indent 12 }}
+      volumes:
+        - name: db
+          emptyDir: {}
+        - name: config
+          configMap:
+            name: {{ template "cerebro.fullname" . }}
+        - name: logs
+          emptyDir: {}
+        - name: tmp
+          emptyDir: {}
+    {{- if .Values.volumes }}
+{{ toYaml .Values.volumes | indent 8 }}
+    {{- end }}
+    {{- with .Values.nodeSelector }}
+      nodeSelector:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- with .Values.affinity }}
+      affinity:
+{{ toYaml . | indent 8 }}
+    {{- end }}
+    {{- with .Values.tolerations }}
+      tolerations:
+{{ toYaml . | indent 8 }}
+    {{- end }}