Skip to content

Commit

Permalink
Doc -> Add architecture overview for EDGAR.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbfm committed Apr 2, 2024
1 parent c29271c commit d40e3cf
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@
- [Cluster](architecture/cluster/index.md)
- [Deployment](architecture/cluster/deployment.md)
- [CARL](architecture/carl/index.md)
- [EDGAR](architecture/edgar/index.md)
- [Peer](architecture/peer/index.md)
56 changes: 56 additions & 0 deletions doc/src/architecture/edgar/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# EDGAR

## Setup
```plantuml
@startuml
node "LEA/CLEO" as UI
actor "User"
frame Peer {
node VpnClient
agent EDGAR
}
node CARL
node "VPN Management Server"
UI <-- User : Configure Peer
User -> EDGAR : Setup-String
UI -> CARL
CARL <-- EDGAR : Retrieve Configuration
EDGAR -> VpnClient : Install & Configure
"VPN Management Server" <-- VpnClient : Login
@enduml
```

## Service
```plantuml
@startuml
frame Peer {
node VpnClient
frame EDGAR {
agent "Service" as EdgarService
agent NetworkInterfaceManager
agent CanManager
}
node "Network Interfaces" as Interfaces
}
node CARL
node "VPN Management Server"
CARL <==> EdgarService : Stream
CARL -> "VPN Management Server"
"VPN Management Server" --> VpnClient : Configure Peers
EdgarService --> NetworkInterfaceManager : GRE & Bridge
EdgarService --> CanManager
NetworkInterfaceManager -> Interfaces
CanManager -> Interfaces : CAN
Interfaces <- VpnClient : WireGuard
@enduml
```

0 comments on commit d40e3cf

Please sign in to comment.