Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Technical documentation #6

Merged
merged 4 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@
- [Želdiniai ir želdynai](moduliai/zeldynai.md)
- [Ekosistemos](moduliai/ekosistemos.md)
- [Projekto schema](schema.md)
- [Techninė informacija](technine-informacija.md)
85 changes: 85 additions & 0 deletions src/technine-informacija.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Techninė informacija

## Techninis stakas

### Infrastruktūra
vycius marked this conversation as resolved.
Show resolved Hide resolved

1. **GitHub**: naudojamas kodo saugojimui, artefaktų valdymui, projektų valdymui (_GitHub Projects_) ir automatizacijų
vykdymui (_GitHub Actions_);
2. **Docker ir Docker compose**: naudojami konteinerių paleidimui ir valdymui virtualiose mašinose;
3. **Git-crypt ir GitHub Actions Secrets**: paslapčių (angl. _secrets_) valdymui;
4. **Postgres su Postgis**: kaip pagrindinė duomenų bazė;
5. **MariaDB**: duomenų bazė, naudojama WordPress;
6. **Redis**: spartinančioji atmintinė (angl. _cache_) ir eilių valdymas;
7. **S3**: failų saugykla (naudojant VITC teikiamą paslaugą;
8. **Caddy**: atvirkštinis tarpinis serveris (angl. _reverse proxy_);
9. **Better Stack Uptime**: prieinamumo stebėsena;
10. **Sentry**: klaidų ir greitaveikos stebėsena;
11. **Grafana, Prometheus, Loki, AlertManager**: stebėsena ir žurnalo įrašų kaupimas;
12. **Zabbix**: virtualių mašinų stebėsena;
13. **PostMark**: elektroninių laiškų siuntimas;
14. **Google Analytics**: svetainių lankomumo stebėsena;
15. **QGIS**: geoerdvinių duomenų apdorojimas, peržiūra ir analizė;
16. **Martin**: geoerdvinių vektorinių duomenų generavimas;

### API (angl. _Application Programming Interface_)

Node.js su [Moleculer](https://moleculer.services/) sistema.
vycius marked this conversation as resolved.
Show resolved Hide resolved

### Kliento dalis

1. React: visoms kliento sąsajoms;
2. Vue: žemėlapių naršyklės kliento sąsajos;
3. WordPress: turinio valdymo sistema;
4. Medžioklės žurnalas mobilioji programėlė naudoja React-Native ir Fastlane diegimų automatizacijoms;

## Virtualios mašinos

Naudojamos VITC teikiamos ir valdomos virtualios mašinos.

1. **APP-BĮIP**: veikia bandomosios aplinkos (atitinkamai Development ir Staging), kurias sudaro
vycius marked this conversation as resolved.
Show resolved Hide resolved
tiek BĮIP moduliai, tiek tų aplinkų duomenų bazės;
2. **PROD-BĮIP**: šioje virtualioje mašinoje veikia gamybinė aplinka su visais BĮIP moduliais;
3. **BU-BĮIP**: virtualioje mašinoje veikia duomenų bazės naudojamos gamybinėje aplinkoje (pvz., Postgres su PostGIS ir
vycius marked this conversation as resolved.
Show resolved Hide resolved
MariaDB);
4. **INFRA-BĮIP**: veikia įvairūs BĮIP infrastruktūriniai įrankiai, tokie
kaip [Sentry](https://sentry.io/), [GitHub self-hosted](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)
agentas;
5. **BACKUP-BĮIP**: ši virtuali mašina naudojama atsarginėms kopijoms, pvz., duomenų bazių;
vycius marked this conversation as resolved.
Show resolved Hide resolved

## Diegimo procesas

Visi BĮIP atliekami diegimai yra automatizuoti naudojant GitHub actions.

### Diegimo žingsniai

```mermaid
---
title: BĮIP diegimo procesas
vycius marked this conversation as resolved.
Show resolved Hide resolved
---
%%{init: {'theme':'neutral'}}%%
flowchart TD
subgraph app1["BĮIP modulio dalis 1"]
a1["Automatinis testavimas"] --> a2["Docker image paruošimas"]
end
subgraph app2["BĮIP modulio dalis 2"]
b1["Automatinis testavimas"] --> b2["Docker image paruošimas"]
end
subgraph infra["Infrastruktūros repozitorija"]
i1["Aplinkos diegimas"]
end
app1 --> infra
app2 --> infra
```

1. **Automatinis testavimas:**
* BĮIP projekto dalis automatiškai testuojama naudojant GitHub Actions (pvz., automatiniai testai, statinė kodo
analizė su CodeQL, viešai žinomus pažeidžiamumų analizė);
2. **Docker image paruošimas:**
* Naudojant : [Reusable Workflows](https://github.com/AplinkosMinisterija/reusable-workflows)
paruošiamas Docker image;
* Docker image patalpinamas ghcr.io registre.
3. **Aplinkos diegimas:**
* Centrinėje BĮIP infrastruktūros konfigūracijos repozitorijoje, naudojant Docker Compose, paleidžiama atnaujinta
BĮIP projekto dalis atitinkamoje virtualioje mašinoje;
* Centrinė BĮIP infrastruktūros konfigūracijos repozitorija remiasi GitOps praktikomis;
Loading