Skip to content

Commit 6e131cb

Browse files
Merge pull request #5 from scotho3/patch-1
docs: replace png diagram with mermaid for architecture visualization
2 parents 7077baf + 958562e commit 6e131cb

3 files changed

Lines changed: 85 additions & 1 deletion

File tree

docs/Framework/Framework.md

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,78 @@ Moreover, all the blocks MAY be implemented by one or more components as needed.
1616

1717
The proposed reference architecture defines six major functional building blocks (besides the actual network infrastructure), each with a clear and distinct purpose to enable straightforward mapping of specific features. While we acknowledge that some areas may overlap or require further refinement, our priority has been to establish a solid foundational understanding.
1818

19-
![pic](./images/arch.png)
19+
```mermaid
20+
block-beta
21+
columns 7
22+
23+
space:1
24+
block:layer1:5
25+
Presentation["Presentation"]
26+
end
27+
space:1
28+
29+
space:7
30+
31+
32+
block:Observability:2
33+
columns 2
34+
%% ObsLabel["Observabilit"]:2
35+
ObservedState[("Observed State")]:1
36+
ObservedLogic["Observed Logic"]:1
37+
end
38+
39+
space
40+
41+
block:Orchestration:1
42+
columns 1
43+
OrchLabel["Orchestration"]:1
44+
end
45+
46+
space
47+
48+
block:Intent:2
49+
columns 2
50+
%% IntLabel["Intent"]:2
51+
IntendedState[("Intended State")]:1
52+
IntendedLogic["Intended Logic"]:1
53+
end
54+
55+
space:7
56+
57+
space
58+
59+
60+
Collector["Collector"]:2
61+
space
62+
Executor["Executor"]:2
63+
space
64+
65+
space:7
66+
space:1
67+
68+
block:layer4:5
69+
NetworkInfra["Network Infrastructure"]
70+
end
71+
72+
Presentation <--> Observability
73+
Presentation <--> Orchestration
74+
Presentation <--> Intent
75+
76+
Observability <--> Orchestration
77+
Orchestration <--> Intent
78+
79+
Collector --> Observability
80+
Collector <--> Orchestration
81+
NetworkInfra --> Collector
82+
83+
Orchestration --> Executor
84+
Intent --> Executor
85+
Executor --> NetworkInfra
86+
87+
classDef darkStyle fill:#3a4149,stroke:#4a9eff,stroke-width:2px,color:#e8e8e8,font-size:20px,font-weight:bold
88+
89+
class Presentation,NetworkInfra,ObsLabel,IntLabel,Collector,Executor,ObservedState,ObservedLogic,IntendedState,IntendedLogic,OrchLabel darkStyle
90+
```
2091

2192

2293
- Intent: Defines the logic to handle and the persistence layer to store the desired state of the network, including both configuration and operational expectations.

docs/Framework/images/arch.png

-67.2 KB
Binary file not shown.

mkdocs.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,16 @@ extra:
2424
homepage: https://networkautomation.forum/
2525
extra_css:
2626
- stylesheets/extra.css
27+
markdown_extensions:
28+
- pymdownx.superfences:
29+
preserve_tabs: true
30+
custom_fences:
31+
# Mermaid diagrams
32+
- name: mermaid
33+
class: mermaid
34+
format: !!python/name:pymdownx.superfences.fence_code_format
35+
36+
extra_javascript:
37+
- optionalConfig.js
38+
- https://cdn.jsdelivr.net/npm/mermaid@11.5.0/dist/mermaid.min.js
39+
- extra-loader.js

0 commit comments

Comments
 (0)