update data model requirements as per recent insights
This commit is contained in:
parent
1aeece12a0
commit
5b40131319
SSH key fingerprint:
SHA256:COspvLoLJ5WC5rFb9ZDe5urVCkK4LJZOsjfF4duRJFU
1 changed files with 21 additions and 76 deletions
|
|
@ -1,83 +1,28 @@
|
||||||
# migration data model requirements
|
# migration data model requirements
|
||||||
|
|
||||||
(updated) deployment incl variables, backup creation/restore
|
Given:
|
||||||
|
|
||||||
<!-- To transfer between two providers, the target provider must be able to import the sending provider's versions. (e.g.: a deployment may have latest fediversity, latest pixelfed, but previous mastodon) Thus, for each "release" of the data model, it needs to be versioned, and applications/APIs also are versioned. -->
|
- no change in control of domains;
|
||||||
<!-- * (May need a way to show on the front-end which versions are in place, and which migrations are supported. However, for application versions which are completely controlled by the installation and setup, this is "solved".) -->
|
- two Fediversity set-ups (to be provided by ProcoliX) with a run-time environment such as ProxmoX, for an initial test using the same version;
|
||||||
|
- an operator's configuration, including:
|
||||||
|
- DNS automation hooks for the desired domain (RFC 2136, optionally authenticated by TSIG (RFC 2845) or GSS-TSIG (RFC 3645));
|
||||||
|
- a Fediversity configuration of at least a single application (to start).
|
||||||
|
|
||||||
Assumptions:
|
Our data model must describe a migration:
|
||||||
|
|
||||||
* Our deployment fully controls all versions, bypassing concerns on version mismatches.
|
- specifying [entity relations](https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationship-syntax) e.g. many-to-many;
|
||||||
|
- migrating both deployed and staged configurations;
|
||||||
|
- deploying of applications using the same versions;
|
||||||
|
- retaining relevant application state;
|
||||||
|
- handling of application-specific migration logic, such as to rewrite URLs as needed;
|
||||||
|
|
||||||
for release version 0, focus on known current needs
|
Tests:
|
||||||
* to be expanded later as each new application is added and can be transferred between providers
|
|
||||||
* review migration guides for the known apps with an eye to odd/unusual details that influence design choices (task for Niols? others?)
|
|
||||||
|
|
||||||
Specifically, this suggests scoping to migrating:
|
1.
|
||||||
|
A Fediversity user may wish to migrate their Fediversity set-up between monolithic and distributed configurations.
|
||||||
- managed infrastructure (rather than managed applications)
|
In an admin screen they can get their configuration and data for transfer.
|
||||||
- between servers initially owned by procolix
|
Using this they may migrate to the desired configuration.
|
||||||
- same proxmox version
|
1.
|
||||||
- NixOS VMs set up by us so we can guarantee identical application versions
|
At any time a Fediversity user may wish to migrate their Fediversity set-up.
|
||||||
- hosting limited to a single application (to start)
|
They can go to an admin screen where they can get their configuration and data for transfer.
|
||||||
- retaining the same domain name
|
This data can be provided to a new service provider where they will be up-and-running again, with minimal downtime.
|
||||||
- migrating the applications rather than also say control of domains
|
|
||||||
|
|
||||||
First, a bit of an inventory (list without much structure now, later will create structured form/schema with e.g. many-to-many links, useful for the migration code):
|
|
||||||
* clearly mark items that will not be in the first migration as planned for later or speculative
|
|
||||||
* or remove them if they would be too far in the future
|
|
||||||
* later we understand what is useful for migration code, we can extract and transform in to a format suitable as data model documentation
|
|
||||||
|
|
||||||
Hosting Provider provides:
|
|
||||||
|
|
||||||
* proxmox, git
|
|
||||||
* hardware
|
|
||||||
* filesystem storage
|
|
||||||
* DNS automation hooks (RFC 2136, optionally authenticated by TSIG (RFC 2845) or GSS-TSIG (RFC 3645))
|
|
||||||
* central/shared garage storage or only hardware+diskspace for the garage VMs to create storage?
|
|
||||||
* with central: more efficient but less isolated
|
|
||||||
|
|
||||||
FooUniversity (Operator)
|
|
||||||
* domain(s)
|
|
||||||
<!-- * Can we make it a requirement that Garage is behind a predictable URL, eg. `<application>.garage.<customer domain>`? As opposed to something vendor-specific, eg. `pixelfed-university.garage.procolix.com/<customer domain>/<application>` -->
|
|
||||||
* may need to rewrite URLs to blobs automatically, depending on the underlying URL scheme, which may be per setup or application
|
|
||||||
* limits? per application? per user? where are these used/set/enforced?
|
|
||||||
* TODO: what does e.g. borgmatic need to back up?
|
|
||||||
* note that selfhostblocks may already have some of the needed info here
|
|
||||||
* complications: in case details such as connections change, those may need adjusting, implying application-specification reconfiguring
|
|
||||||
* potentially propagate thru by e.g. TF?
|
|
||||||
* out of scope?: focus on actual state, disregarding reconstructable stuff
|
|
||||||
<!-- * application specifics -->
|
|
||||||
* pixelfed
|
|
||||||
<!-- * where is blob storage -->
|
|
||||||
<!-- * in the specific case of Pixelfed, if blob storage changed URL, we might need to rewrite the pictures URLs in the database (try to avoid this) -->
|
|
||||||
|
|
||||||
When transforming the data-model code to a deliverable version of the data model as part of the technical architecture document, documenting user-data storage and with respects to security and GDPR
|
|
||||||
|
|
||||||
<!-- See also: -->
|
|
||||||
|
|
||||||
<!-- - possible overlap/inspiration: Stalw.art [configuration docs](https://stalw.art/docs/server/general) -->
|
|
||||||
|
|
||||||
## MVP scoping ideas
|
|
||||||
|
|
||||||
User story 1: New customer
|
|
||||||
When a new customer goes to the Fediversity website we want to show that user what Fediversity is all about and what it can give to the customer. This points the customer to a signup form where they can enter all the details that are needed to get it working. Here they can also decide what applications to use (at first no more than three). Details can be, the admin login, domain, and applications. Then when the customer confirms everything starts to install automagically, after which the customer is presented with (some) url's to login to.
|
|
||||||
|
|
||||||
User story 2: Take out / move to other instance
|
|
||||||
At any time a customer may wish to change service providers. They can easily go to an admin screen where they can get their configuration and data packaged for transfer. This packaged data can be provided to a new service provider where they will be up-and-running again easily, with minimal downtime.
|
|
||||||
|
|
||||||
proposed MVP scope:
|
|
||||||
- block storage
|
|
||||||
- blob storage (garage)
|
|
||||||
- physical servers
|
|
||||||
- proxmox vm management
|
|
||||||
<!-- - nixops service -->
|
|
||||||
<!-- - nixops scripts -->
|
|
||||||
- 1 to 3 applications packaged in Nix (Mastodon, Peertube, Pixelfed)
|
|
||||||
- frontend / website
|
|
||||||
- working dns, can be external, but automated
|
|
||||||
- takeout area
|
|
||||||
- import area
|
|
||||||
- 2 Fediversity environments to transfer between
|
|
||||||
- demonstration of User story 1
|
|
||||||
- demonstration of User story 2
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue