HIFIS Cloud Portal - Architecture¶
This document describes the general architecture of the Cloud Portal (CP) for the Helmholtz Federated IT Services (HIFIS).
The CP is a central part of the Helmholtz Cloud. It is the main entrypoint for users to find and access HIFIS / Helmholtz Cloud Services. In the position, the CP has to interact with almost all components of the system. Figure 1 shows and overview of the current system and the interaction with other systems.
System Architecture HIFIS Cloud Portal¶
There are a couple of high-level components in the CP:
- Backend (Cerebrum)
- Frontend (Webapp)
- Helmholtz Cloud Agent (HCA) Service
- Availability Service
The CP uses a MongoDB server as database. MongoDB is a document-oriented database and as such is well suited as a backend for the CP. The main purpose of the CP is to present HIFIS services and their metadata. Most interactions with the database will only read data and use a variety of ad-hoc filters on flexible schemas which is well-supported in MongoDB.
Currently, there are 5 different collections:
marketService: this is the main collection storing all service information, one document per service. It stores information like the service name, description, entrypoint, service provider and the used software.
image: this collection stores base64 encoded PNG images that are linked from the marketService collection and show service and provider logos.
availability: this collection stores availability information per services that is regularly updated by the availability service.
hcaRequest: this collection stores the request that are sent to the Helmholtz Cloud Agents.
hcaResource: this collection stores the resources that are created by HCA requests.
The backend, a.k.a Cerebrum, provides access to the database using a REST API. It is written in Java and uses the Spring Boot framework.
The HCA service takes care of all interaction with the Helmholtz Cloud Agent. It is written in Python. It takes the requests that are sent by the user from the frontend and sends them to the corresponding RabbitMQ host. It handles the responses from the HCA and updates the resources in the database accordingly.
The Availability service regularly checks if the services are still reachable and updates the corresponding DB collection. It is written in Python. If a service is not available and error message is stored. The availability information is displayed in the frontend using color-coded dots on the service cards.