Document codebase architecture

[qmonnet]

What repo, what piece of code does what, and so on. Would be helpful to dive in the code base, or just keep track of the code and resources we have.

[qmonnet]

Work in progress below:

---

Hedgehog Dataplane Repositories Architecture

Dataplane repository

Repository

https://github.com/githedgehog/dataplane

Role

Main repository for dataplane/gateway

Notes

• Public repository
• Set up with dependencies etc. and CI for working on the dataplane

CI

• bump.yml: Update dpdk-sys dependency (compile-env)
• dev.yml, sterile.yml: Tests for PRs
• docs.yml: Generate design docs from dataplane repo (GitHub pages)

dpdk-sys: Toolchain for dataplane

Repository

https://github.com/githedgehog/dpdk-sys

Role

Contains the build framework, description files, dependency list, and workflow description for building the compilation environment for the dataplane. The resulting compile-env image is pulled from the dataplane repository.

Notes

• Public repository
• Motivation: These are all linked to the dataplane repository and, technically, could be in the same repository. However, rebuilding the compilation environment is seldom necessary, and takes time, so it is move efficient to have it as a separate repository.

CI

• build.yml:

  1. Generate matrix from builds.yml (updated with bump.sh)
  2. "just [...] push"
     1. Builds sysroot
     2. Builds frr, compile-env, doc-env containers
     3. pushes:
        • dpdk-sys/compile-env -> compilation environment for dataplane
        • dpdk-sys/doc-env -> docs
        • dpdk-sys/frr -> ? (seems unused at the moment)
     4. Generate SBOM
  3. (For PRs: print summary of outdated/vulnerable packages)

• bump.yml: Update external dependencies

tmp-nat: NAT experiments

Repository

https://github.com/githedgehog/tmp-nat

Role

Experimental repository for working on NAT, on the structure of the related objects, and on the related lookups

Notes

• Currently a private repository
• Meant to be a temporary repository; should be merged into dataplane
• Movitation: Couldn't build code from dataplane repository on macOS, so created a separate repository for experimenting
• No CI to date

Control plane

Repositories

• https://github.com/githedgehog/gw-controlplane
  • https://github.com/githedgehog/dplane-rpc
  • https://github.com/githedgehog/dplane-plugin
  • https://github.com/githedgehog/frr

Role

Control plane components

Notes

• FRR: Clone from upstream, currently unchanged
• Currently private repositories (except for the FRR fork)
• gw-controlplane pulls the three others as Git submodules
• No CI to date

[daniel-noland]

The build process section of the design doc is likely of some use here. Perhaps closing this ticket should take the form up an update to that

[qmonnet]

Yes you're right, I'll try to move it there soon 👍