Feature/25 update k8s readme

.github/workflows/build.yml

@@ -43,3 +43,10 @@ jobs:
       run: |
         sleep 120
         docker run --network container:psi-todo appropriate/curl -s --retry 10 --retry-connrefused http://localhost:8080/actuator/health
+    - name: Failure Result
+      if: ${{ failure() }}
+      run: |
+        docker logs mysql
+        docker logs psi-todo
+
+

todo-app/README.md

@@ -83,8 +83,8 @@ The following table lists the configurable parameters of the TodoApp swarm clust
   `BASIC_AUTH_USERNAME` | Username of Basic-Auth | ``                    
   `BASIC_AUTH_PASSWORD` | Password of Basic-Auth | ``                            
   `MYSQL_IMAGE_TAG` | Image tag for Mysql | `8.0.22`                                
-  `MYSQL_USER` | Username of new user to create | `root`        
-  `MYSQL_PASSWORD` | Password for the new user | `root`            
-  `MYSQL_DATABASE` | Name for new database to create | `psi`                
-  `MYSQL_DATA_SRC_PATH` | Host path for persistence mysql data | ``                    
-  `MYSQL_DATA_DEST_PATH` | Mount directory path in mysql container | `/var/lib/mysql`       
+  `MYSQL_USER` | Username of new user to create | ``        
+  `MYSQL_PASSWORD` | Password for the new user | ``            
+  `MYSQL_ROOT_PASSWORD` | Password for the root user | ``              
+  `MYSQL_DATABASE` | Name for new database to create | ``                
+  `MYSQL_DATA_SRC_PATH` | Host path for persistence mysql data | ``                    

todo-app/docker-compose.yaml

@@ -3,8 +3,10 @@ services:
   psimysql:
     image: mysql:${MYSQL_IMAGE_TAG}
     environment:
+      MYSQL_USER: ${MYSQL_USER}
       MYSQL_DATABASE: ${MYSQL_DATABASE}
-      MYSQL_ROOT_PASSWORD: ${MYSQL_PASSWORD}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
   psitodoapp:
     image: psi-todo:${PSI_TODO_IMAGE_TAG:-latest}
     depends_on:

todo-app/env/ci/Docker.env

@@ -2,7 +2,7 @@
 
 # Mysql variables
 MYSQL_IMAGE_TAG=8.0.22
-MYSQL_USER=root
-MYSQL_PASSWORD=root
-MYSQL_DATABASE=psi
-MYSQL_DATA_DEST_PATH=/var/lib/mysql
+MYSQL_USER=psi
+MYSQL_PASSWORD=psi
+MYSQL_ROOT_PASSWORD=root
+MYSQL_DATABASE=psi

todo-app/env/local/Docker.env

@@ -11,8 +11,8 @@ PSI_TODO_STACK_IMAGE=localhost:5000/psi-todo
 
 # Mysql variables
 MYSQL_IMAGE_TAG=8.0.22
-MYSQL_USER=root
-MYSQL_PASSWORD=root
+MYSQL_USER=psi
+MYSQL_PASSWORD=psi
+MYSQL_ROOT_PASSWORD=root
 MYSQL_DATABASE=psi
 #MYSQL_DATA_SRC_PATH=
-MYSQL_DATA_DEST_PATH=/var/lib/mysql

todo-app/env/local/docker-compose-override.yml

@@ -3,7 +3,7 @@ services:
   psimysql:
     container_name: mysql #Specify a custom container name, rather than a generated default name 
     volumes: 
-      - mysql_data:${MYSQL_DATA_DEST_PATH}:cached   # Strong consistency is quite expensive, requiring coordination between all of a files writers to guarantee 
+      - mysql_data:/var/lib/mysql:cached   # Strong consistency is quite expensive, requiring coordination between all of a files writers to guarantee 
                                                       # they don’t inappropriately clobber each other’s changes
                                                       # So Relax consistency guarantees using `cached` mode (Don’t do this in production …)
   psitodoapp:

todo-app/env/local/docker-stack-persistent-compose-override.yml

@@ -2,7 +2,7 @@ version: "3"
 services:
   psimysql:
     volumes: 
-      - mysql_data:${MYSQL_DATA_DEST_PATH}:cached   # Strong consistency is quite expensive, requiring coordination between all of a files writers to guarantee 
+      - mysql_data:/var/lib/mysql:cached   # Strong consistency is quite expensive, requiring coordination between all of a files writers to guarantee 
                                                       # they don’t inappropriately clobber each other’s changes
                                                       # So Relax consistency guarantees using `cached` mode (Don’t do this in production …)
 volumes:

todo-app/k8s/ChocolateyInstallNonAdmin.ps1

@@ -0,0 +1,13 @@
+# Set directory for installation - Chocolatey does not lock
+# down the directory if not the default
+$InstallDir='C:\ProgramData\chocoportable'
+$env:ChocolateyInstall="$InstallDir"
+
+# If your PowerShell Execution policy is restrictive, you may
+# not be able to get around that. Try setting your session to
+# Bypass.
+Set-ExecutionPolicy Bypass -Scope Process -Force;
+
+# All install options - offline, proxy, etc at
+# https://chocolatey.org/install
+iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

todo-app/k8s/CreateInternalSwitch.ps1

@@ -0,0 +1,2 @@
+# Create an internal switch
+New-VMSwitch -name minikube -SwitchType Internal

todo-app/k8s/EnableHyperV.ps1

@@ -0,0 +1,5 @@
+# Check and Enable Hyper-V If not enabled
+if ((Get-WindowsOptionalFeature -FeatureName Microsoft-Hyper-V-All -Online).State -ne 'Enabled')
+{
+    Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All
+}

todo-app/k8s/README.md

@@ -1,55 +1,50 @@
-# Deploy Todo Application in K8s cluster using helm
+# Deploy Todo Application to K8s cluster using helm
 
-- Setup minikube  
-    https://minikube.sigs.k8s.io/docs/start/    
+- Local Deployment
 
+## Local Deployment ##
+
+- Setup minikube
+
+   Install  Dependencies and run minikube
+
+    ```bash
+       bash setup.sh bootlocal  
+    ```
+
  - Link host docker client to the VM's docker daemon
 
- ```bash
-    eval $(minikube docker-env)
- ```
+    ```bash
+       eval $(minikube docker-env)  
+    ```
  - Build
 
     [Build & Create Docker Image](../README.md#build)
 
  - Deploy  mysql
-
-    ```bash
-       helm install mysql ./mysql -f env/<env>/mysql-secret.yaml
-    ```
-    or
-
-    ```bash
-       helm install mysql ./mysql -f env/<env>/mysql-secret.yaml -f env/<env>/mysql-values.yaml
-    ```
+
+    [Deploy MySql using helm](mysql/README.md#Installing%20the%20Chart)
 
  - Deploy Todo-app    
 
-    ```bash
-       helm install psi-todo ./psi-todo
-    ```  
-    or
-
-    ```bash
-       helm install psi-todo ./psi-todo -f env/<env>/psi-todo-secret.yaml -f env/<env>/psi-todo-values.yaml
-    ```  
+    [Deploy Todo App  using helm](psi-todo/README.md#Installing%20the%20Chart)
 
  - Verify all pods are up and running
 
- ```bash
-   $ kubectl get pods
-    NAME                         READY   STATUS    RESTARTS   AGE
-    psi-todo-6f4f69b7d7-8t8kg    1/1     Running   0          92m
-    mysql-58b87bf444-pshmk       1/1     Running   0          92m
-    
- ```
+    ```bash
+      $ kubectl get pods
+       NAME                         READY   STATUS    RESTARTS   AGE
+       psi-todo-6f4f69b7d7-8t8kg    1/1     Running   0          92m
+       mysql-58b87bf444-pshmk       1/1     Running   0          92m
+
+    ```
 
  - Execute below command in a separate terminal which creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP.
 
- ```bash
-     minikube tunnel
- ```
+    ```bash
+        minikube tunnel
+    ```
 
  - Access swagger api endpoint with below url.
 
-    http://localhost:8080/swagger-ui/
+    http://localhost:8080/swagger-ui/

todo-app/k8s/mysql/README.md

@@ -0,0 +1,77 @@
+#  MySql Helm Chart
+
+
+## Introduction
+
+This chart bootstraps a single node MySQL deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+
+## Prerequisites
+
+- Kubernetes 1.19.2
+- PV provisioner support in the underlying infrastructure
+
+## Installing the Chart
+
+To install the chart with the release name `mysql` with respective environment secret file:
+
+```bash
+# Verify the configuration 
+$ helm install --dry-run --debug mysql mysql -f mysql/env/<env>/secrets.yaml
+
+# Install chart
+$ helm install mysql mysql -f mysql/env/<env>/secrets.yaml
+```
+
+To install the chart with the release name `mysql` with respective environment secret and configuration file:
+
+```bash
+# Verify the configuration 
+$ helm install --dry-run --debug mysql mysql -f mysql/env/<env>/secrets.yaml -f mysql/env/<env>/values.yaml
+
+# Install chart
+$ helm install mysql mysql -f mysql/env/<env>/secrets.yaml -f mysql/env/<env>/values.yaml
+```
+
+## Uninstalling the Chart
+
+To uninstall/delete the `mysql` deployment:
+
+```bash
+$ helm uninstall mysql
+```
+
+## Configuration
+
+The following table lists the configurable parameters of the MySQL chart and their default values.
+
+| Parameter                                    | Description                                                                                  | Default                                              |
+| -------------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
+| `replica`                                 | Number of instance to run at any time                                                      | 1 |
+| `image`                                        | `mysql` image configuration.                                                               | ` ` |
+| `image.repository`                             | `mysql` image repository.                                                                  | `mysql`|
+| `image.pullPolicy`                             | `mysql` image pull policy.                                                                 | `IfNotPresent`|
+| `image.tag`                                    | `mysql` image tag.                                                                         | `8.0.22`|
+| `service`                                      | `mysql` service configuration                                                              | ` ` |
+| `service.type`                                 | Kubernetes service type                                                                    | `ClusterIP`|
+| `service.port`                                 | Service Port to be exposed outside                                                         | 3306 |
+| `resources`                                    | `mysql` CPU/Memory resource requests/limits                                                | `{}` |
+| `persistence`                                  | persistence is to recover data after pod kill                                              | `{}` |
+| `persistence.enabled`                          | persistence is enabled or not                                                              | `false `  |
+| `persistence.storageClass`                     | Type of persistent volume claim                                                            | ` `  |
+| `persistence.accessMode`                       | ReadWriteOnce or ReadOnly                                                                  | ` `  |
+| `persistence.size`                             | Size of persistent volume claim                                                            | ` `  |
+| `persistence.hostPath`                         | HostPath of the volume to mount                                                            | ` `  |
+| `config`                                       | Configuration for mysql                                                                    | `{ database: psi }`  |
+| `config.database`                              |  Database name                                                                             | `psi`|
+| `username`                                     |  Database user name                                                                        | ` `  |
+| `password`                                     |  Database password                                                                         | ` `  |
+| `rootPassword`                                  |  Database root user password                                                              | ` `  |
+| `nodeAffinity`                                 | Assign Pods to Nodes using Node Affinity                                                   | `[]` |
+
+
+
+## Persistence
+
+A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes. It is a resource in the cluster just like a node is a cluster resource. PVs are volume plugins like Volumes, but have a lifecycle independent of any individual Pod that uses the PV, so even if the application pod gets down still the backend data will be retained and when applicatin pod will be up then , persisted data can be accessed.
+
+PersistentVolume will be created if `persistence.enabled` is set to `true` and if true then data will be  mounted into specified directory. In order to disable this functionality `persistence.enabled` should be set to `false`.

todo-app/k8s/mysql/env/local/secrets.yaml

@@ -0,0 +1,4 @@
+username: psi
+password: psi
+rootPassword: root
+

todo-app/k8s/mysql/env/local/values.yaml

@@ -0,0 +1,16 @@
+nodeAffinity:
+  requiredDuringSchedulingIgnoredDuringExecution:
+    nodeSelectorTerms:
+      - matchExpressions:
+         - key: kubernetes.io/hostname
+           operator: In
+           values:
+             - minikube
+
+persistence:
+  enabled: true
+  storageClass: local 
+  accessMode: 
+    - ReadWriteOnce
+  size: 1Gi
+  hostPath: /mnt/data

todo-app/k8s/mysql/templates/config.yaml

@@ -8,6 +8,9 @@ metadata:
     release: "{{ .Release.Name }}"
 data:
   url: {{ template "mysql.fullname" . }}
-{{- range $key, $val := .Values.mysqlConfig }}
+{{- if not .Values.config.database }}
+{{- fail "Database name is required" }}  
+{{- end }}
+{{- range $key, $val := .Values.config }}
   {{ $key }}: {{ $val | quote }}
 {{- end }}