Commit graph

63 commits

Author SHA1 Message Date
9c0606b9a5
add png versions 2025-07-16 15:56:49 +02:00
6b6984ef02
describe CI/CD
see D2.6
2025-07-10 17:20:10 +02:00
e5e608f2c9
in-source architecture images 2025-07-10 17:20:01 +02:00
3d55b459c2
add architecture document 2025-07-09 15:41:51 +02:00
82a86f4515 add configuration-to-deployment dataflow diagram
side note: the pile of documents in this directory would benefit from some cleanup,
because it tends to get confusing to navigate it. e.g. we can render images programmatically
from the source rather than checking them in.

currently we're conflating or inconsistently separating two document types:
- meeting notes and design decisions (capturing point-in-time discussion that is append-only)
- technical specification such as architecture diagrams (which change over time to reflect current understanding)

we'll keep piling up for now, but ultimately if we need to do onboarding or hand-over
to new developers or contributors, this should be sorted out.
2025-07-08 12:57:26 +02:00
7cb91acb3a
fix \n 2025-06-25 17:50:22 +02:00
baf21e1603
add nixos frontend to simple architecture diagram 2025-06-25 17:29:14 +02:00
08bb73aabb
make migration interaction diagram use a legend similar to the fediversity interactions diagram 2025-06-24 16:27:39 +02:00
2c12fc677c
add interactions diagram 2025-06-24 15:40:16 +02:00
7d68f6fef8 add data model for the reference front-end (#31)
follows up from #31 to offer a data model focused on formalize to the point of incorporating any data attribute types to be stored in the `panel` db.

data model [requirements](https://git.fediversity.eu/Fediversity/meta/src/branch/main/architecture-docs/data-model-requirements.md):

- [x] specifying [entity relations](https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationship-syntax) e.g. many-to-many
- [x] migrating both deployed and staged configurations
- [x] deploying of applications using the same versions
- [x] retaining relevant application state
- handling of application-specific migration logic, such as to rewrite URLs as needed - note this requirement does not affect the model here, in the sense it is handled through code rather than through the database

closes Fediversity/Fediversity#103.

Reviewed-on: #31
Reviewed-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: cinereal <cinereal@riseup.net>
Co-committed-by: cinereal <cinereal@riseup.net>
2025-06-06 11:05:27 +02:00
ebaf20d558
in interactions rename developers to maintainers
follows
8764276d39
2025-06-04 22:53:18 +02:00
7b828b497d data model assumptions: for DNS swap out DDNS for SOA to be able to transfer authority (#100) 2025-06-04 13:32:06 +02:00
76eafa45ca Merge pull request 'add diagrams' (#30) from entity-relations into main
Reviewed-on: #30
Reviewed-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2025-06-02 10:46:03 +02:00
e4bcffb489
transparent host architecture 2025-06-01 09:21:25 +02:00
a76b4e7009
update host architecture 2025-05-31 23:50:24 +02:00
dadf18930a
data model -> entity relations 2025-05-31 23:15:00 +02:00
502e650e03
for migration interaction factor out config distinction 2025-05-31 23:04:51 +02:00
4d305b4085
add interactions 2025-05-31 22:51:55 +02:00
0fe0df8eba
transparent, fix header 2025-05-31 22:41:10 +02:00
631b0b6c93
mv entity-relations to mmd as well
usage:
```sh
nix-shell -p mermaid-cli --command 'mmdc -i entity-relations.mmd -o
entity-relations.svg'
```
2025-05-31 22:37:44 +02:00
e462211c49
md -> mmd
usage:

```sh
nix-shell -p mermaid-cli --command 'mmdc -i data-model.mmd -o
data-model.svg -b transparent'
```
2025-05-31 20:37:41 +02:00
8182b5bf05
add migration scripts 2025-05-31 19:42:44 +02:00
bc59794685 Merge pull request 'data migration notes' (#29) from data-model into main
Reviewed-on: #29
2025-05-31 18:48:25 +02:00
2f3e1222b8
add entity relationship diagram 2025-05-27 20:27:14 +02:00
5b40131319
update data model requirements as per recent insights 2025-05-27 18:59:53 +02:00
5803f0bd1e
recontextualize architecture diagrams 2025-05-27 16:07:54 +02:00
d2240a2d23
update architecture to reflect decoupling productization 2025-05-23 09:17:02 +02:00
9d9dfa3c6f
add proxmox architecture originally included in fediversity repo 2025-04-21 13:22:24 +02:00
34500abbab Update architecture-docs/2025-04-08-high-level-spec.md 2025-04-09 10:57:32 +02:00
Kiara Grouwstra
a6209f056c
add high-level spec 2025-04-08 17:05:33 +02:00
Kiara Grouwstra
1aeece12a0
data migration: add note on selfhostblocks 2025-04-08 09:12:40 +02:00
Kiara Grouwstra
a5670bb674
update meeting notes as per ssh meeting, feedback on design minutes 2025-04-01 12:36:14 +02:00
Kiara Grouwstra
1c617dce0c
add ssh strategy 2025-04-01 09:45:31 +02:00
Kiara Grouwstra
cd0a53200a
migration: add concern raised by @jan 2025-03-25 13:52:08 +01:00
Kiara Grouwstra
9f25fd986d
add minutes from design meeting 2025-03-12 13:55:26 +01:00
Kiara Grouwstra
f9779723ed
wip: data model requirements 2025-03-04 13:02:52 +01:00
Kiara Grouwstra
68178405a8
restructure the meeting notes to consistently start with the ISO date format, as it facilitates using computer sorestructure meeting notes to consistently start with ISO date format
facilitates using computer sorting to obtain a chronological order,
which makes it easier to find things.

note i also deleted a minutes file for a date that we had two copies for
in the repo.
2025-03-04 10:23:19 +01:00
416d5a92de
typo (transferred) 2025-02-12 09:31:16 +01:00
Kiara Grouwstra
9a24f91976
add draft requirements on the migration data model for NLNet 2025-02-11 13:22:11 +01:00
Kiara Grouwstra
346c3add5a
architecture-docs/on-flakes.md: add some initial notes 2025-02-11 13:22:11 +01:00
Ronny Lam
bd95884145 added DMP 2024-12-16 09:24:02 +01:00
3500bc34a7 add notes on storage architecture discussion 2024-12-09 13:35:17 +01:00
Koen de Jonge
8d68fc65ed Notes after viewing architecture discussion. 2024-12-04 08:59:57 +01:00
Ronny Lam
701108dcab added UML training doc 2024-11-22 11:22:30 +01:00
Ronny Lam
b955e054d5 renamed .uml to .puml 2024-11-21 11:17:13 +01:00
Ronny Lam
89dc0c0eef converted to uml and changes after meeting 2024-11-21 09:09:14 +01:00
Ronny Lam
ee7ab9b7ea created arch svg 2024-11-20 12:06:22 +01:00
681b2a7165 Update architecture-docs/Fediversity-architecture-notes.md 2024-11-12 11:20:16 +01:00
d28fea7ee1 Update architecture-docs/Fediversity-architecture-notes.md 2024-11-12 11:19:45 +01:00
Ronny Lam
0a8ced184d added services 2024-11-11 15:57:59 +01:00