README
¶
control-plane
This repository contains a Go-based implementation of an API server that implements the discovery service APIs defined in data-plane-api.
Scope
Due to the variety of platforms out there, there is no single control plane implementation that can satisfy everyone's needs. Hence this code base does not attempt to be a full scale control plane for a fleet of Envoy proxies. Instead, it provides infrastructure that is shared by multiple different control plane implementations. The components provided by this library are:
-
API Server: A generic gRPC based API server that implements xDS APIs as defined in the data-plane-api. The API server is responsible for pushing configuration updates to Envoys. Consumers should be able to import this go library and use the API server as is, in production deployments.
-
Configuration Cache: The library will cache Envoy configurations in memory in an attempt to provide fast response to consumer Envoys. It is the responsibility of the consumer of this library to populate the cache as well as invalidate it when necessary. The cache will be keyed based on a pre-defined hash function whose keys are based on the Node information.
At this moment, this repository will not tackle translating platform specific representation of resources (e.g., services, instances of services, etc.) into Envoy-style configuration. Based on usage and feedback, we might decided to revisit this aspect at a later point in time.
Requirements
- Go 1.9+
Quick start
- Setup tools and dependencies
make tools
make depend.install
-
Edit the code in your favorite IDE
-
Format, vet and lint the code
make check
- Build and test
make build
make test
- Run integration test against the latest Envoy docker image:
make integration.docker
Directories
¶
| Path | Synopsis |
|---|---|
|
envoy
|
|
|
pkg
|
|
|
cache
Package cache defines a configuration cache for the server.
|
Package cache defines a configuration cache for the server. |
|
log
Package log provides a logging interface for use in this library.
|
Package log provides a logging interface for use in this library. |
|
server
Package server provides an implementation of a streaming xDS server.
|
Package server provides an implementation of a streaming xDS server. |
|
test
Package test contains test utilities
|
Package test contains test utilities |
|
test/main
Package main contains the test driver for testing xDS manually.
|
Package main contains the test driver for testing xDS manually. |
|
test/resource
Package resource creates test xDS resources
|
Package resource creates test xDS resources |
|
util
Package util contains shared utility functions.
|
Package util contains shared utility functions. |