Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-cluster-management-io/cluster-proxy
An OCM addon that automates the installation of Kubernetes' konnectivity servers and agents.
https://github.com/open-cluster-management-io/cluster-proxy
kubernetes
Last synced: 2 days ago
JSON representation
An OCM addon that automates the installation of Kubernetes' konnectivity servers and agents.
- Host: GitHub
- URL: https://github.com/open-cluster-management-io/cluster-proxy
- Owner: open-cluster-management-io
- License: apache-2.0
- Created: 2021-10-08T02:44:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T08:31:25.000Z (about 2 months ago)
- Last Synced: 2024-12-22T20:58:25.279Z (6 days ago)
- Topics: kubernetes
- Language: Go
- Homepage:
- Size: 7.27 MB
- Stars: 46
- Watchers: 4
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG/CHANGELOG-0.3.0.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Cluster Proxy
[](http://www.apache.org/licenses/LICENSE-2.0.html)
[](https://github.com/open-cluster-management-io/cluster-proxy/actions/workflows/go-presubmit.yml)
## What is Cluster Proxy?
Cluster Proxy is a pluggable addon working on OCM rebased on the extensibility
provided by [addon-framework](https://github.com/open-cluster-management-io/addon-framework)
which automates the installation of [apiserver-network-proxy](https://github.com/kubernetes-sigs/apiserver-network-proxy)
on both hub cluster and managed clusters. The network proxy will be establishing
reverse proxy tunnels from the managed cluster to the hub cluster to make the
clients from the hub network can access the services in the managed clusters'
network even if all the clusters are isolated in different VPCs.
Cluster Proxy consists of two components:
- __Addon-Manager__: Manages the installation of proxy-servers i.e. proxy ingress
in the hub cluster.
- __Addon-Agent__: Manages the installation of proxy-agents for each managed
clusters.
The overall architecture is shown below:
## Getting started
### Prerequisite
- OCM registration (>= 0.5.0)
### Steps
#### Installing via Helm Chart
1. Adding helm repo:
```shell
$ helm repo add ocm https://openclustermanagement.blob.core.windows.net/releases/
$ helm repo update
$ helm search repo ocm/cluster-proxy
NAME CHART VERSION APP VERSION DESCRIPTION
ocm/cluster-proxy <..> 1.0.0 A Helm chart for Cluster-Proxy
```
2. Install the helm chart:
```shell
$ helm install \
-n open-cluster-management-addon --create-namespace \
cluster-proxy ocm/cluster-proxy
$ kubectl -n open-cluster-management-cluster-proxy get pod
NAME READY STATUS RESTARTS AGE
cluster-proxy-5d8db7ddf4-265tm 1/1 Running 0 12s
cluster-proxy-addon-manager-778f6d679f-9pndv 1/1 Running 0 33s
...
```
3. The addon will be automatically installed to your registered clusters,
verify the addon installation:
```shell
$ kubectl get managedclusteraddon -A | grep cluster-proxy
NAMESPACE NAME AVAILABLE DEGRADED PROGRESSING
cluster-proxy True
```
### Usage
By default, the proxy servers are running in GPRC mode so the proxy clients
are expected to proxy through the tunnels by the [konnectivity-client](https://github.com/kubernetes-sigs/apiserver-network-proxy#clients).
Konnectivity is the underlying technique of Kubernetes' [egress-selector](https://kubernetes.io/docs/tasks/extend-kubernetes/setup-konnectivity/)
feature and an example of konnectivity client is visible [here](https://github.com/open-cluster-management-io/cluster-proxy/tree/main/examples/test-client).
Codewisely proxying to the managed cluster will be simply overriding the
dialer of the kubernetes original client config object, e.g.:
```go
// instantiate a gprc proxy dialer
tunnel, err := konnectivity.CreateSingleUseGrpcTunnel(
context.TODO(),
,
grpc.WithTransportCredentials(grpccredentials.NewTLS(proxyTLSCfg)),
)
cfg, err := clientcmd.BuildConfigFromFlags("", kubeconfig)
if err != nil {
return err
}
// The managed cluster's name.
cfg.Host = clusterName
// Override the default tcp dialer
cfg.Dial = tunnel.DialContext
```
### Performance
Here's the result of network bandwidth benchmarking via [goben](https://github.com/udhos/goben)
with or without Cluster-Proxy (i.e. Apiserver-Network-Proxy) so roughly the proxying
through the tunnel will involve 1/2 performance loss so it's recommended to avoid
transferring data-intensive traffic over the proxy.
| Bandwidth | Direct | over Cluster-Proxy |
|-------------|------------|--------------------|
| Read/Mbps | 902 Mbps | 461 Mbps |
| Write/Mbps | 889 Mbps | 428 Mbps |
## References
- Design: [https://github.com/open-cluster-management-io/enhancements/tree/main/enhancements/sig-architecture/14-addon-cluster-proxy](https://github.com/open-cluster-management-io/enhancements/tree/main/enhancements/sig-architecture/14-addon-cluster-proxy)
- Addon-Framework: [https://github.com/open-cluster-management-io/addon-framework](https://github.com/open-cluster-management-io/addon-framework)