How liqotech/liqo works
From the file tree and README, it’s clear that Liqo is an open-source project built in Go that “enables dynamic and seamless Kubernetes multi-cluster topologies.” Its primary purpose is to allow heterogeneous clusters (spanning on-prem, cloud, edge) to peer with each other, offload workloads, and establish a transparent, secure network fabric (with additional support for stateful/storage fabrics). The project consists of multiple Go modules (including extensive CRDs, controllers, and CLI tools) that work together to extend native Kubernetes functionalities for multi-cluster communication.
Main Components
– Authentication (handling certificate creation, identity, nonce signing, etc.)
– Networking (handling external network configurations, internal-network fabric, IPAM integrations, firewall, and gateway tunnels [both Geneve and WireGuard])
– Offloading (managing offloaded workloads, namespace offloading, and virtual nodes)
– Additional controllers (e.g., CRD replicator, shadowpod controller, etc.)
• Liqo CLI (liqoctl): The command-line interface that interacts with the cluster to manage installation, offloading policies, and configuration. Mark this as a separate component that communicates with the Liqo controller manager.
• Gateways & Tunnels: Distinct gateway components (Geneve and WireGuard implementations) are built and deployed (as seen in cmd/gateway and pkg/gateway) to set up secured tunnels between clusters.
• Deployment Infrastructure: Include the deployment charts (the “deployments/liqo” folder) which are used to install Liqo in clusters and are part of the overall installation/management architecture.
• Supporting Tools / Infrastructure: Optionally, include build processes (build directory with Dockerfiles, Makefile) and testing (test/e2e) to illustrate the CI/CD pipeline and how changes are validated.
Relationships and Interactions
– Within each cluster, show the controller manager interacting with the Kubernetes API server via CRDs.
– Illustrate sub-module interactions inside the controller manager. For example, authentication modules work with identity managers and certificate creation modules, while networking modules interact with IPAM, firewall, and gateway (both client and server) submodules.
– Demonstrate that the custom resources (CRDs) enable registration and management of key Liqo objects representing peerings, offloaded workloads, and networking configurations.
Architectural Patterns and Technologies
– Modular design: Each functional area (authentication, networking, offloading) is implemented as separate modules (see the “pkg” and “internal” directories).
– Kubernetes Extension: Emphasize the use of CRDs and controllers to hook into Kubernetes ecosystems, following patterns common in Kubernetes operator frameworks.
– Multi-cluster/Distributed Architecture: Represent distinct clusters that can be on different cloud providers or on-prem, connected via secure tunnels.
– Containerization and CI/CD: Reflect the Docker builds and GitHub workflows that drive image creation and integration tests.
– Use of Go: Indicate that the primary implementation language is Go (as seen from file names like .go, go.mod, etc.), which is critical from a design viewpoint in terms of concurrency and reliability.