KubeVPN

中文 | English | Wiki

KubeVPN offers a Cloud-Native Dev Environment that seamlessly connects to your Kubernetes cluster network.

Gain access to the Kubernetes cluster network effortlessly using service names or Pod IP/Service IP. Facilitate the interception of inbound traffic from remote Kubernetes cluster services to your local PC through a service mesh and more.

For instance, you have the flexibility to run your Kubernetes pod within a local Docker container, ensuring an identical environment, volume, and network setup.
With KubeVPN, empower yourself to develop applications entirely on your local PC!

Content

QuickStart
Functions
FAQ
Architecture

QuickStart

Install from GitHub release

LINK

Install from custom krew index

Install from build it manually

Install bookinfo as demo application

For clean up after test

Functions

Connect to k8s cluster network

Domain resolve

Short domain resolve

To access the service in the cluster, service name or you can use the short domain name, such
as productpage

Disclaimer: This only works on the namespace where kubevpn-traffic-manager is deployed. Otherwise, use Domain resolve

Connect to multiple kubernetes cluster network

Reverse proxy

For local testing, save the following code as hello.go

and compile it

then run it

response would like below

also you can access via service name

Reverse proxy with mesh

Support HTTP, GRPC and WebSocket etc. with specific header “a: 1” will route to your local machine

first access without header “a: 1”, it will access existing pod on kubernetes cluster.

Now let’s access local service with header “a: 1”

If you want to cancel proxy, just run command:

Dev mode in local Docker 🐳

Run the Kubernetes pod in the local Docker container, and cooperate with the service mesh to intercept the traffic with
the specified header to the local, or all the traffic to the local.

You can see that it will start up two containers with docker, mapping to pod two container, and share port with same
network, you can use localhost:port
to access another container. And more, all environment、volume and network are the same as remote kubernetes pod, it is
truly consistent with the kubernetes runtime. Makes develop on local PC come true.

Here is how to access pod in local docker container

Verify logs of nginx container

If you just want to start up a docker image, you can use a simple way like this:

Example：

Now the main process will hang up to show you log.

If you want to specify the image to start the container locally, you can use the parameter –docker-image. When the
image does not exist locally, it will be pulled from the corresponding mirror warehouse. If you want to specify startup
parameters, you can use –entrypoint parameter, replace it with the command you want to execute, such
as –entrypoint /bin/bash, for more parameters, see kubevpn dev –help.

DinD ( Docker in Docker ) use kubevpn in Docker

If you want to start the development mode locally using Docker in Docker (DinD), because the program will read and
write the /tmp directory, you need to manually add the parameter -v /tmp:/tmp (outer docker) and another thing is you
need to special parameter –network (inner docker) for sharing network and pid

Example:

during test, check what container is running

For clean up after test

Multiple Protocol

TCP
UDP
ICMP
GRPC
WebSocket
HTTP
…

Cross-platform

macOS
Linux
Windows

on Windows platform, you need to
install PowerShell
in advance

FAQ

1, What should I do if the dependent image cannot be pulled, or the inner environment cannot access docker.io?

Answer: here are two solutions to solve this problem

Solution 1: In the network that can access docker.io, transfer the image in the command kubevpn version to your own
private image registry, and then add option –image to special image when starting the command.
Example:

Image is docker.io/naison/kubevpn:v2.0.0, transfer this image to private docker registry

Then you can use this image, as follows:

Solution 2: Use options –transfer-image, enable this flags will transfer image from default image to –image
special address automatically。
Example

2, When use kubevpn dev, but got error code 137, how to resolve?

This is because of your docker-desktop required resource is less than pod running request resource, it OOM killed, so
you can add more resource in your docker-desktop setting Preferences –> Resources –> Memory

3, Using WSL( Windows Sub Linux ) Docker, when use mode kubevpn dev, can not connect to cluster network, how to solve this problem?

Answer:

this is because WSL’Docker using Windows’s Network, so if even start a container in WSL, this container will not use WSL
network, but use Windows network

Solution:

1): install docker in WSL, not use Windows Docker-desktop
2): use command kubevpn connect on Windows, and then startup kubevpn dev in WSL
3): startup a container using command kubevpn connect on Windows, and then
startup kubevpn dev –network container:$CONTAINER_ID in WSL

4，After use command kubevpn dev enter develop mode，but can’t assess kubernetes api-server，occur error 172.17.0.1:443 connect refusued，how to solve this problem?

Answer:

Maybe k8s network subnet is conflict with docker subnet

Solution:

Use option –connect-mode container to startup command kubevpn dev

Modify ~/.docker/daemon.json, add not conflict subnet, eg: “bip”: “172.15.0.1/24”.

add subnet not conflict, eg: 172.15.0.1/24

restart docker and retry

Architecture

Architecture can be found here.