Merge pull request #50 from rothgar/kubernetes

Kubernetes manifest examples and README

README.md

@@ -113,6 +113,8 @@ See the [offical Upgrade Guide](http://docs.mattermost.com/administration/upgrad
 If you want to know how to use docker-compose, see [the overview
 page](https://docs.docker.com/compose).
 
+If you want to run Mattermost on Kubernetes you can start with the [manifest examples in the kubernetes folder](contrib/kubernetes/README.md)
+
 For the server configurations, see [prod-ubuntu.rst] of mattermost.
 
 [docker]: http://docs.docker.com/engine/installation/

contrib/kubernetes/README.md

@@ -0,0 +1,110 @@
+Mattermost on Kubernetes
+=======
+
+You can use these manifests as a starting point to run Mattermost on Kubernetes.
+
+If you already have a Kubernetes cluster you can skip this first step.
+
+### Start local Kubernetes cluster
+
+To get started we can use [minikube](https://github.com/kubernetes/minikube/) to run a local kubernetes cluster.
+
+Download and install minikube and any dependancies for your operating system (see minikube readme). You will also need to install [kubectl](http://kubernetes.io/docs/user-guide/prereqs/).
+
+Start the minikube VM and Kubernetes API server
+
+```
+minikube start
+```
+
+### Start a Postgres database
+
+#### WARNING: The database is not backup up and will lose all data if the pod is restarted. Consider using a [persistent volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) for storing pgdata
+
+This will run a postgres deployment with default values for database name, username, and password.
+
+```
+kubectl run postgres --image=postgres:9 \
+  --env="POSTGRES_PASSWORD=mmuser_password" \
+  --env="POSTGRES_DB=mattermost" \
+  --env="POSTGRES_USER=mmuser"
+```
+Expose the postgres database as a service named "db"
+```
+kubectl expose deployment postgres \
+  --name=db \
+  --port 5432 \
+  --target-port 5432
+```
+
+### Run Mattermost container
+
+The Mattermost application is split into three manifests.
+
+First, create the secret which will set the environment varibles for the main application container. If you changed the values for the Postgres container you will also need to set the values in mattermost.secret.yaml using the [manual steps for creating a secret](http://kubernetes.io/docs/user-guide/secrets/#creating-a-secret-manually).
+```
+kubectl create -f mattermost.secret.yaml
+```
+Next create the Mattermost deployment (main application) with
+```
+kubectl create -f mattermost.deployment.yaml
+```
+You should check that the pod started successfully with 
+```
+kubectl get po -l app=mattermost
+NAME                              READY     STATUS    RESTARTS   AGE
+mattermost-app-1605216003-fvnz1   1/1       Running   0          44m
+```
+
+Finally, you can expose the application with a service so you can easily access the application from a web browser. The example service is using a `type: NodePort` which means it will be exposed on a random high port on your cluster nodes (or minikube VM if you're using minikube). If you are running your Kubernetes cluster in AWS or GCE you should change the type to loadBalancer.
+```
+kubectl create -f mattermost.svc.yaml
+```
+Now you can get your VM's IP address with 
+```
+minikube ip
+192.168.99.100
+```
+and the exposed port for the application with
+```
+kubectl describe svc mattermost
+Name:                   mattermost
+Namespace:              default
+Labels:                 <none>
+Selector:               app=mattermost,tier=app
+Type:                   NodePort
+IP:                     10.0.0.194
+Port:                   http    80/TCP
+NodePort:               http    32283/TCP
+Endpoints:              172.17.0.4:80
+Session Affinity:       None
+No events.
+```
+Make sure the Endpoints shows an IP address. This should correlate to the pod IP started by the deployment.
+
+Now browse to your node IP and exposed NodePort in your browser to view the application or test it with curl
+
+```
+curl -L http://192.168.99.100:32283
+```
+
+### Optional steps
+
+ * If you want your data to be persistent you will need to make persistent volumes for Mattermost and Postgres.
+ * If you want to change advanced settings for the mattermost container you can make a [configMap](http://blog.kubernetes.io/2016/04/configuration-management-with-containers.html) for the /mattermost/config/config.json file
+ * If you want the application exposed on port 80 you can either specify the port in the service manifest or use an [ingress controller](http://kubernetes.io/docs/user-guide/ingress/#ingress-controllers) and an ingress map for the mattermost service. A sample ingress map would be
+```
+---
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: mattermost
+spec:
+  rules:
+  - host: mattermost
+    http:
+      paths:
+      - backend:
+          serviceName: mattermost
+          servicePort: 80
+```

kubernetes/mattermost.deployment.yaml

@@ -0,0 +1,61 @@
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+  name: mattermost-app
+  labels:
+    app: mattermost
+    tier: app
+  namespace: default
+spec:
+  replicas: 1
+  template:
+    metadata:
+      name: mattermost-app
+      labels:
+        app: mattermost
+        tier: app
+    spec:
+      containers:
+      - name: mattermost-app
+        image: "mattermost/mattermost-prod-app:3"
+        env:
+        - name: DB_HOST
+          valueFrom:
+            secretKeyRef:
+              name: mattermost.env
+              key: db-host
+        - name: DB_PORT
+          valueFrom:
+            secretKeyRef:
+              name: mattermost.env
+              key: db-port
+        - name: MM_USERNAME
+          valueFrom:
+            secretKeyRef:
+              name: mattermost.env
+              key: mm-username
+        - name: MM_PASSWORD
+          valueFrom:
+            secretKeyRef:
+              name: mattermost.env
+              key: mm-password
+        - name: MM_DBNAME
+          valueFrom:
+            secretKeyRef:
+              name: mattermost.env
+              key: mm-dbname
+        volumeMounts:
+        # optional persistant storage
+        #- name: appdata
+          #mountPath: /mattermost/data
+        - name: etclocaltime
+          mountPath: /etc/localtime
+          readOnly: true
+      volumes:
+      # optional persistant storage
+      #- name: appdata
+        #persistentVolumeClaim:
+        #  claimName: mattermost-app
+      - name: etclocaltime
+        hostPath:
+          path: /etc/localtime

kubernetes/mattermost.secret.yaml

@@ -0,0 +1,19 @@
+kind: Secret
+apiVersion: v1
+metadata:
+  name: mattermost.env
+  namespace: default
+type: Opaque
+data:
+  # see http://kubernetes.io/docs/user-guide/secrets/#creating-a-secret-using-kubectl-create-secret
+  # for creating secrets manually
+    # db
+  db-host: ZGI=
+    # 5432
+  db-port: NTQzMg==
+    # mmuser
+  mm-username: bW11c2Vy
+    # mmuser_password
+  mm-password: bW11c2VyX3Bhc3N3b3Jk
+    # mattermost
+  mm-dbname: bWF0dGVybW9zdA==

kubernetes/mattermost.svc.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: mattermost
+  namespace: default
+spec:
+  type: NodePort
+  ports:
+  - port: 80
+    targetPort: 80
+    protocol: TCP
+    name: http
+  selector:
+    app: mattermost
+    tier: app