Merge pull request #1 from appbaseio/initial

Initial

README.md

@@ -1,3 +1,131 @@
 # helm-charts
 
 Helm charts for appbase.io, an API gateway for a supercharged Elasticsearch experience.
+Via this Helm Chart you can localize Appbaseio on your kubernetes engine.
+
+## Requirements
+You should have your **Kubernetes** cluster installed and configured and then you should install [helm]("https://helm.sh/docs/intro/install/")
+
+As Arc is an API gateway for your Elasticsearch, make sure that you already have an Elasticsearch cluster with it's basic credentials.
+
+If you don't have an Elasticsearch cluster, you can use this [guide]("https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-quickstart.html")
+
+## Why Helm Charts:
+
+Helm helps you manage Kubernetes applications — Helm Charts help you define, install, and upgrade even the most complex Kubernetes application.
+
+Charts are easy to create, version, share, and publish — so start using Helm and stop the copy-and-paste.
+
+Here we get benefit of Helm Charts to package Arc (which is an API Gateway that sits between a client and an ElasticSearch cluster) and install it in seconds.
+
+## How to install Appbaseio Helm Chart
+
+1- run `helm repo add appbase`
+
+2- run `helm install appbase --set <variables>`
+
+Make sure that you set below variables which are mandatory:
+
+- `elasticsearch.clusterURL`
+
+- `appbase.id`
+
+- `appbase.username` :if you don't set this variable, by default will be set as "admin" 
+- `appbase.password` :if you don't set this variable, by default will be set as "admin"
+
+
+## Configure the cluster with Values
+
+According to Helm chart [values]("https://helm.sh/docs/chart_template_guide/values_files/") you can customize the cluster in the way you want by set variables during the install.
+We categorized variables in order to ease it's readability, for example `elasticsearch.clusterURL`  means clusterURL is a subset of elasticsearch but while setting a vaiable we should follo it's indentation. 
+Here are the variables you can set for your cluster:
+|  Name |Default Value   | Kind  |  Description |
+|---|---|---|---|
+| elasticsearch.clusterURL  | ""  | String  |  clusterURL based on basic authentication. fluent-bit splites this clusterURL soit should be in following pattern: "http://<user>:<password>@domain:port" ( Prtotocol Can also be -> https)  |
+|  arc.name | arc  |  String | It's the name of Arc service which you can use to access your application via service name  |
+|  arc.image |  appbaseio/arc | String  |  This is the image Appbase.io provides as gateway for your elasticsearch, if you have your local repository, you can push Arc image into that then change the URL here. |
+|  arc.port | 8000  | Integer  | The port that used for Arc service |
+| appbase.id  |  "" |  String |  This is **APPBASE_ID** that you can get from [Appbase.io]("https://arc-dashboard.appbase.io/install") |
+|  appbase.username | admin  |  String |  This is the username you choose for your Appbaseio |
+| appbase.password  | admin  |  String | This is the password you choose for your Appbaseio  |
+|  appbase.domain |  "" |  String |  If you are installing helm chart on your production and want to assigne a domain to it, set this variable to your domain, make sure that your loadBalancer.serviceType to be empty ("") |
+|  volume.name | pv  | String  |  If you want  to use default volume, leave name empty but if you want to use your Persistent volume, enter it's name, the PVC ( persistent volume claim) will be assigned to it |
+|  volume.storageClassName |  standard | String  | Your Storage class which should be the same with PVC, if you have a specific class for your Volume, set that here to also be set for PVC  |
+| volume.accessModes  | ReadWriteMany  |  String |  Access mode for volume |
+|  volume.storageSize | 1Gi  | String  | This is the size of PVC storage, Default volume size is 5Gi which you can handle how much of it be assigned to PVC  |
+|  volume.pvcName | pvc  | String  |  You can change PVC (Persitent Volume Claim) name here, it's assigned to PV(Persistent Volume) |
+|  cert.name | ssl  | String  | you can add your certificate here by configuring below values. name is the name of secret file containing your certificate information, if you have your own secret file, you can only fill the name value and leave the other empty  |
+| cert.tlsCrt  |  "" | String  |  "tlsCrt" is your "tls.crt" |
+|  cert.tlsKey | ""  | String  | "tlsKey" is "tls.key"  |
+|  cert.caCrt |  "" |  String |  "caCrt" is "ca.crt" |
+| loadBalancer.serviceType  | ""  | String  |If yo're using kubernetes locally and as you won't have external IP, Can be "NodePort" but if it's your production kubernetes, you can leave it empty which means serviceType is : "LoadBalancer"|
+
+**Tips:**
+
+- Some variables might be long to use in install command, so you can export it and then use it e.g.
+
+     `export $(ES_ClusterURL=<your elasticsearch URL with basec authentication>)`
+
+     then you can use it while installing helm:
+
+     `helm install appbase --set elasticsearch.clusterURL=ES_ClusterURL`
+
+## Kubernetes Distribution support:
+You can check [this page]("https://helm.sh/docs/topics/kubernetes_distros/") to see what distros Helm is currently supporting
+## Test on Minikube
+
+1- Make sure your Minikube is installed, if not, use [this]("https://minikube.sigs.k8s.io/docs/start/") and if you don't have kubectl installed, use this [link]("https://kubernetes.io/docs/tasks/tools/")
+
+2- Add Appbase helm repo and install it as it's said 
+
+    Make sure that you set loadBalancer.serviceType=NodePort
+
+3- After you install helm chart setting loadBalancer.serviceType=NodePort, you will see this result:
+![image](https://user-images.githubusercontent.com/30385958/122102140-5bdb9e80-ce2a-11eb-960b-921c64a298e5.png)
+
+Which you can use the command to get access to your Appbaseio service
+
+    If you changr arc.name, the command will be: minikube service --url <arc name>-nodeport
+
+## How to use it by cloning the project
+1- Clone this repositoy: 
+
+`git clone [email protected]:appbaseio/helm-charts.git` 
+
+and then head to `helm-charts` folder.
+
+
+2- Now you should config helm chart to connect appbaseio to your elasticsearch: 
+
+open **values.yaml** from `helm-charts/appbaseio/values.yaml` and fill the values you might need.
+These are required values you must fill: 
+
+- **Elasticsearch Domain**: This can be your Kubernetes service name or a valid domain which is reachble from your kubernetese cluster
+- **Elasticsearch Username**: by default this username is `elastic` but if you have changed your ES_USERNAME, should change it here
+- **Elasticsearch Password**: this is your decrypted password which you can leave empty here as we can change it while installing our helm chart. we will see that in following.
+- **APPBASE_ID**: to get this, head to [Appbase]("https://arc-dashboard.appbase.io/install") and enter your email, You will receive an OTP on an entered email address. Enter OTP to verify the email address and then `APPBASE_ID` will be sent to our email.
+
+- **APPBASE_USERNAME**: This will be used while using appbaseio so you can choose your desired username by filling the variable
+- **APPBASE_PASSWORD**: This will be used while using appbaseio so you can choose your desired password by filling the variable
+
+you can leave other settings as their default value but if you want more setting like use your own volume as storage, use SSL certificate for your Appbase cluster and so on, modify the related part.
+
+**Note:**
+- handle arc version in Chart.yaml as **appVersion**
+
+3- We can set above values while running helm chart install command, the value will be replaced with what we have in values.yaml for example here we install appbase chart with setting the ES_PASSWORD 
+
+- If you have a Kubernetes cluster, run below command :
+
+`PASSWORD=$(kubectl get secret <your elasticsearch service name> -o go-template='{{.data.elastic | base64decode}}')`
+
+    This Command will get ES_PASSWORD from ES secret, make sure to change your elasticsearch service name
+
+Now it's time to install our chart: 
+
+`helm install appbaseio appbaseio/ --values appbaseio/values.yaml --set elasticsearch.esPassword=$PASSWORD `
+
+To get more information about set value in helm install, take a look at this [page]("https://helm.sh/docs/helm/helm_install/")
+4- Wait until your pods are in "Running" stat (see their status by `kubectl get pods`) and the LoadBalancer service is up and have an external IP (use this command: `kubectl get svc --namespace ingress-nginx`) 
+
+When everything is OK you can access your Appbase with LoadBalancer IP and it's Port then you can go to [Arc dashboard]("https://arc-dashboard.appbase.io/login") to handle your elasticsearch visually

appbaseio/.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/

appbaseio/Chart.yaml

@@ -0,0 +1,14 @@
+apiVersion: v2
+name: appbaseio
+description: A Helm chart for Kubernetes
+
+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: "7.45.0-beta"

appbaseio/templates/NOTES.txt

@@ -0,0 +1,6 @@
+{{- if eq .Values.loadBalancer.serviceType "NodePort"}}
+Use below command to connect to get appbaseio Access URL:
+minikube service --url {{ .Values.arc.name }}-nodeport
+
+** If you're not using minikube, you can set loadBalancer.serviceType to "LoadBalancer"
+{{ end }}

appbaseio/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "appbaseio.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 "appbaseio.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 "appbaseio.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "appbaseio.labels" -}}
+helm.sh/chart: {{ include "appbaseio.chart" . }}
+{{ include "appbaseio.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "appbaseio.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "appbaseio.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "appbaseio.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "appbaseio.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

appbaseio/templates/appbaseio.yaml

@@ -0,0 +1,64 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    name:  {{ .Values.arc.name }} 
+  annotations:
+    deployment.kubernetes.io/revision: "1"
+  generation: 1
+  name: {{ .Values.arc.name }}
+spec:
+  selector:
+    matchLabels:
+      app: {{ .Values.arc.name }}
+  strategy:
+    type: RollingUpdate
+  template:
+    metadata:
+      creationTimestamp: null
+      labels:
+        app: {{ .Values.arc.name }}
+    spec:
+      containers:
+        - env:
+            - name: USERNAME
+              value: {{ .Values.appbase.username }}
+            - name: PASSWORD
+              value: {{ .Values.appbase.password }}
+            - name: APPBASE_ID
+              value: {{ .Values.appbase.id }}
+            - name: ES_CLUSTER_URL
+              value: {{ .Values.elasticsearch.clusterURL }}
+            - name: LOG_FILE_PATH
+              value: "/mnt/data/es.json"
+          image: {{.Values.arc.image}}:{{.Values.arc.tag | default .Chart.AppVersion}}
+          imagePullPolicy: IfNotPresent
+          name: {{ .Values.arc.name }}
+          ports:
+            - containerPort: {{ .Values.arc.port }}
+              name: http
+              protocol: TCP
+          volumeMounts:
+            - name: arcdata
+              mountPath: /mnt/data
+              subPath: es.json
+      volumes:
+        - name: arcdata
+          persistentVolumeClaim:
+            claimName: {{ .Values.volume.pvcName }}
+
+  replicas: {{ .Values.arc.nodes }}
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Values.arc.name }}
+  labels:
+    app: {{ .Values.arc.name }}
+spec:
+  type: ClusterIP
+  ports:
+    - port: {{ .Values.arc.port }}
+      targetPort: {{ .Values.arc.port }}
+  selector:
+    app: {{ .Values.arc.name }}

appbaseio/templates/cert.yaml

@@ -0,0 +1,12 @@
+{{ if .Values.cert.tlsCrt}}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ .Values.cert.name }}
+type: Opaque
+data:
+  tls.crt: {{ .Values.cert.tlsCrt }}
+  tls.key: {{ .Values.cert.tlsKey }}
+  ca.crt: {{ .Values.cert.caCrt }}
+
+{{ end }}