Please, use this template to describe project versions.
This aims at providing information for internal teams.
# projectName - vM.m.x
**Project**: projectName
**Version**: M.m.x
**Community documentation:** *as a link*
## Standards and Norms
*Indicate the norms and standards supported by the components you maintain*.
## Available Packaging
| Packaging | Supported |
| --------- | --------- |
| Docker image | |
| Binary package | |
| Sources (to build) | |
| Debian package | |
| RPM package | |
| Other (what?) | |
## Software Dependencies
| Software Component | Recommended Version | Comment |
| ------------------ | ------------------- | ------- |
| | | |
For every of these dependencies, please add a link to its documentation.
These are the mandatory requirements. Not the possible integration.
## Extra Software Integration
Please, indicate whether there are extra Software solutions for which you provide connectors or integration.
This is about optional dependencies.
| Software Component | Compatible Versions | Comment |
| ------------------ | ------------------- | ------- |
| | | |
## Technology Matrix
What programming languages and main frameworks are you using?
* Back-end:
* Front-end:
## Minimal Hardware Requirements
For the components you develop and maintain.
- CPU:
- Memory:
- Etc.
*If there are requirements about maximum, please add them here too.*
## Logical Architecture
Software components (maintained by the team) and their Software dependencies.
* Please, do not show cardinalities here.
* Add a schema built with the [former draw.io](https://app.diagrams.net/).
* Save the original **drawio** file under the `/resources/drawio/projectName` directory.
* Export the diagram as a PNG file and save it under the `/resources/img/projectName` directory.
Beyond the diagram, add an explanation about the role of this component and why it is necessary.
## Application Flows
| Source | Target | Port | Protocol | Comment |
| --------- | ------------- | ----- | ----- | -----------------------------------------|
| External | NGinx | 443 | HTTPS | Web access. |
## Faults Tolerance
What are the recommended architecture decisions to ensure the application will keep on working despite one defect?
List the supported defects and the means to limit their impact.
### Defect 1: a database node crashes
Have several nodes with synchronous replication... (whatever).
## Load Support
Describe the mechanisms to increase the supported load.
It can be redundant with fault tolerance mechanisms, but not always. It can be about increasing the
number of instances, increasing the hardware (migration?), tuning the configuration, etc.
## Required Training
What are the training customers should follow to deploy, upgrade and maintain the solution in production?
Only consider the Software solutions described here, not the tools they would use for monitoring, deployment, etc.