https://github.com/lucheng0127/kube-eip
An add-on for to provide access to k8s internal ip through an elastic ip
https://github.com/lucheng0127/kube-eip
bgp eip elastic-ip
Last synced: 4 months ago
JSON representation
An add-on for to provide access to k8s internal ip through an elastic ip
- Host: GitHub
- URL: https://github.com/lucheng0127/kube-eip
- Owner: lucheng0127
- License: gpl-3.0
- Created: 2023-11-14T19:22:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T07:53:05.000Z (about 2 years ago)
- Last Synced: 2024-04-21T17:04:10.922Z (about 2 years ago)
- Topics: bgp, eip, elastic-ip
- Language: Go
- Homepage:
- Size: 17.8 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kube-eip
[中文](./docs/README_zh.md)
**Kube-eip** is an add-on for k8s. The aim is to provide an access to k8s internal ip(such as pod ip or service ip) through elastic ip.
**Kubevirt eip support**
For kubevirt vmi eip support, install the [virteip-operator](https://github.com/lucheng0127/virteip-operator)
## Architecture
At it's core, kube-eip use the rules of iptables implement the transform between eip and vm instance ip. By default we access the pod and service network via vmi pod ip, others by eip, if make a eipBinding to a vmi pod. For convenience we use ipset to manage the networks of pods and service, and alse this's a policy route for each eipBinding, make sure that we connect to other pods with vmi pod ip.
Then for eip routes, we use bgp to declare that the nexthop to access vmi pod that binded eip. There ware a series bgp server we can choise, but we can use gobgp as the bgp library native.
## Modules
EipAgent run as daemonset on every k8s hyper node. And the eipctl is a command line tools call EipAgent by gRPC to apply the eipbinding rules on hyper.
## Usage
The stable docker images
* quay.io/shawnlu0127/eip_agent:20231204 (Use iptables-legacy)
* quay.io/shawnlu0127/eip_agent:20240322 (Use iptables-nft)
* quay.io/shawnlu0127/eipctl:20240319 (Used by eipbinding job created by virteip-operator)
**Attention:**
Check your hyper node iptables version by iptables -V.
* iptables-legacy: eip_agent:20231204
* iptables-nft: eip_agent:20240322
*TODO(user): modify configmap eip-agent-cm (config/agent/eip_agent.yaml)*
```
# Modify it before deploy eip_agent kube-eip/config/agent/eip_agent.yaml
...
# TODO(user): change content of config map
apiVersion: v1
kind: ConfigMap
metadata:
name: eip-agent-cm
namespace: kube-eip-agent
data:
svc_net: 192.168.223.0/24 # K8s service ip cidr
pod_net: 10.244.0.0/16 # K8s pod ip cidr
eip_net: 192.168.18.0/24 # The public network cidr
eip_gw_ip: 192.168.18.1 # The public network gateway
eip_gw_dev: enp2s0 # The interface on each hyper, that access public netwrok interface(If interface name not same, add a linux bridge with the same name(such as br-pub) and add interface to linux bridge)
log_level: debug
...
```
```
# Deploy
IMG={your own image name and tag} make deploy-agent
# Undeploy
make undeploy-agent
```
**Build your own image, push and deploy**
```
# Build eipbinding operator, eip agent and eipctl
IMG=quay.io/shawnlu0127/eip_agent:20231204 make docker-build-agent
IMG=quay.io/shawnlu0127/eipctl:20240319 make docker-build-ctl
# Push your image
IMG=quay.io/shawnlu0127/eip_agent:20231204 make docker-push
IMG=quay.io/shawnlu0127/eipctl:20240319 make docker-push
# Deploy eipbinding operator and eip agent
IMG=quay.io/shawnlu0127/eip_agent:20231204 make deploy-agent
# Undeploy
make undeploy-agent
```
**eipctl**
eipctl is an command line tool to bind or unbind eip to or from vmi
```
root@shawn-server:~/workspace/kube-eip# eipctl -h
NAME:
eipctl - A new cli application
USAGE:
eipctl [global options] command [command options] [arguments...]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--target value rpc server address, default 127.0.0.1:6127 (default: "127.0.0.1:6127")
--eip-ip value eip ip address
--vmi-ip value vmi ip address
--action value action, bind or unbind
--help, -h show help
```
**eip_agent**
eip_agent run as daemonset in pod, there is the help info of it
```
root@shawn-server:~/workspace/kube-eip# eip_agent -h
NAME:
EipAgent - A new cli application
USAGE:
EipAgent [global options] command [command options] [arguments...]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--port value agent port that rpc listen on (default: 6127)
--log-level value log level, default info (default: "info")
--internal-net value [ --internal-net value ] networks that exclude from nat
--gateway-ip value externel network gateway ip address
--gateway-dev value externel network gateway device
--bgp-type value bgp manager type, default is none, gobgp is avaliable (default: "none")
--eip-cidr value eip network cidr
--arp-poisoning whether use arp poisoning to make a arp reply for eip, default is false, when enable will not add eip to external network gateway device (default: false)
--help, -h show help
```
**Have fun and enjoy it ٩(๑>◡<๑)۶**
```
root@shawn-server:~/workspace/kube-eip# kubectl get all -n kube-eip-system
Warning: kubevirt.io/v1 VirtualMachineInstancePresets is now deprecated and will be removed in v2.
NAME READY STATUS RESTARTS AGE
pod/kube-eip-controller-manager-5df4d7d5fd-8qtr6 2/2 Running 0 2m11s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/kube-eip-controller-manager-metrics-service ClusterIP 192.168.223.251 8443/TCP 2m11s
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/kube-eip-controller-manager 1/1 1 1 2m11s
NAME DESIRED CURRENT READY AGE
replicaset.apps/kube-eip-controller-manager-5df4d7d5fd 1 1 1 2m11s
root@shawn-server:~/workspace/kube-eip# kubectl get all -n kube-eip-agent
Warning: kubevirt.io/v1 VirtualMachineInstancePresets is now deprecated and will be removed in v2.
NAME READY STATUS RESTARTS AGE
pod/eip-agent-2dkbb 1/1 Running 0 2m34s
pod/eip-agent-klcpd 1/1 Running 0 2m34s
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
daemonset.apps/eip-agent 2 2 2 2 2 2m34s
root@shawn-server:~/workspace/kube-eip# kubectl get eipbinding
NAME AGE
cirros 45s
```