Skip to content

Commit

Permalink
Update 07_deployment_view.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertoFAz authored Feb 19, 2024
1 parent 92e5cbc commit f72958e
Showing 1 changed file with 14 additions and 68 deletions.
82 changes: 14 additions & 68 deletions docs/src/07_deployment_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,88 +7,34 @@ ifndef::imagesdir[:imagesdir: ../images]

[role="arc42help"]
****
.Content
The deployment view describes:
1. technical infrastructure used to execute your system, with infrastructure elements like geographical locations, environments, computers, processors, channels and net topologies as well as other infrastructure elements and
2. mapping of (software) building blocks to that infrastructure elements.
Often systems are executed in different environments, e.g. development environment, test environment, production environment. In such cases you should document all relevant environments.
Especially document a deployment view if your software is executed as distributed system with more than one computer, processor, server or container or when you design and construct your own hardware processors and chips.
From a software perspective it is sufficient to capture only those elements of an infrastructure that are needed to show a deployment of your building blocks. Hardware architects can go beyond that and describe an infrastructure to any level of detail they need to capture.
.Motivation
Software does not run without hardware.
This underlying infrastructure can and will influence a system and/or some
cross-cutting concepts. Therefore, there is a need to know the infrastructure.
.Form
Maybe a highest level deployment diagram is already contained in section 3.2. as
technical context with your own infrastructure as ONE black box. In this section one can
zoom into this black box using additional deployment diagrams:
* UML offers deployment diagrams to express that view. Use it, probably with nested diagrams,
when your infrastructure is more complex.
* When your (hardware) stakeholders prefer other kinds of diagrams rather than a deployment diagram, let them use any kind that is able to show nodes and channels of the infrastructure.
.Further Information
See https://docs.arc42.org/section-7/[Deployment View] in the arc42 documentation.
****

=== Infrastructure Level 1

[role="arc42help"]
****
Describe (usually in a combination of diagrams, tables, and text):
* distribution of a system to multiple locations, environments, computers, processors, .., as well as physical connections between them
* important justifications or motivations for this deployment structure
* quality and/or performance features of this infrastructure
* mapping of software artifacts to elements of this infrastructure
For multiple environments or alternative deployments please copy and adapt this section of arc42 for all relevant environments.
****

_**<Overview Diagram>**_
image::Diag_Comp.jpg[align="center",title="Deployment Diagram",link="Diag_Comp.jpg]
Motivation::
_<explanation in text form>_
The system is based in microservices architecture with three independent services, each responsible for a specific aspect of the functionality. One service is the Graphic interface, this service handles the presentation layer of a web application. Another service is tasked with managing user-related functionalities. MongoDB, a NoSQL database, is used to store and manage user data efficiently. The third service utilizes Wikidata, a free open base, to automatically generate questions.
Quality and/or Performance Features::
_<explanation in text form>_
The main reason we have chosen a microservices architecture is to achieve a fast and efficient application.. The availability and efficiency of the application will be affected by Wikidata's availability, but just in the question generation moment.
Mapping of Building Blocks to Infrastructure::
_<description of the mapping>_


=== Infrastructure Level 2

[role="arc42help"]
****
Here you can include the internal structure of (some) infrastructure elements from level 1.
Please copy the structure from level 1 for each selected element.
****

==== _<Infrastructure Element 1>_

_<diagram + explanation>_

==== _<Infrastructure Element 2>_

_<diagram + explanation>_
[cols="1,2" options="header"]
|===
| **Element** | **Description**
| _Browser_ | _The browser on the user's device where they can access to the application._
| _WebApp_ | _The graphical interface through which users can interact._
| _API Gateway_ | _The API that comunicates the rest of the microservices with the graphical interface._
| _Question_Generator_ | _The microservice responsible for generating questions through Wikidata._
| _Wikidata_ | _The Wikidata API that allows us to access its information._
| _Users_ | _The microservice responsible for managing users._
| _MongoDB_ | _A NoSQL based database where we can save the user's data._
|===
...
==== _<Infrastructure Element n>_
_<diagram + explanation>_

0 comments on commit f72958e

Please sign in to comment.