hacking

githedgehog · Dec 1, 2024 · 19e39ce · 19e39ce
1 parent ccfce87
commit 19e39ce
Show file tree

Hide file tree

Showing 17 changed files with 83 additions and 77 deletions.
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -186,7 +186,6 @@ jobs:
         with:
           limit-access-to-actor: true
 
-
   summary:
     name: "Dev Test and Build"
     if: ${{ always() }}

diff --git a/design-docs/src/mdbook/src/SUMMARY.md b/design-docs/src/mdbook/src/SUMMARY.md
@@ -17,40 +17,37 @@
 - [Design session](./dataplane/design-session.md)
 
 - [Development Plan](./dataplane/development-plan.md)
+  - [Configuration Persistence Investigation](./dataplane/tasks2/configuration-persistence-investigation.md)
+  - [Configuration database schema](./dataplane/tasks2/config-db-schema.md)
   - [Control plane dev-env](./dataplane/tasks2/control-plane-dev-env.md)
+  - [Core pinning](./dataplane/tasks2/core-pinning.md)
   - [Create control plane image](./dataplane/tasks2/create-control-plane-image.md)
-  - [FRR Plugin](./dataplane/tasks2/frr-plugin.md)
-    - [Dataplane / Control plane transport](./dataplane/tasks2/dataplane-control-plane-transport.md)
-    - [Dataplane / Control plane protocol](./dataplane/tasks2/dataplane-control-plane-protocol.md)
-    - [Dataplane / Control plane reconcile](./dataplane/tasks2/dataplane-control-plane-reconcile.md)
+  - [Dataplane / Control plane protocol](./dataplane/tasks2/dataplane-control-plane-protocol.md)
+  - [Dataplane / Control plane transport](./dataplane/tasks2/dataplane-control-plane-transport.md)
+  - [Dataplane worker lifecycle](./dataplane/tasks2/dataplane-worker-lifecycle.md)
+  - [Fault tolerance (implementation)](./dataplane/tasks2/fault-tolerance-implementation.md)
+  - [Fault tolerance (validation)](./dataplane/tasks2/fault-tolerance-validation.md)
   - [Gateway test env](./dataplane/tasks2/gateway-test-env.md)
   - [Identify local traffic](./dataplane/tasks2/identify-local-traffic.md)
-  - [Configuration Persistence Investigation](./dataplane/tasks2/configuration-persistence-investigation.md)
-  - [Route manager](./dataplane/tasks2/route-manager.md)
-  - [Dataplane worker lifecycle](./dataplane/tasks2/dataplane-worker-lifecycle.md)
-  - [Telemetry (investigation)](./dataplane/tasks2/telemetry-investigation.md)
-  - [Telemetry (basic)](./dataplane/tasks2/telemetry-basic.md)
-  - [Telemetry (integration)](./dataplane/tasks2/telemetry-integration.md)
-  - [Configuration database schema](./dataplane/tasks2/config-db-schema.md)
-  - [Management plane - dataplane interaction](./dataplane/tasks2/management-plane-dataplane-interaction.md)
-  - [VXLAN tunnels](./dataplane/tasks2/vxlan-tunnels.md)
-
-  - [Underlay routing](./dataplane/tasks2/underlay-routing.md)
-  - [Management plane - dataplane interaction](./dataplane/tasks2/management-plane-dataplane-interaction.md)
   - [Management plane - control plane interaction](./dataplane/tasks2/management-plane-control-plane-interaction.md)
-  - [VPC routing](./dataplane/tasks2/vpc-routing.md)
-  - [Rate limiting investigation](./dataplane/tasks2/rate-limiting-investigation.md)
-  - [VPC rate-limiting](./dataplane/tasks2/vpc-rate-limiting.md)
+  - [Management plane - dataplane interaction](./dataplane/tasks2/management-plane-dataplane-interaction.md)
   - [NAT44](./dataplane/tasks2/NAT44.md)
-  - [NAT66](./dataplane/tasks2/NAT66.md)
   - [NAT64 (investigation)](./dataplane/tasks2/NAT64-investigation.md)
   - [NAT64](./dataplane/tasks2/NAT64.md)
+  - [NAT66](./dataplane/tasks2/NAT66.md)
+  - [One control plane daemon per container](./dataplane/tasks2/one-control-plane-daemon-per-container.md)
+  - [Performance measurement](./dataplane/tasks2/performance-measurement.md)
+  - [Programmatic Control of FRR](./dataplane/tasks2/programmatic-control-of-frr.md)
+  - [Public internet access](./dataplane/tasks2/public-internet-access.md)
+  - [Rate limiting investigation](./dataplane/tasks2/rate-limiting-investigation.md)
+  - [Route manager](./dataplane/tasks2/route-manager.md)
   - [State sync (design)](./dataplane/tasks2/state-sync-design.md)
   - [State sync (implementation)](./dataplane/tasks2/state-sync.md)
-  - [Public internet access](./dataplane/tasks2/public-internet-access.md)
-  - [Fault tolerance (implementation)](./dataplane/tasks2/fault-tolerance-implementation.md)
-  - [Fault tolerance (validation)](./dataplane/tasks2/fault-tolerance-validation.md)
-  - [Performance measurement](./dataplane/tasks2/performance-measurement.md)
-  - [Core pinning](./dataplane/tasks2/core-pinning.md)
-  - [One control plane daemon per container](./dataplane/tasks2/one-control-plane-daemon-per-container.md)
-  - [Programattic Control of FRR](./dataplane/tasks2/programmatic-control-of-frr.md)
+  - [Telemetry (basic)](./dataplane/tasks2/telemetry-basic.md)
+  - [Telemetry (integration)](./dataplane/tasks2/telemetry-integration.md)
+  - [Telemetry (investigation)](./dataplane/tasks2/telemetry-investigation.md)
+  - [Underlay routing](./dataplane/tasks2/underlay-routing.md)
+  - [VPC rate-limiting](./dataplane/tasks2/vpc-rate-limiting.md)
+  - [VPC routing](./dataplane/tasks2/vpc-routing.md)
+  - [VXLAN tunnels](./dataplane/tasks2/vxlan-tunnels.md)
+  - [Zebra Plugin](./dataplane/tasks2/zebra-plugin.md)
diff --git a/design-docs/src/mdbook/src/dataplane/design-session.md b/design-docs/src/mdbook/src/dataplane/design-session.md
@@ -149,7 +149,7 @@ skinparam linetype ortho
   "frr_agent": { "text": "FRR agent", "url": "#frr-agent" },
   "zebra": { "text": "zebra", "url": "https://docs.frrouting.org/en/latest/zebra.html" },
   "routing_daemons": { "text": "routing daemons", "url": "#routing-daemons" },
-  "hh_plugin": { "text": "Hedgehog\\nplugin", "url": "#hedgehog-plugin" },
+  "zebra_plugin": { "text": "Zebra\\nplugin", "url": "#zebra-plugin" },
   "kernel": { "text": "kernel", "url": "#kernel" },
   "interface_manager": { "text": "interface manager", "url": "#interface-manager" },
   "routing_manager": { "text": "routing manager", "url": "#routing-manager" },
@@ -186,7 +186,7 @@ $r(kernel)
 $r(control_plane) {
   $r(routing_daemons)
   $r(zebra) {
-    $r(hh_plugin)
+    $r(zebra_plugin)
   }
   $r(frr_agent)
 }
@@ -223,7 +223,7 @@ dataplane_model <--> nat_manager
 dataplane_model <--> routing_manager
 management_plane_interface -- dataplane_model
 nat_manager <--> dataplane_workers
-hh_plugin --- control_plane_interface : [[ https://en.wikipedia.org/wiki/Unix_domain_socket unix socket ]]
+zebra_plugin --- control_plane_interface : [[ https://en.wikipedia.org/wiki/Unix_domain_socket unix socket ]]
 routing_daemons <-> zebra
 routing_manager <--> dataplane_workers
 state_sync <-> sister_state_sync : [[ https://en.wikipedia.org/wiki/Remote_direct_memory_access rdma]]
@@ -284,11 +284,11 @@ Be afraid. Make Fredi fill in this section. But also be afraid.
 </section>
 <section>
 
-### Hedgehog Plugin
+### Zebra Plugin
 
 This is a planned [zebra] plugin in the same spirit as [`fpm`](https://docs.frrouting.org/projects/dev-guide/en/latest/fpm.html#id1) or [`dataplane_fpm_nl`](https://docs.frrouting.org/projects/dev-guide/en/latest/fpm.html#dplane-fpm-nl).
 
-The core idea is to have a plugin that can be dynamically loaded into `zebra` and will listen to the `zebra` event stream for updates.
+The core idea is to have a plugin that can be dynamically loaded into [zebra] and will listen to the [zebra event stream](https://github.com/FRRouting/frr/blob/ee5a3456d34a756c70ad8856ab7be7bed75ee31c/zebra/zebra_dplane.h#L114-L217) for updates.
 The plugin will then take those updates and push them into the dataplane agent, allowing the dataplane to react to route updates.
 
 </section>

diff --git a/design-docs/src/mdbook/src/dataplane/development-plan.md b/design-docs/src/mdbook/src/dataplane/development-plan.md
@@ -28,14 +28,13 @@ digraph g {
   cp_api_control_investigation [label=<<b>programmatic control of frr<br/>(investigation)</b>>, $urgent, href="$ptr/programmatic-control-of-frr.html", fontcolor=blue]
   cp_dev_env [label="control plane\ndev env", href="$ptr/control-plane-dev-env.html", fontcolor=blue]
   cp_image_creation [ label="Create control plane container image", href="$ptr/create-control-plane-image.html", fontcolor=blue]
-  dp_cp_reconciliation [ label="dp/cp reconcile", href="$ptr/dataplane-control-plane-reconcile.html", fontcolor=blue ]
   dp_dev_env [label="dataplane dev env", $completed, href="../../build/index.html", fontcolor=blue]
   dp_dp_state_sync [label="state sync\n(implementation)", $difficult, href="$ptr/state-sync.html", fontcolor=blue]
   dp_dp_state_sync_design [label="state sync\n(design)", $urgent, href="$ptr/state-sync-design.html", fontcolor=blue]
     dp_image_creation [label="dataplane image build", $completed]
   fault_tolerance [label="fault tolerance (implementation)", href="$ptr/fault-tolerance-implementation.html", fontcolor=blue]
   fault_tolerance_proof [label="fault tolerance (validation)", $difficult, href="$ptr/fault-tolerance-validation.html", fontcolor=blue]
-    frr_plugin_basic [ label="frr plugin\n(basic)", href="$ptr/frr-plugin.html", fontcolor=blue ]
+    zebra_plugin_basic [ label="zebra plugin\n(basic)", href="$ptr/zebra-plugin.html", fontcolor=blue ]
   frr_programmatic_control [label=<<b>programmatic<br/>control of frr</b>>, $difficult, href="$ptr/programmatic-control-of-frr.html", fontcolor=blue]
     gw_test_env [label="gateway test env", href="$ptr/gateway-test-env.html", fontcolor=blue]
   investigate_config_persist [ label=<<b>configuration<br/>persistence<br/>(investigation)</b>>, $urgent, href="$ptr/configuration-persistence-investigation.html", fontcolor=blue ]
@@ -44,8 +43,8 @@ digraph g {
   mp_dp_interaction [ label="management plane \ndataplane interaction", href="$ptr/management-plane-dataplane-interaction.html", fontcolor=blue]
   nat64_investigation [label=<<b>NAT64 investigation</b>>, $urgent, href="$ptr/NAT64-investigation.html", fontcolor=blue]
     performance_measurement [ label="measure performance", href="$ptr/performance-measurement.html", fontcolor=blue]
-  plugin_dp_proto [ label="plugin/dp protocol", $started, href="$ptr/dataplane-control-plane-protocol.html", fontcolor=blue]
-  plugin_dp_transport [ label="plugin/dp transport", $completed, href="$ptr/dataplane-control-plane-transport.html", fontcolor=blue]
+  plugin_dp_proto [ label="plugin/dataplane protocol", $started, href="$ptr/dataplane-control-plane-protocol.html", fontcolor=blue]
+  plugin_dp_transport [ label="plugin/dataplane transport", $completed, href="$ptr/dataplane-control-plane-transport.html", fontcolor=blue]
   public_internet_access [label="public internet access", href="$ptr/public-internet-access.html", fontcolor=blue]
   rate_limiting_investigation [label="rate limiting investigation", $completed]
   routing_manager [label="routing manager", href="$ptr/route-manager.html", fontcolor=blue]
@@ -92,17 +91,16 @@ digraph g {
   cp_dev_env -> gw_test_env
   cp_image_creation -> cp_dev_env
   cp_image_creation -> separate_cp_containers
-  dp_cp_reconciliation -> frr_plugin_basic
   dp_dev_env -> gw_test_env
   dp_image_creation -> dp_dev_env
-  gw_test_env -> frr_plugin_basic
-  frr_plugin_basic -> routing_manager
+  gw_test_env -> zebra_plugin_basic
+  zebra_plugin_basic -> routing_manager
   config_db_schema -> mp_cp_interaction
   config_db_schema -> mp_dp_interaction
-  local_traffic_ident -> frr_plugin_basic
+  local_traffic_ident -> zebra_plugin_basic
   mp_dp_interaction -> vpc_routing
-  plugin_dp_proto -> dp_cp_reconciliation
-  plugin_dp_transport -> dp_cp_reconciliation
+  plugin_dp_proto -> zebra_plugin_basic
+  plugin_dp_transport -> zebra_plugin_basic
   routing_manager -> underlay_routing
   config_db_schema -> underlay_routing
   vpc_routing -> vpc_nat44

diff --git a/design-docs/src/mdbook/src/dataplane/tasks/pick-a-datastore.md b/design-docs/src/mdbook/src/dataplane/tasks/pick-a-datastore.md
@@ -29,15 +29,4 @@ The remaining option I know of is [`rqlite`]. _I have not used it,_ but it seems
 
 Thus, I think the real choice is between [`etcd`] and [`rqlite`].
 
-That choice comes down to how much we value the functionality of sqlite (multiple indexes, referential integrity, strong schema) vs. the upsides of `etcd` (watches, battle tested and more widely used).
-
-
-<x-labels>
-
-- management
-- data-store
-
-</x-labels>
-
-[`rqlite`]:  https://rqlite.io/
-[`etcd`]: https://github.com/coreos/etcd
+That choice comes down to how much we value the functionality of sqlite (multiple indexes, referential integrity, strong schema) vs. the upsides of [etcd] (watches, battle tested, and more widely used).
diff --git a/...docs/src/mdbook/src/dataplane/tasks2/configuration-persistence-investigation.md b/...docs/src/mdbook/src/dataplane/tasks2/configuration-persistence-investigation.md
@@ -12,7 +12,7 @@ Rather, this store needs to hold configuration data which is
 
 ## etcd
 
-[`etcd`] is a reasonable choice because
+[etcd] is a reasonable choice because
 
 1. It is already in use in kubernetes and is therefore likely to be well-maintained and tested.
 2. we are already using / integrating with kubernetes so any flaws in `etcd` are likely to impact us anyway.

diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/control-plane-dev-env.md b/design-docs/src/mdbook/src/dataplane/tasks2/control-plane-dev-env.md
@@ -1,6 +1,6 @@
 # Control plane dev-env
 
-Create and document a development environment for the [`zebra`] [hedgehog plugin].
+Create and document a development environment for the [zebra] [hedgehog plugin].
 
 Requirements:
 
@@ -9,7 +9,6 @@ Requirements:
 - **REQUIRE**: CI runs tests in dev-env container or,
 - **IDEALLY**: tests run in a more minimal test-env container.
 
-```yaml issue-meta
-assign:
-  - @Fredi Raspall
-```
+## Likely dispatch
+
+- [@Fredi-raspall]
diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/core-pinning.md b/design-docs/src/mdbook/src/dataplane/tasks2/core-pinning.md
@@ -1,4 +1,4 @@
 # Core pinning
 
 > [!NOTE]
-> I think we can punt on this till the last minute!
+> I think we can punt on this until the last minute!
diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/create-control-plane-image.md b/design-docs/src/mdbook/src/dataplane/tasks2/create-control-plane-image.md
@@ -16,10 +16,9 @@ We need to generate a docker image to run our control plane.
 
 Both [@Fredi-raspall] and [@daniel-noland] have made some progress on this task and should sync up to get it over the line.
 
-```yaml issue-meta
-assign:
-  - @Fredi Raspall
-```
+## Likely dispatch
+
+- [@Fredi-raspall]
 
 [Lua scripting]: https://docs.frrouting.org/en/latest/scripting.html
 

diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/dataplane-control-plane-transport.md b/design-docs/src/mdbook/src/dataplane/tasks2/dataplane-control-plane-transport.md
@@ -2,7 +2,7 @@
 
 It seems like we have all agreed on [unix domain sockets].
 
-## Likely assignment
+## Likely dispatch
 
 * [@Fredi-raspall]
 * coordinate with: [@daniel-noland]

diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/frr-plugin.md b/design-docs/src/mdbook/src/dataplane/tasks2/frr-plugin.md
diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/vpc-rate-limiting.md b/design-docs/src/mdbook/src/dataplane/tasks2/vpc-rate-limiting.md
@@ -2,5 +2,7 @@
 
 Just rate limiting!
 
-Explicitly not full QoS for the moment.
-If we involve QoS in the MVP then we will have zero chance on this timeline.
+Explicitly not full [QoS] for the moment.
+If we involve [QoS] in the MVP then we will have zero chance on this timeline.
+
+{{#include ../../links.md}}
diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/zebra-plugin b/design-docs/src/mdbook/src/dataplane/tasks2/zebra-plugin
@@ -0,0 +1 @@
+# FRR Plugin
diff --git a/design-docs/src/mdbook/src/dataplane/tasks2/zebra-plugin.md b/design-docs/src/mdbook/src/dataplane/tasks2/zebra-plugin.md
@@ -0,0 +1,24 @@
+# Zebra Plugin (basic)
+
+The dataplane and control plane need to communicate with each other regarding
+
+1. Full routing tables (for [state sync])
+2. route updates (i.e. differential updates)
+3. route offloading status (including failures)
+4. Address assignments, to ensure the dataplane can configure [local delivery](./identify-local-traffic.md)
+
+Keep in mind that route tables are, in general, notably more complex than a naive LPM trie, and may include like:
+
+1. [ECMP]/WCMP
+2. [encapsulation rules](https://www.man7.org/linux/man-pages/man8/ip-route.8.html),
+3. [nexthop groups](https://man7.org/linux/man-pages/man8/ip-nexthop.8.html),
+4. multicast routes (this is unlikely to be important in the near term).
+
+We only expect to support basic IPv4 and IPv6 LPM routes in the near term, but feature evolution should be accounted for in the design.
+
+## Likely dispatch
+
+* [@Fredi-raspall]
+* coordinate with: [@daniel-noland]
+
+{{#include ../../links.md}}
diff --git a/design-docs/src/mdbook/src/links.md b/design-docs/src/mdbook/src/links.md
@@ -24,6 +24,7 @@
 [LACP]: https://en.wikipedia.org/wiki/Link_aggregation#Link_Aggregation_Control_Protocol
 [MySQL]: https://www.mysql.com/
 [NAT]: https://en.wikipedia.org/wiki/Network_address_translation
+[QoS]: https://en.wikipedia.org/wiki/Quality_of_service
 [TiDB]: https://www.pingcap.com/
 [TiKV]: https://tikv.org/
 [VXLAN]: https://en.wikipedia.org/wiki/Virtual_Extensible_LAN
@@ -42,6 +43,7 @@
 [cbindgen]: https://github.com/mozilla/cbindgen
 [distributed SQL]: https://en.wikipedia.org/wiki/Distributed_SQL
 [dpdk]: https://www.dpdk.org/
+[etcd]: https://github.com/coreos/etcd
 [frr]: https://frrouting.org/
 [graphana]: https://grafana.com/
 [kernel]: https://en.wikipedia.org/wiki/Linux_kernel
@@ -51,6 +53,7 @@
 [network address translation]: https://en.wikipedia.org/wiki/Network_address_translation
 [prometheus]: https://prometheus.io/
 [protobuf]: https://protobuf.dev/
+[rqlite]:  https://rqlite.io/
 [rte lcores]: https://doc.dpdk.org/api/rte__lcore_8h.html
 [serde]: https://serde.rs/
 [tracing]: https://docs.rs/tracing/latest/tracing/

diff --git a/justfile b/justfile
@@ -483,11 +483,12 @@ mdbook *args="build":
     {{ _just_debuggable_ }}
     mkdir -p /tmp/doc-env
     cd ./design-docs/src/mdbook
-    docker pull {{ _doc_env_container }}
+    # docker pull {{ _doc_env_container }}
     docker run \
       --rm \
       --init \
       --volume "$(pwd):$(pwd)" \
+      --env HOME=/tmp \
       --user "$(id -u):$(id -g)" \
       --mount type=bind,source=/tmp/doc-env,target=/tmp \
       --workdir "$(pwd)" \

diff --git a/scripts/dpdk-sys.env b/scripts/dpdk-sys.env
@@ -1,2 +1 @@
-DPDK_SYS_BRANCH="main"
-DPDK_SYS_COMMIT="362f54faf27e7b02148fe524492455e2f6762854"
+DPDK_SYS_COMMIT="927f4346e46c724f93af0e55b07de6282f9f3036"