Asgard

What is Asgard?

Asgard is a micro-service cluster designed and developed by the School of Computer Science's Technical team at The Unniversity of Lincoln.

Each service has been designed and developed with the microservice architecture pattern in mind for scalability and reliability.

The following template repositories are available for generating new services or frontend apps for the stack:

• Frontend VueJs Web Apps - Javascript/Typescript Vue
• Backend REST API - Python3 Flask

---

Services

Asgard is currently provides the following services:

• Heimdall
• Mimir
• Yggdrasil
• Odin

Heimdall

Heimdall is a remote monitoring system, used to monitor the operational status of the computers in the School's computing labs. The system also provides a "Find a PC" system for our students.

Mimir

Mimir is our timetabling engine, providing the ability for us to generate our own timetables for rooms and labs.

Yggdrail

Yggdrasil is a content carousel display system, providing the ability to remotely assign carousels of custom content to display screens across campus. Yggdrasil has the ability to communicate with Heimdall and Mimir directly, allowing for the embedding of the lab availability and calenders into its content carousels.

Odin

Odin is a service developed for analysing the utilisation of the facilities and functionality of the service in the Asgard System Stack.

---

Repository Structure

The repository structure is as follows:

• ./deployment_scripts/ - contains the bash scripts used for easier deployment via Docker.
• ./mysql/ - contains the initialisation config for the Mysql container.
• ./nginx/ - contains the configuration files for the Nginx reverse proxy container.
• ./docker-compose.yml - The producation Docker-compose configuration.
• ./docker-compose.dev.yml - The development Docker-compose configuration.
• ./README.md - This project README.
• ./service-name-frontend/ - The frontend end source code for the corresponding web app within the stack.
• ./service-name-api/ - The backend API source code for the corresponding REST API within the stack.

---

Dependencies and Libraries

Deployment

• Docker
• Docker-compose

Reverse Proxy

• NGINX

Database

• Mysql

Frontend

• Node
• Webpack
• Babel
• Javascript
• Typescript
• Vue
• Sass
• Scss
• Yarn
• Axiom

Backend

• Python
• Flask
• Flask-Restful
• SQLAlchemy
• JSON

---

Setup

Host Installation

1. Install Ubuntu Server 16.04

2. Update your system

sudo apt-get update
sudo apt-get upgrade -y

3. Install Docker

sudo apt-get install docker.io

4. Install Docker-compose from the docker repositories, the version available on the Ubuntu software center is several versions behind.

sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/bin/docker-compose
sudo chmod +x /usr/bin/docker-compose

Asgard Deployment

1. Clone the repository

git clone https://github.com/treed1104/asgard-system-stack.git --recursive

2. Edit the MySQL variables in the docker-compose file

Edit lines 33-36 with your own credentials:
	environment:
        MYSQL_ROOT_PASSWORD: <PASSWORD>
        MYSQL_DATABASE: <DATABASE_NAME>
        MYSQL_USER: <USER>
        MYSQL_PASSWORD: <PASSWORD>

3. Edit the server address in the Vuex store files

Edit line 10 in heimdall-frontend/app/src/store/store.js, change 127.0.0.1 to your server address:
	From: serverAddress: "http://127.0.0.1/heimdall-api",
	To: serverAddress: "http://<server_external_ip>/heimdall-api"

Edit line 10 in mimir-frontend/app/src/store/store.js, change 127.0.0.1 to your server address:
	From: serverAddress: "http://127.0.0.1/mimir-api",
	To: serverAddress: "http://<server_external_ip>/mimir-api"

Edit line 10 in yggdrasil-frontend/app/src/store/store.js, change 127.0.0.1 to your server address:
	From: serverAddress: "http://127.0.0.1/yggdrasil-api",
	To: serverAddress: "http://<server_external_ip>/yggdrasil-api"

4. make a copy of the example config files ready to enter your setup connection details from step 2.

cp heimdall-api/api/configs/main.cfg heimdall-api/api/configs/main.cfg
cp mimir-api/api/configs/main.cfg mimir-api/api/configs/main.cfg
cp yggdrasil-api/api/configs/main.cfg yggdrasil-api/api/configs/main.cfg
cp odin-api/api/configs/main.cfg odin-api/api/configs/main.cfg

5. Edit each of the new .cfg replacing the connection strings with your username, password and database name that you set in step 2.

Edit line 3 in heimdall-api/api/configs/main.cfg:
	From: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_heimdall_api'
	To: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_asgard'

Edit line 3 in mimir-api/api/configs/main.cfg:
	From: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_mimir_api'
	To: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_asgard'

Edit line 3 in yggdrasil-api/api/configs/main.cfg:
	From: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_yggdrasil_api'
	To: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_asgard'

Edit line 3 in odinl-api/api/configs/main.cfg:
	From: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_odin_api'
	To: SQLALCHEMY_DATABASE_URI='mysql://<user>:<password>@db-mysql:3306/db_asgard'

6. Edit the Odin API config to point to the host address for the other microservices

Edit line 6-8 in odinl-api/api/configs/main.cfg:
	HEIMDALL_API='http://<asgard_host_address>/heimdall-api'
	MIMIR_API='http://<asgard_host_address>/mimir-api'
	YGGDRASIL_API='http://<asgard_host_address>/yggdrasil-api'

7. Run the deployment script

sudo chmod +x deployment_scripts/deploy_production.sh
sudo ./deployment_scripts/deploy_production.sh