Add Archify | New Model… with three C4 examples and Open Model in the Explorer menu
- templates/models: C4 - Standard Web App, C4 - E-Shop, C4 - Event-Based Integration; each a complete model (main.archify, registry, context, containers, components) that validates - archify.newModel: pick an example and a folder name, copy it, name the model after the folder, open the model page - Explorer menu: New Model… on folders, Open Model on .archify and .archify-registry files; File → New File… lists New Model… - unit test validates every example end to end; integration test runs the command; README, CHANGELOG, docs/model.md
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
schema_version: 1
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: System context
|
||||
output: context.html
|
||||
components:
|
||||
- ref: crm
|
||||
pos: [40, 60]
|
||||
size: [130, 60]
|
||||
- ref: erp
|
||||
pos: [40, 260]
|
||||
size: [130, 60]
|
||||
- ref: platform
|
||||
pos: [280, 160]
|
||||
size: [170, 60]
|
||||
- ref: warehouse
|
||||
pos: [540, 60]
|
||||
size: [150, 60]
|
||||
- ref: ops
|
||||
pos: [540, 260]
|
||||
size: [150, 60]
|
||||
connections:
|
||||
- { from: crm, to: platform, label: customer events, variant: emphasis }
|
||||
- { from: erp, to: platform, label: order events, variant: emphasis }
|
||||
- { from: platform, to: warehouse, label: pick lists }
|
||||
- { from: ops, to: platform, label: replays, variant: dashed }
|
||||
@@ -0,0 +1,46 @@
|
||||
schema_version: 1
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: Containers
|
||||
output: containers.html
|
||||
components:
|
||||
- ref: crm
|
||||
pos: [40, 60]
|
||||
size: [130, 60]
|
||||
- ref: erp
|
||||
pos: [40, 260]
|
||||
size: [130, 60]
|
||||
- ref: ingest
|
||||
pos: [250, 160]
|
||||
size: [140, 60]
|
||||
- ref: bus
|
||||
pos: [470, 160]
|
||||
size: [140, 60]
|
||||
- ref: router
|
||||
pos: [690, 160]
|
||||
size: [150, 60]
|
||||
- ref: dlq
|
||||
pos: [690, 320]
|
||||
size: [150, 60]
|
||||
- ref: store
|
||||
pos: [920, 60]
|
||||
size: [140, 60]
|
||||
- ref: notifier
|
||||
pos: [920, 160]
|
||||
size: [140, 60]
|
||||
- ref: analytics
|
||||
pos: [920, 260]
|
||||
size: [140, 60]
|
||||
boundaries:
|
||||
- kind: region
|
||||
label: Integration platform
|
||||
wraps: [ingest, bus, router, dlq, store, notifier, analytics]
|
||||
connections:
|
||||
- { from: crm, to: ingest, label: HTTPS, variant: emphasis }
|
||||
- { from: erp, to: ingest, label: HTTPS, variant: emphasis }
|
||||
- { from: ingest, to: bus, label: publish }
|
||||
- { from: bus, to: router, label: consume }
|
||||
- { from: router, to: store, label: append }
|
||||
- { from: router, to: notifier, label: notify }
|
||||
- { from: router, to: analytics, label: flatten }
|
||||
- { from: router, to: dlq, label: failed, variant: dashed, labelDy: 24 }
|
||||
@@ -0,0 +1,46 @@
|
||||
schema_version: 1
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: Event router components
|
||||
output: router.html
|
||||
components:
|
||||
- ref: bus
|
||||
pos: [40, 160]
|
||||
size: [140, 60]
|
||||
- id: validate
|
||||
type: security
|
||||
label: Validate
|
||||
sublabel: schema check
|
||||
pos: [270, 160]
|
||||
size: [130, 60]
|
||||
- id: enrich
|
||||
type: backend
|
||||
label: Enrich
|
||||
sublabel: reference data
|
||||
pos: [480, 160]
|
||||
size: [130, 60]
|
||||
- id: dispatch
|
||||
type: backend
|
||||
label: Dispatch
|
||||
pos: [690, 160]
|
||||
size: [130, 60]
|
||||
- ref: store
|
||||
pos: [920, 60]
|
||||
size: [140, 60]
|
||||
- ref: notifier
|
||||
pos: [920, 160]
|
||||
size: [140, 60]
|
||||
- ref: dlq
|
||||
pos: [270, 320]
|
||||
size: [150, 60]
|
||||
boundaries:
|
||||
- kind: region
|
||||
label: Event router
|
||||
wraps: [validate, enrich, dispatch]
|
||||
connections:
|
||||
- { from: bus, to: validate, label: event }
|
||||
- { from: validate, to: enrich, label: valid }
|
||||
- { from: enrich, to: dispatch, label: enriched }
|
||||
- { from: dispatch, to: store, label: append }
|
||||
- { from: dispatch, to: notifier, label: notify }
|
||||
- { from: validate, to: dlq, label: invalid, variant: dashed, labelDy: 24 }
|
||||
@@ -0,0 +1,29 @@
|
||||
schema_version: 1
|
||||
model:
|
||||
id: event-based-integration
|
||||
name: Event-Based Integration
|
||||
description: >
|
||||
Systems that never call each other directly; events go through a bus,
|
||||
a router validates and enriches them, consumers react. Context,
|
||||
containers, the router's components and one flow, C4 style.
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: Event-Based Integration — overview
|
||||
output: main.html
|
||||
components:
|
||||
- ref: crm
|
||||
pos: [40, 60]
|
||||
size: [130, 60]
|
||||
- ref: erp
|
||||
pos: [40, 260]
|
||||
size: [130, 60]
|
||||
- ref: platform
|
||||
pos: [280, 160]
|
||||
size: [170, 60]
|
||||
- ref: warehouse
|
||||
pos: [540, 160]
|
||||
size: [150, 60]
|
||||
connections:
|
||||
- { from: crm, to: platform, label: customer events, variant: emphasis }
|
||||
- { from: erp, to: platform, label: order events, variant: emphasis }
|
||||
- { from: platform, to: warehouse, label: pick lists }
|
||||
@@ -0,0 +1,40 @@
|
||||
schema_version: 1
|
||||
elements:
|
||||
ingest:
|
||||
type: backend
|
||||
label: Ingest API
|
||||
sublabel: HTTPS in, events out
|
||||
description: Accepts events from systems that cannot publish to the bus themselves.
|
||||
bus:
|
||||
type: messagebus
|
||||
label: Event bus
|
||||
sublabel: Kafka
|
||||
brand: apache-kafka
|
||||
description: One topic per event type; retained for seven days.
|
||||
router:
|
||||
type: backend
|
||||
label: Event router
|
||||
sublabel: validate, enrich, dispatch
|
||||
description: Checks each event against its schema, adds reference data, hands it to the consumers.
|
||||
diagram: 0300-components/router.archify
|
||||
dlq:
|
||||
type: messagebus
|
||||
label: Dead-letter queue
|
||||
sublabel: failed events
|
||||
description: Events the router could not process; replayed by operations.
|
||||
store:
|
||||
type: database
|
||||
label: Event store
|
||||
sublabel: PostgreSQL
|
||||
brand: postgresql
|
||||
description: Every accepted event, for audit and replay.
|
||||
notifier:
|
||||
type: backend
|
||||
label: Notifier
|
||||
sublabel: email, chat
|
||||
description: Turns selected events into messages to people.
|
||||
analytics:
|
||||
type: database
|
||||
label: Analytics
|
||||
sublabel: warehouse tables
|
||||
description: Flattened events for reporting.
|
||||
@@ -0,0 +1,7 @@
|
||||
schema_version: 1
|
||||
elements:
|
||||
ops:
|
||||
type: external
|
||||
label: Operations
|
||||
sublabel: on-call
|
||||
description: Watches the dead-letter queue and replays failed events.
|
||||
@@ -0,0 +1,23 @@
|
||||
schema_version: 1
|
||||
elements:
|
||||
platform:
|
||||
type: cloud
|
||||
label: Integration platform
|
||||
sublabel: the system
|
||||
description: Receives events from the business systems, routes them, keeps a record.
|
||||
diagram: 0200-containers/platform.archify
|
||||
crm:
|
||||
type: external
|
||||
label: CRM
|
||||
sublabel: customers
|
||||
description: Source of customer events; created, updated, merged.
|
||||
erp:
|
||||
type: external
|
||||
label: ERP
|
||||
sublabel: orders and stock
|
||||
description: Source of order events and the target of stock updates.
|
||||
warehouse:
|
||||
type: external
|
||||
label: Warehouse system
|
||||
sublabel: fulfilment
|
||||
description: Receives pick lists; reports shipments back as events.
|
||||
Reference in New Issue
Block a user