|
1 | 1 | # Overview
|
2 | 2 |
|
3 |
| -## Architecture Overview |
| 3 | +## Architecture Overview |
4 | 4 |
|
5 | 5 | Brief introduction with an overview of the platform. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam...
|
6 | 6 |
|
@@ -32,13 +32,28 @@ These resources are accounted for and billed in a per `Project` fashion.
|
32 | 32 | Team members must be granted access to `Projects`, and they are the only ones with access to the Nexus project.
|
33 | 33 | It is possible to be part of a `Virtual Lab`, but not part of a `project`.
|
34 | 34 |
|
| 35 | +When communicating with other services, the UUID of the virtual lab, and the UUID of the project should always be used. |
| 36 | +They are the stable ID, other properties may change. |
| 37 | + |
| 38 | +When using web API's, the header should be used to transmit the `virtual-lab-id` and `project-id`: |
| 39 | +``` |
| 40 | + GET /[....]/ HTTP/1.1 |
| 41 | + Accept: */* |
| 42 | + Accept-Encoding: gzip, deflate |
| 43 | + Authorization: Bearer [....] |
| 44 | + Connection: keep-alive |
| 45 | + Host: ... |
| 46 | + project-id: 42424242-bc92-4e30-aa32-63be8eb9ca49 |
| 47 | + virtual-lab-id: 42424242-a19e-4b3d-b737-5286a5fbea2d |
| 48 | +``` |
| 49 | + |
35 | 50 | ## Configuration and Deployment
|
36 | 51 | The AWS infrastructure required for the Open Brain Platform is exclusively managed through infrastructure-as-code. We use Terraform to configure and deploy the different components of the platform, including setting up IAM policies, security groups, or tagging.
|
37 | 52 |
|
38 | 53 | Each service is defined on its own Terraform module and operates independently from the rest of the services.
|
39 | 54 |
|
40 | 55 | > **TODO**
|
41 |
| -> Elaborate some of the deployment details and general information. |
| 56 | +> Elaborate some of the deployment details and general information. |
42 | 57 |
|
43 | 58 | ## Cost Monitoring Support
|
44 | 59 | Our infrastructure relies heavily on the use of **AWS Tags** in order to understand the overall operational costs for each of the services running in the platform. Our goal is to ensure that we can not only provide realistic costs estimates, but also identify the specific resources that each Virtual Lab and Project utilizes.
|
|
0 commit comments