Need help with ktunnel?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

omrikiei
405 Stars 29 Forks GNU General Public License v3.0 223 Commits 5 Opened issues

Description

A cli that exposes your local resources to kubernetes

Services available

!
?

Need anything else?

Contributors list

# 317,998
Kuberne...
TypeScr...
HTML
autocom...
173 commits
# 19,323
TypeScr...
bundler
executa...
Node.js
11 commits
# 396,540
Shell
HTML
google-...
Docker
3 commits
# 319,194
HTML
PHP
Node.js
ebay
1 commit
# 730,128
Ruby
Shell
Go
1 commit
# 84,866
php-fra...
Yii Fra...
SQL
golang
1 commit
# 52,095
Common ...
opentsd...
webasse...
epl
1 commit
# 628,956
HTML
ash
Bash
Vim
1 commit

Ktunnel logo

ktunnel

Status GitHub Issues GitHub Pull Requests License: GPL v3


Expose your local resources to kubernetes

📝 Table of Contents

🏁 Installation

| Distribution | Command / Link | |-----------------------------------------------------|-----------------------------------------------------------------------------------------| | Pre-built binaries for macOS, Linux, and Windows | GitHub releases | | Homebrew (macOS and Linux) |

brew tap omrikiei/ktunnel && brew install omrikiei/ktunnel/ktunnel
| | Krew |
kubectl krew install tunnel
|

Building from source

Clone the project

git clone https://github.com/omrikiei/ktunnel; cd ktunnel
Build the binary
CGO_ENABLED=0 go build -ldflags="-s -w"
You can them move it to your bin path
sudo mv ./ktunnel /usr/local/bin/ktunnel
Test the commamd
ktunnel -h

🧐 About

Ktunnel is a CLI tool that establishes a reverse tunnel between a kubernetes cluster and your local machine. It lets you expose your machine as a service in the cluster or expose it to a specific deployment. You can also use the client and server without the orchestration part. Although ktunnel is identified with kubernetes, it can also be used as a reverse tunnel on any other remote system

Ktunnel was born out of the need to access my development host when running applications on kubernetes. The aim of this project is to be a holistic solution to this specific problem (accessing the local machine from a kubernetes pod). If you found this tool to be helpful on other scenarios, or have any suggesstions for new features - I would love to get in touch.

Ktunnel schema

Ktunnel schema

🎈 Usage

Expose your local machine as a service in the cluster

This will allow pods in the cluster to access your local web app (listening on port 8000) via http (i.e kubernetes applications can send requests to myapp:8000)

bash
ktunnel expose myapp 80:8000
ktunnel expose myapp 80:8000 -r #deployment & service will be reused if exists or they will be created

Inject to an existing deployment

This will currently only work for deployments with 1 replica - it will expose a listening port on the pod through a tunnel to your local machine

bash
ktunnel inject deployment mydeployment 3306

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.