Planning docs

Add documents to describe high-level design and tasks. Chapter 6 should likely be removed as it migrates to GitHub issues.
githedgehog · Dec 6, 2024 · 5b4fa3d · 5b4fa3d
1 parent c6f2312
commit 5b4fa3d
Show file tree

Hide file tree

Showing 88 changed files with 1,427 additions and 354 deletions.
diff --git a/.cargo/config.toml b/.cargo/config.toml
@@ -1,7 +1,6 @@
 [env]
 COMPILE_ENV = { value = "compile-env", relative = true, force = false }
 PATH = { value = "compile-env/bin", relative = true, force = true }
-LD_LIBRARY_PATH = { value = "compile-env/lib", relative = true, force = true }
 LIBCLANG_PATH = { value = "compile-env/lib", relative = true, force = true }
 
 [build]

diff --git a/.github/workflows/sterile.yml b/.github/workflows/sterile.yml
@@ -58,7 +58,6 @@ jobs:
       matrix:
         rust:
           - "stable"
-          - "nightly"
     name: "Sterile test run"
     steps:
       - name: "login to ghcr.io"
@@ -179,7 +178,6 @@ jobs:
       matrix:
         rust:
           - "stable"
-          - "nightly"
     name: "Push containers"
     steps:
       - name: "login to ghcr.io"

diff --git a/design-docs/src/mdbook/book.toml b/design-docs/src/mdbook/book.toml
@@ -6,10 +6,8 @@ src = "src"
 title = "Hedgehog Dataplane Design Notes"
 
 [preprocessor.plantuml]
-#plantuml-cmd = "/lib/openjdk/bin/java -jar /lib/plantuml.jar"
 plantuml-cmd = "/bin/plantuml"
 after = ["links"]
-use-data-uris = false
 
 [preprocessor.mermaid]
 after = ["links"]
@@ -29,7 +27,6 @@ strict = false
 
 [output.html]
 additional-css = []
-additional-js = ["./theme/external/mermaid.min.js", "./theme/external/mermaid-init.js"]
 smart-punctuation = true
 preferrred-dark-theme = "ayu"
 default-theme = "light"
diff --git a/design-docs/src/mdbook/src/SUMMARY.md b/design-docs/src/mdbook/src/SUMMARY.md
@@ -11,3 +11,39 @@
   - [fake-nix](./build/fake-nix.md)
   - [Build dataplane](./build/just-cargo-build.md)
   - [Sterile builds](./build/sterile-build.md)
+- [Design session](./dataplane/design-session.md)
+- [Development Plan](./dataplane/development-plan.md)
+  - [Configuration Persistence Investigation](./dataplane/tasks/configuration-persistence-investigation.md)
+  - [Configuration database schema](./dataplane/tasks/config-db-schema.md)
+  - [Control plane dev-env](./dataplane/tasks/control-plane-dev-env.md)
+  - [Core pinning](./dataplane/tasks/core-pinning.md)
+  - [Create control plane image](./dataplane/tasks/create-control-plane-image.md)
+  - [Dataplane / Control plane protocol](./dataplane/tasks/dataplane-control-plane-protocol.md)
+  - [Dataplane / Control plane transport](./dataplane/tasks/dataplane-control-plane-transport.md)
+  - [Dataplane worker lifecycle](./dataplane/tasks/dataplane-worker-lifecycle.md)
+  - [Fault tolerance (implementation)](./dataplane/tasks/fault-tolerance-implementation.md)
+  - [Fault tolerance (validation)](./dataplane/tasks/fault-tolerance-validation.md)
+  - [Gateway test env](./dataplane/tasks/gateway-test-env.md)
+  - [Identify local traffic](./dataplane/tasks/identify-local-traffic.md)
+  - [Management plane - control plane interaction](./dataplane/tasks/management-plane-control-plane-interaction.md)
+  - [Management plane - dataplane interaction](./dataplane/tasks/management-plane-dataplane-interaction.md)
+  - [NAT44](./dataplane/tasks/NAT44.md)
+  - [NAT64 (investigation)](./dataplane/tasks/NAT64-investigation.md)
+  - [NAT64](./dataplane/tasks/NAT64.md)
+  - [NAT66](./dataplane/tasks/NAT66.md)
+  - [One control plane daemon per container](./dataplane/tasks/one-control-plane-daemon-per-container.md)
+  - [Performance measurement](./dataplane/tasks/performance-measurement.md)
+  - [Programmatic Control of FRR](./dataplane/tasks/programmatic-control-of-frr.md)
+  - [Public internet access](./dataplane/tasks/public-internet-access.md)
+  - [Rate limiting investigation](./dataplane/tasks/rate-limiting-investigation.md)
+  - [Route manager](./dataplane/tasks/route-manager.md)
+  - [State sync (design)](./dataplane/tasks/state-sync-design.md)
+  - [State sync (implementation)](./dataplane/tasks/state-sync.md)
+  - [Telemetry (basic)](./dataplane/tasks/telemetry-basic.md)
+  - [Telemetry (integration)](./dataplane/tasks/telemetry-integration.md)
+  - [Telemetry (investigation)](./dataplane/tasks/telemetry-investigation.md)
+  - [Underlay routing](./dataplane/tasks/underlay-routing.md)
+  - [VPC rate-limiting](./dataplane/tasks/vpc-rate-limiting.md)
+  - [VPC routing](./dataplane/tasks/vpc-routing.md)
+  - [VXLAN tunnels](./dataplane/tasks/vxlan-tunnels.md)
+  - [Zebra Plugin](./dataplane/tasks/zebra-plugin.md)
diff --git a/design-docs/src/mdbook/src/context.toml b/design-docs/src/mdbook/src/context.toml
@@ -0,0 +1 @@
+siteRoot="/"
diff --git a/design-docs/src/mdbook/src/css/main.css b/design-docs/src/mdbook/src/css/main.css
@@ -156,21 +156,12 @@ html > body.js.sidebar-hidden {
     color: var(--links);
 }
 
-/*figure {*/
-/*    padding-left: 0.5em;*/
-/*    margin-inline: 0;*/
-/*    width: max(1000px, 50vw);*/
-
-/*    !*max-width: max(1000px, 100%);*!*/
-/*}*/
-
-nav:has(figure:first-child) {
-    width: 1000px;
-    height: 1000px;
-}
+figure {
+    padding-left: 0.5em;
+    margin-inline: 0;
+    width: max(200px, 50vw);
 
-nav > figure {
-    position: fixed;
+    max-width: max(200px, 100%);
 }
 
 figcaption {
@@ -614,12 +605,12 @@ p:hover > a.ref-paragraph:last-child::before {
 }
 
 p:target::before {
-    /*position: relative;*/
-    /*display: inline-block;*/
-    /*content: var(--target-icon);*/
-    /*margin-inline-start: calc(0px - var(--target-icon-distance));*/
-    /*width: var(--target-icon-distance);*/
-    /*border-left: 1px solid var(--links);*/
+    position: relative;
+    display: inline-block;
+    content: var(--target-icon);
+    margin-inline-start: calc(0px - var(--target-icon-distance));
+    width: var(--target-icon-distance);
+    border-left: 1px solid var(--links);
 }
 
 
@@ -667,10 +658,9 @@ p:target {
 }
 
 figure > figcaption {
-    margin-top: 1.5em;
+    margin-top: 0.0em;
     background: var(--table-alternate-bg);
     min-width: 30%;
-    /*width: calc(0.8 * var(--fig-width));*/
     width: fit-content(100%);
 }
 
@@ -679,17 +669,18 @@ figure > figcaption {
     font-style: unset;
 }
 
-figure {
-    display: inline-block;
-}
-
 figure:target::before {
     content: var(--target-icon);
     display: inline-block;
     margin-inline-start: calc(-1 * var(--target-icon-distance));
     width: var(--target-icon-distance);
 }
 
+figure {
+    border-left: 1px solid var(--links);
+    width: fit-content;
+}
+
 a.figure-label, a.figure-label:visited, a.figure-label:target, a.figure-label:hover {
     text-decoration: unset;
     color: unset;
@@ -702,3 +693,16 @@ a.figure-label, a.figure-label:visited, a.figure-label:target, a.figure-label:ho
     margin-inline-start: calc(0px - var(--target-icon-distance));
     width: var(--target-icon-distance);
 }
+
+[href*="://"]::after {
+    content: "\f08e";
+    font-family: FontAwesome, serif;
+    /*vertical-align: super;*/
+    font-weight: normal;
+    font-style: normal;
+    display: inline-block;
+    text-decoration: none;
+    font-size: smaller;
+    padding-left: 3px;
+}
+
diff --git a/design-docs/src/mdbook/src/dataplane/common.puml b/design-docs/src/mdbook/src/dataplane/common.puml