CS3219-AY22/23 G57

Deploying all services at once method 1 : kubernetes

Updating the environment files

1. Update .env file for frontend. Use the credentials stated in frontend/.env.sample.
2. You will need to create your own firebase project with a realtime database to get the codepad to work.
3. Update .env file for (PUBNUB) chat-service. You will need to create your own PUBNUB project for the chat service to work.

Creating and Initialising a local kubernetes cluster

1. Build all the backend services docker images: sh k8s-ms-docker-build.sh
2. Go to the k8s directory
3. Create local kubenetes cluster: sh cluster-create.sh
4. Load all the backend services docker images into the cluster: sh cluster-image-setup.sh
5. Create all the database and ingress-controller kubernetes objects by running all the manifest files: sh dependencies-setup.sh
6. Ensure that all the dependencies are running before continuing to the next step. Check using kubectl get po and ensure all pods are up and running. You can check the ingress controller using kubectl -n ingress-nginx get deploy -w
7. Create all the microservices and ingress kubernetes objects by running all the manifest files: sh microservices-setup.sh

Populating the questionservicedb

1. It is intended that the databases inside the cluster are not accessible from the outside. However we need a one time population of the questionservicedb
2. You can do this by exposing the questionservicedb temporarily using kubectl port-forward svc/questionservicedb 5434:5432
3. Run question-service/database/data.sql in your question-service database to populate the db
4. Cancel the port-forward Ctrl + C

Running the frontend

1. Since the frontend exists outside of the kubernetes cluster, we deploy it separately
2. Build and run the frontend using sh k8s-frontend.sh

Adjusting the number of backend services

1. You can adjust the number of backend services to handle the increasing load under k8s/manifests-v2/
2. Find the -hpa.yaml file of the service that you intend to scale and increase the min/max replicas

Teardown

Teardown using teardown.sh

Deploying all services at once method 2 : docker-compose

1. Update .env file for frontend. Use the credentials stated in frontend/.env.sample.
2. You will need to create your own firebase project with a realtime database to get the codepad to work.
3. Update .env file for (PUBNUB) chat-service. You will need to create your own PUBNUB project for the chat service to work.
4. Update .env file for (postgres db) user-service. Use the credentials stated in user-service/.env.sample
5. Update .env file for (postgres db) question-service. Use the credentials stated in question-service/.env.sample
6. Run question-serivce/db/data.sql in your question-service database to populate the db
7. Start Docker
8. Run docker-compose build
9. Run docker-compose up
10. To access mongodb, install Mongdo DB Compass and use mongodb://localhost:27018 as the URI
11. To access postgres db, install Postico and connect to the databases for user-service and question-service in the .env file

Port Table

Saves all the ports so they don't clash

Service	Port
Frontend	3000
User Service	8000
Matching Service	8001
Question Service	8002
Chat Service	8003

Deploying individual services:

Frontend

1. Create your own firebase project
2. Create a .env file in /frontend to store firebase credentials from your own firebase project. Refer to frontend/.env.sample for more info.
3. In the frontend directory, create a dist/ folder
4. Copy index.html from setup/ into dist/
5. Install npm packages using npm i.
6. Run Frontend using npm run dev.

User Service

1. Setup a postgres database on your local machine.
2. Create a .env file in /user-service to store credentials for postgres. Refer to user-service/.env.sample for more info.
3. Install npm packages using npm i.
4. Run User Service using npm run dev.

Matching Service

1. Create a .env file in /matching-service to store credentials for postgres. Refer to matching-service/.env.sample for more info.
2. Create a Cloud DB URL using Mongo Atlas.
3. Enter the DB URL created as DB_CLOUD_URI in .env file.
4. For production, in the .env file change variable ENV from DEV to PROD.
5. Install npm packages using npm i.
6. Run Matching Service using npm run dev.

Question Service

1. Setup a postgres database on your local machine.
2. Create a .env file in /question-service to store credentials for postgres. Refer to question-service/.env.sample for more info.
3. Install npm packages using npm i.
4. Run Question Service using npm run dev.

Chat Service

1. Create a .env file in /chat-service to store credentials for pubnub. Refer to chat-service/.env.sample for more info.
2. Install npm packages using npm i.
3. Run Question Service using npm run dev.

Populating Questions Table

1. Run question-serivce/db/data.sql in your question-service database

Load Testing

1. Install Artillery using npm install -g artillery
2. Navigate to load_testing directory
3. Run load testing on User service with artillery run load_user_service.yml
4. Run load testing on Question service with artillery run load_question_service.yml
5. Run load testing on Chat service with artillery run load_chat_service.yml