README
¶
ktunnel
Expose your local resources to kubernetes
📝 Table of Contents
🧐 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.
🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Installation
Homebrew
brew tap omrikiei/ktunnel
brew install ktunnel
From the releases page
Download here and extract it to a local bin path
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
🎈 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)
ktunnel expose myapp 80:8000
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
ktunnel inject deployment mydeployment 3306
✍️ Authors
See also the list of contributors who participated in this project.
Documentation
¶
There is no documentation for this package.
Source Files
Directories