install readme.md

README.md

@@ -1,3 +1,30 @@
 # System and Service Monitoring and Analysis in a Cloud Environment with Services based on Containers
 
-This project was made as part of my thesis. You can run it by cloning the same structure of the folder as it is shown above and running it via the docker-compose.yml file, that will create multiple containers. Then you need to deploy the web-client that is developed with Vue.js by running the file "runw.sh". Visit localhost:8080 and you are right there. More of the functionality will soon be written.
+## Installation Process
+```
+git clone <insert_git_project_url>
+cd Thesis
+chmod 700 install.sh
+./install.sh
+```
+## Run Web-client
+```
+./runw.sh
+```
+## Run the rest services
+```
+docker-compose up
+```
+
+...and you are done.
+
+### You can access the web-client on and monitor some logs:
+>http://localhost:8080
+
+## Add your own Service to the system
+All you have to do is add it to the docker-compose file or run it afterwords with a simple docker run command. You need to configure the logging driver though. Example:
+```
+docker run --network="thesis_playground-net" --log-driver=fluentd --log-opt tag="mongo.node3" -p 3003:3001 dummyservice
+```
+
+You will need to mention a tag as "mongo.whateveryouwant" to be able to see your logs. If your service is a **mongoDB**, a **nodejs** app, or a **redis** you can pick the right tag so you can see your logs. Tags that are already known to the app are "mongo.node", "mongo.redis", "mongo.mongo"

install.sh

@@ -0,0 +1,9 @@
+git submodule init recursive
+echo "Installing the Web-client"
+cd playground-client && sudo npm i && cp VuetableCssConfig.js node_modules/vuetable-2/src/components
+echo "Installing the server"
+cd ../../readmongo/swarmlab-app/src && sudo npm i
+echo "Installing the dummyservice"
+cd ../../dummyservice/swarmlab-app/src && sudo npm i
+
+# cd ../../ && ./runw.sh && docker-compose up

mongo.yml

@@ -60,6 +60,7 @@
         name: mongodb
         state: present
     - name: run mongodb
-      command: sudo service mongodb start
+      become: true
+      command: service mongodb start
       # notify:
       # - start mongodb