Merge pull request #753 from MeVitae/k8s-dabase-update

Add persistent storage to mysql database in K8s and a volume in docker-compose

Author: blabla1337

Docker/alpine-cloud/k8s/Deployment_mysql.yaml

@@ -15,6 +15,21 @@ spec:
     app.kubernetes.io/name: mysql
     app.kubernetes.io/instance: mysql
 ---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: mysql-pv-claim
+  labels:
+    app.kubernetes.io/name: mysql
+    app.kubernetes.io/instance: mysql
+    app.kubernetes.io/version: "2.2.2"
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 8Gi
+---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -35,12 +50,19 @@ spec:
         app.kubernetes.io/name: mysql
         app.kubernetes.io/instance: mysql
     spec:
+      volumes:
+      - name: mysql-storage
+        persistentVolumeClaim:
+          claimName: mysql-pv-claim
       containers:
         - name: mysql
           image: blabla1337/mysql
           imagePullPolicy: IfNotPresent
           ports:
           - containerPort: 3306
+          volumeMounts:
+          - name: mysql-storage
+            mountPath: /var/lib/mysql
           env:
           -  name: MYSQL_DEFAULT_USER
              valueFrom:
@@ -62,4 +84,4 @@ spec:
                configMapKeyRef:
                  name: mysql
                  key: MYSQL_DATABASE            
----
+---

docker-compose.yml

@@ -23,6 +23,8 @@ services:
       MYSQL_DEFAULT_USER: 'root'
     ports:
       - '3306:3306'
+    volumes:
+       - mysql_data:/var/lib/mysql
 
   nginx:
     container_name: skf-nginx_container
@@ -70,3 +72,5 @@ services:
       #- SKF_LABS_DEPLOY_MODE=subdomain
       #- JWT_ENABLED="False"
       #- SKF_DOJO_API_KEY=
+volumes:
+  mysql_data: {}

installations/Kubernetes/README.md

@@ -76,8 +76,14 @@ Horizontal auto-scaling for the API server. You might want to change the `minRep
 
 ## `Deployment_mysql.yaml`
 
-MySQL service and deployment. Authentication variables are set in `configmaps.yaml` and also used by
-`Deployment_backend.yaml`.
+MySQL service, persistent volume claim and deployment. Authentication variables are set in
+`configmaps.yaml` and also used by `Deployment_backend.yaml`. The persistent volume requests 8GiB by
+default.
+
+If you're deploying to a cloud provider, you might want to use their database service instead and
+not deploy this. The database URL is set in `configmaps.yaml`.
+
+If this is used, make sure you back up the persistent volume!
 
 ## `Deployment_rabbitmq.yaml`
 

installations/docker/README.md

@@ -21,7 +21,7 @@ First we want to select “Enable Kubernetes” after which we press on “Apply
 For Linux users you may want to look at Minikube for deploying locally. Alternatively if you do not want to go through all the hassle of installing a local kubernetes cluster you can also provide the configuration file from the cloud provider of your choosing, or simply choose to clone the lab repository and run them as flask applications with python as described here. After setting up our local cluster it is time to perform a “docker-compose up” command in the root directory of the SKF project.
 
 WARNING, before doing below steps make sure you selected the right context (docker-desktop)
-Now we need to edit the docker-compose.yaml file and change the value LABS_KUBE_CONF to the new value:
+Now we need to edit the docker-compose.yaml file and change the value `LABS_KUBE_CONF` to the new value:
 ```
   # Below is the variable where we place the base64 string that will be used in the .kube/config file in the cluster
   # file for example: cat ~/.kube/config | base64
@@ -45,7 +45,15 @@ If you are done don't forget to kill it again with:
 docker-compose down
 ```
 
-5. Location of SKF images
+To clear the database, too:
+```
+docker-compose down --volumes
+```
+
+5. By default, the login will be skipped when using docker compose locally. To change this, update
+   the value of `SKIP_LOGIN` to `skfprovider` in `docker-compose.yml`.
+
+6. Location of SKF images
 We also have a list of old OWASP-SKF Docker images available:
 
 Angular: