This section describes the deployment view of CoMPAS.
The diagram above shows the deployment view. Blue components are within scope of the CoMPAS project.
CoMPAS microservices are built from Java source code on Github (not shown) using the Maven build process. This results in a compiled java application.
The result of the CI/CD is a Container Image in the Docker Registry. A Container Image contains one CoMPAS microservice. More than one CoMPAS microservice may be present in the image only if they are closely related and should be deployed and scaled together.
As part of the CI/CD process a security scan is performed on the source code. The Container Images must be signed and are the formal deliveries of the CoMPAS project.
In the deployment process the Container image is deployed together with its dependencies (for example a database) in an Application. This deployment takes place using Docker Compose. For this a docker compose yaml file is supplied that deploys the application using Docker Compose.
Generally speaking, it is a good idea to deploy one thing per container. Reasons:
- Independent scaling: APIs scale differently than databases
- Independent update: update in isolation
- Supports different environments: a containerized database locally while managed service in production
- No need for a process manager
Third party microservices can be incorporated in an end user application or can be required for CoMPAS microservices, but this is out of scope for the project.
Deployment is done by the users of CoMPAS and out of scope for the project.
Below describes the current deployment view of the CoMPAS containers that are available. This view will be updated during time to add the new components that are build.
The user uses a browser to open the OpenSCD editor from the CoMPAS OpenSCD Container. In this editor there are plugins available to use the XML REST Services from CoMPAS to open, save and validate SCL files or use a mapper to converted files. There is also an Auto Alignment Service to position elements for the Single Line Diagram.
The SCL files are stored in a database, for instance BaseX or PostgreSQL, that uses a volume to store the data outside the container.
Detailed information about the different components can be found at the follow links.
| Component | ||
|---|---|---|
| CoMPAS SCL Data Service | Repository | Documentation |
| CoMPAS OpenSCD | Repository | |
| CoMPAS CIM Mapping | Repository | |
| CoMPAS SCL Validator | Repository | |
| CoMPAS SCL Auto Alignment | Repository |