Readme files (#71)

* HPA for worker nodes

* Adding extra line in hpa.yaml

* Umbrella chart implementation in helm charts of .yaml files

* minor changes in env and Coordinator

* Readme files for charts and resource yamls

* added readme files

Author: SarthakSingh18

.env

@@ -1,6 +1,9 @@
-UPLOAD_DIRECTORY="../Uploads"
-MONGODB_HOST="localhost"
+UPLOAD_DIRECTORY="../common/Uploads"
+MONGODB_HOST="mongo-service"
 MONGODB_PORT=27017
 UTILITIES_PATH="../Utilities"
-REDIS_URL="redis://localhost:6379"
-RESULTS_PATH="../Results"
+REDIS_URL="redis://redis-service:6379"
+RESULTS_PATH="../common/Results"
+REDIS_HOST="redis-service"
+REDIS_PORT=6379
+

Coordinator/app.py

@@ -13,7 +13,7 @@
 sys.path.insert(0, utilitiesPath)
 from scanJob import scan
 
-q = Queue(connection=Redis())
+q = Queue(connection=Redis(host=os.getenv('REDIS_HOST'),port=int(os.getenv("REDIS_PORT"))))
 
 uploadDirPath = os.getenv("UPLOAD_DIRECTORY")
 

Deployment/charts/README.md

@@ -1,2 +1,33 @@
-### Helm Chart
+# Helm Chart
 
+This helm chart implementation is an umbrella chart implementation in which there is one main chart and other charts are inside it.
+The main chart is scan8-chart inside which there are multiple charts which are dashboard_coordinator, database, worker charts.
+
+## dashboard_coordinator
+
+In dashboard_coordinator there are 4 files which are dashboard+coordinator.yaml is a deployment file for the dashboard and dashboard-service which is a service file for the dashboard deployment.
+There are other two files which are PV.yaml and PVC.yaml files which are required to use PV in pods.
+
+## database
+
+In the database chart, there are two deployments files which are of Redis and MongoDB and their respective service files.
+
+## worker
+
+In the worker chart, there are two files which are a worker.yaml(Deployment) and hpa.yaml(HPA for the worker).
+
+## Dependencies
+
+***
+
+* Helm charts installed and configured.
+
+## Usage
+
+***
+
+1. cd into the Scan8/Deployment/charts.
+
+2. helm install "chart name you want to give" scan8-chart.
+
+3. Use any web browser to access the IP address (by default it is http://127.0.0.1:30110/).

Deployment/charts/scan8-chart/charts/dashboard_coordinator/templates/dashboard+coordinator.yaml

@@ -21,8 +21,8 @@ spec:
         imagePullPolicy: Never
         resources:                                                                            
           limits:
-            memory: "500Mi"
-            cpu: "800m"
+            memory: "128Mi"
+            cpu: "200m"
         ports:
         - containerPort: 5000
         stdin: true

Deployment/charts/scan8-chart/charts/dashboard_coordinator/templates/dashboard-service.yaml

@@ -8,4 +8,4 @@ spec:
     app: dashboard-coordinator                           #selctor for deployment
   ports:
   - port: 5000                                           #target port for container in pod
-    nodePort: 30109                                      #target port for the service
+    nodePort: 30110                                      #target port for the service

Deployment/charts/scan8-chart/charts/worker/templates/worker.yaml

@@ -22,10 +22,10 @@ spec:
         resources:
           requests:
             memory: "128Mi"
-            cpu: "500m"
+            cpu: "200m"
           limits:
             memory: "128Mi"
-            cpu: "700m"
+            cpu: "300m"
         stdin: true
         tty: true
         volumeMounts:

Deployment/resource yamls/README.md

@@ -1,2 +1,32 @@
-### Resource Yamls
+# Resource Yamls
 
+In this directory here are .yaml files which are used in scan8-chart.
+Subdirectories contain specific .yaml files.
+
+## deployment
+
+***
+
+In the deployment directory, there are deployment files of Dashboard+Coordinator, Mongo, Redis and Worker.
+
+## hpa
+
+***
+
+In hpa, there are two files
+
+1. hpa.yaml is targetting the worker deployment and monitoring the CPU utilization of that deployment.
+
+2. components.yaml which is used as a metrics server and helps to get the metrics of the deployments.
+
+## pv
+
+***
+
+There are other two files which are PV.yaml and PVC.yaml files which are required to use PV in pods.
+
+## service
+
+***
+
+This repository contains service files for all the deployments.