This repository contains a Graphical User Interface that automates the deployment of the Arrowhead Framework. By using this GUI you will be able to easily deploy the Arrowhead Framework on a Kubernetes cluster just following some instructions.
The GUI offers the next options:
- Which optional services to deploy
- How many replicas of each service to deploy
- Use a simple database or a database cluster (feature to add own db will be implemented in the future)
- Create a new Kubernetes cluster on the cloud, in case you don't have one (On Microsoft Azure or Google Cloud)
This few options allows you to modify the deployment architecture so it can fit for your own use case.
Before trying to use the GUI you will need to fill the next requirements:
- The operative system must be MacOS or Linux
- Python 3.8 or higher with pillow package installed (recommended to use a virtual environment)
- Kubectl 1.21 or higher (Installation link)
- Terraform 1.1 or higher, only if you need to create a new cluster (Installation link)
- Helm 3.7 or higher, only if you want to deploy the db cluster (Installation link)
- The kubernetes cluster must be 1.20 or lower
To use the GUI you only need to run the application.py file. You can do so by running the next command on the root directoty of the repository:
python application.py
Now that you have the GUI running just follow the instructions.
This repository contains a docker-compose file with all the containers used for the deployment. So if you want to run the arrowhead framework on docker to test it you can run the docker compose file on docker/0_docker_compose_test. If you want to make any changes to the configuration you can alse check the files on the folder docker/0_docker_compose_test/core_system_config.
You can also find the Dockerfiles used to create the images on the docker folder.
In case you want to deploy the cluster manually or make any changes you can use the kubernetes resources defined in the kubernetes/ folder.
And if you don't know how to use those resources you can also use the scripts found in the scripts/ folder. In this folder you will find different scripts to deploy individualy each resource.
On the other hand, the scripts to create the clusters on Azure and GCloud won't work.
In the case you want to create the cluster you will need to go to the corresponding folder depending if you want to deploy it on Azure (terraform/azure_terraform) or Gcloud (terraform/google_terraform). Inside this folders you will need to run the following commands:
terraform init
terraform apply -auto-aprove
After the second command you will be asked for the credentials and it will start creating the cluster.
Additional information can be found in the docs folder.
- Repostory structure explained
- Project development documentation (Master Thesis)
- Alexander Medela - [email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent