root-at-skic
f4663c089d
Numbered cards for the text sections (1.1-1.3, 2, 4, 11, 12) on the overview, domain interfaces on the technical context, black-box descriptions for every building block, blocks mapped to nodes in the deployment view, crosscutting concepts on level 1, and a 1000-quality folder with the quality tree. The example test checks each section's card.
38 lines
1.1 KiB
Plaintext
38 lines
1.1 KiB
Plaintext
schema_version: 1
|
|
elements:
|
|
web:
|
|
type: frontend
|
|
label: Web App
|
|
sublabel: React
|
|
brand: react
|
|
description: >
|
|
Responsibility: page editor, viewer and search box in the
|
|
browser. Interfaces: provides the UI over HTTPS; requires
|
|
the Wiki API (JSON).
|
|
api:
|
|
type: backend
|
|
label: Wiki API
|
|
sublabel: REST
|
|
description: >
|
|
Responsibility: pages, search, attachments and access checks;
|
|
the only writer of the database. Interfaces: provides REST
|
|
JSON; requires the IdP (OIDC), the database (SQL), object storage (S3).
|
|
diagram: 0500-building-blocks/wiki-api.archify
|
|
db:
|
|
type: database
|
|
label: Database
|
|
sublabel: PostgreSQL
|
|
brand: postgresql
|
|
description: >
|
|
Responsibility: pages, revisions, users and the full-text
|
|
index; the source of truth. Interfaces: provides SQL to the
|
|
API and dumps to the backup job.
|
|
backup-job:
|
|
type: backend
|
|
label: Backup job
|
|
sublabel: nightly
|
|
description: >
|
|
Responsibility: dumps the database at 02:00, keeps 30 days.
|
|
Interfaces: requires the database (pg_dump) and the backup
|
|
bucket (S3); provides none.
|