COMP90024 Assignment 2

Deployment

To deploy this project run:

  cd playbook
  ./run-mrc.sh

• You would need the id_rsa ssh private key in the playbook folder, if you want to deploy the playbook with a clean slate.
• You would need to replace the ansible_become_pass variable in the inventory/inventory.ini file with your sudo password.
• You would need to set up your MRC password and provide it upon the input prompt when executing the script.
• You would need to provide the Ansible Vault password if the depolyed service has encrypted variables.

p.s. Due to the intrinsics of docker swarm, the CouchDB cluster may not finish its setup sometimes. The deployment process may fail or throw errors. Let me know if that happens.

Documentation

• CouchDB
  • Docker Swarm Deployment
  • Photon
  • Secret Hiding via Ansible Vault.
• Harvester
  • Elaboration
  • Docker Swarm Deployment
• API
  • Elaboration
  • Docker Swarm Deployment
• Frontend
  • Elaboration
  • Docker Swarm Deployment
• Analyser/Twitter Data Pre-processor
  • Elaboration
  • Development

Notes

CouchDB cluster is ready to play with. Go to MRC and find our project. You can use any instance's IP to access it. The url to the GUI is <IP>:5984/_utils/. Username and password can be found here. React frontend is accessible at port 80 and Gin backend hosts a swagger page, which is accessible at port 8080.

Current sevice communication map is shown as below:

graph TD;
Frontend --> Backend;
Backend--> CouchDB;
Harvester --> CouchDB;
Analyser --> CouchDB;

Loading

Frontend, Backend and Harvester all have two replicas.

If you are not on campus and want to deploy the playbook or play with the services, use the AnyConnect VPN.