https://github.com/hermanbanken/k8s-xds
XDS server for Kubernetes
https://github.com/hermanbanken/k8s-xds
Last synced: 8 months ago
JSON representation
XDS server for Kubernetes
- Host: GitHub
- URL: https://github.com/hermanbanken/k8s-xds
- Owner: hermanbanken
- License: mit
- Created: 2022-02-25T18:32:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-18T21:00:46.000Z (over 3 years ago)
- Last Synced: 2024-12-27T18:42:03.887Z (10 months ago)
- Language: Go
- Size: 3.59 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kubernetes xDS server
This small server can be used for:
- gRPC client-side Load Balancing
- Envoy cluster CDS
Configuration in the client (supported clients as of september 2020: C-core, Java & Go) goes like this:
- 1. Set the environment variable `GRPC_XDS_BOOTSTRAP=/bootstrap.json` ([doc](https://github.com/grpc/grpc-go/tree/master/examples/features/xds))
- 2. Add this file `/bootstrap.json` containing these contents:
```json
{
"xds_servers": [{
"server_uri": "xds-server-address:8080"
}],
"node": {
"id": "$HOSTNAME",
"metadata": {
"SOME_KEY": "SOME_VALUE"
},
"locality": {
"zone": "europe-west4-a"
}
}
}
```
- 3. Create the gRPC client like this:
```go
import (
_ "google.golang.org/grpc/xds" // To install the xds resolvers and balancers.
)
grpc.Dial("xds:///upstream-service", grpc.WithInsecure())
```
## References
1. [Guide to the xDS protocol](https://www.envoyproxy.io/docs/envoy/latest/api-docs/xds_protocol)
1. Original proposal: https://github.com/grpc/proposal/blob/master/A27-xds-global-load-balancing.md
1. https://itnext.io/proxyless-grpc-load-balancing-in-kubernetes-ca1a4797b742 & https://github.com/asishrs/proxyless-grpc-lb
1. [GoogleBlog: efficient multi-zone and topology aware routing](https://opensource.googleblog.com/2020/11/kubernetes-efficient-multi-zone.html)
1. This is an (more flexible) alternative to the [TopologyAwareHints beta-feature in Kubernetes 1.23+](https://kubernetes.io/docs/concepts/services-networking/topology-aware-hints/)
1. [Using xDS v3: server_features <- xds_v3](https://github.com/grpc/proposal/blob/master/A30-xds-v3.md)
1. [gRPC xDS Loadbalancing](https://github.com/salrashid123/grpc_xds)
1. [debug gRPC xDS clients](https://github.com/grpc-ecosystem/grpcdebug#debug-xds)