Skip to content

Commit

Permalink
documentation reviewed
Browse files Browse the repository at this point in the history
  • Loading branch information
dononitram committed Apr 17, 2024
1 parent 5552389 commit 85a002a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 11 deletions.
Binary file modified docs/images/07_overview.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/08_domain_model.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 1 addition & 10 deletions docs/src/07_deployment_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ The infrastructure of our system consists mainly of a single server, which is ho
image::07_overview.drawio.png["Login Diagram", align="center"]


Motivation::
The main reason for this infrastructure choice lies in the simplicity and flexibility of a dockerized microservice architecture solution, which allows a fast and straightforward deployment of the system in any environment.
Motivation:: The main reason for this infrastructure choice lies in the simplicity, flexibility, and platform agnosticism of a dockerized microservice architecture solution. This allows for a fast and straightforward deployment of the system in any environment, regardless of the underlying platform. This would allow an easy migration of the system to another cloud provider if necessary, as well as the ability to scale the system horizontally by adding more instances of the same service with ease thanks to the container orchestrator.

Quality and/or Performance Features::
- Scalability: The system can be easily scaled horizontally by adding more instances of the same service with ease thanks to the container orchestrator.
Expand Down Expand Up @@ -49,11 +48,3 @@ Mapping of Building Blocks to Infrastructure::



=== Infrastructure Level 2

==== Docker component

The system is deployed in a dockerized enviroment in which each microservice is contained in a separate container. Docker compose is the selected orchestrator as it is a simple solution that meets the few deployment requirements necessary for a small system like ours. It allows the app to be easily deployed with different profiles by using a docker-compose file.



6 changes: 5 additions & 1 deletion docs/src/11_technical_risks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ ifndef::imagesdir[:imagesdir: ../images]
|===
| Description | Priority | Considerations

| API failure
| Oracle Cloud Failure
| 8
| The project relies on Oracle Cloud services for hosting and deployment. Any failure or downtime of Oracle Cloud services could result in service interruptions, data loss, and a poor user experience. This impact is only reduced thanks to the ease of migration of our dockerized services.

| Wikidata API failure
| 3
| Even though an API failure is possible, it's a low impact event because we have the questions stored in the database and the game would still work.

Expand Down

0 comments on commit 85a002a

Please sign in to comment.