From afc7ad2b8855ae43a9b438ca3d9b4719b1e34e08 Mon Sep 17 00:00:00 2001 From: kiara Grouwstra Date: Mon, 2 Jun 2025 11:43:31 +0200 Subject: [PATCH] add to the glossary as per ZHF session (#340) points of attention (compared to ZHF pad): - nouns vs verbs (feel free to improve!) - some phrasing differences - changed services to applications - unified host to runtime environment as per diagram - distinguish actors using rounded corners Reviewed-on: https://git.fediversity.eu/Fediversity/Fediversity/pulls/340 Reviewed-by: Valentin Gagarin --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 877d2e2e..3b19751c 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ There already exist solutions for self-hosting, but they're not suitable for wha The ones we're aware of require substantial technical knowledge and time commitment by operators, especially for scaling to thousands of users. Not everyone has the expertise and time to run their own server. +## Interactions + +To reach these goals, we aim to implement the following interactions between [actors](#actors) (depicted with rounded corners) and system components (see the [glossary](#glossary), depicted with rectangles). + +![](https://git.fediversity.eu/Fediversity/meta/raw/branch/main/architecture-docs/interactions.svg) + ## Actors - Fediversity project team @@ -57,11 +63,11 @@ Not everyone has the expertise and time to run their own server. - [Fediverse](https://en.wikipedia.org/wiki/Fediverse) - A collection of social networking services that can communicate with each other using a common protocol. + A collection of social networking applications that can communicate with each other using a common protocol. -- Service +- Application - A Fediverse application run by the hosting provider for an operator. + User-facing software (e.g. from Fediverse) run by the hosting provider for an operator. - Configuration @@ -73,11 +79,11 @@ Not everyone has the expertise and time to run their own server. Make a resource, such as a virtual machine, available for use. - > Example: We use [Proxmox](https://www.proxmox.com) to provision VMs for services run by operators. + > Example: We use [Proxmox](https://www.proxmox.com) to provision VMs for applications run by operators. - Deploy - Put software, such as services, onto computers. + Put software, such as applications, onto computers. The software includes technical configuration that links software components. Most user-facing configuration remains untouched by the deployment process. @@ -85,7 +91,7 @@ Not everyone has the expertise and time to run their own server. - Migrate - Move service configurations and user data to a different hosting provider. + Move service configurations and deployment state, including user data, from one hosting provider to another. - [NixOps4](https://github.com/nixops4/nixops4) @@ -103,6 +109,18 @@ Not everyone has the expertise and time to run their own server. > Example: We need a resource provider for obtaining deployment secrets from a database. +- Runtime backend + + A type of digital environment one can run operating systems such as NixOS on, e.g. bare-metal, a hypervisor, or a container runtime. + +- Runtime environment + + The thing a deployment runs on, an interface against which the deployment is working. See runtime backend. + +- Runtime config + + Configuration logic specific to a runtime backend, e.g. how to deploy, how to access object storage. + ## Development All the code made for this project is freely licenced under [EUPL](https://en.m.wikipedia.org/wiki/European_Union_Public_Licence).