Skip to content
This repository has been archived by the owner on Dec 16, 2024. It is now read-only.

Commit

Permalink
docs: rename some components in the arch doc
Browse files Browse the repository at this point in the history
  • Loading branch information
alecthomas committed May 18, 2023
1 parent cca73fd commit bad5468
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

The actors in the diagrams are as follows:

| Actor | Description |
| --------- | ----------------------------------------------------------------------------------------------------------- |
| Backplane | The coordination layer of FTL. This creates and manages runtime instances, routing, resource creation, etc. |
| Platform | The platform FTL is running on, eg. Kubernetes, VMs, etc. |
| Runtime | The component of FTL that coordinates with the Backplane to spawn and route to user code. |
| Module |
| Actor | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------- |
| Backplane | The coordination layer of FTL. This creates and manages Runner instances, routing, resource creation, etc. |
| Platform | The platform FTL is running on, eg. Kubernetes, VMs, etc. |
| Runner | The component of FTL that coordinates with the Backplane to spawn and route to user code. |
| Deployment | User code serving VerbService for a module written in a particular language. |

## System initialisation

```mermaid
sequenceDiagram
participant B as Backplane
participant P as Platform
participant R as Runtime
participant R as Runner
B ->> P: CreateRuntime(language)
B ->> P: CreateRunner(language)
P ->> R: CreateInstance(language)
R ->> B: RegisterRuntime(language)
R ->> B: RegisterRunner(language)
```

## Creating a deployment
Expand All @@ -29,8 +29,8 @@ sequenceDiagram
participant C as Client
participant B as Backplane
box Module
participant R as Runtime
participant M as Module
participant R as Runner
participant M as Deployment
end
C ->> B: GetArtefactDiffs()
Expand Down Expand Up @@ -62,12 +62,12 @@ sequenceDiagram
participant C as Client
participant B as Backplane
box LightYellow Module0
participant R0 as Runtime0
participant M0 as Module0
participant R0 as Runner0
participant M0 as Deployment0
end
box LightGreen Module1
participant R1 as Runtime1
participant M1 as Module1
participant R1 as Runner1
participant M1 as Deployment1
end
C ->> B: Call(V0)
Expand Down

0 comments on commit bad5468

Please sign in to comment.