Simplify Kubernetes Port Forwarding with KFtray
Tags: kubernetes, devops, cloud, opensource
Published: 2024-01-06 19:28:20

## Introduction
As Kubernetes continues to dominate the container orchestration scene, developers and DevOps engineers need tools that streamline their workflows. [KFtray](https://github.com/hcavarsan/kftray) answers the call as an cross-platform tray application that brings ease and efficiency to managing multiple Kubernetes port forwarding configurations directly from your menu bar. Let’s explore how [KFtray](https://github.com/hcavarsan/kftray), a tray application built with Rust and React using the Tauri framework, simplifies Kubernetes port forwarding and adds new features compared to the traditional kubectl port-forward.


![gif demo](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/soq99qwzgrk4sc7wvpyf.gif)

## KFtray At A Glance
[KFtray’s](https://github.com/hcavarsan/kftray) main mission is to simplify the process of managing port forwarding within Kubernetes environments. Designed with simplicity and productivity in mind, the app enables users to start and stop multiple port forwarding configurations through a sleek, user-friendly interface. The app stands out for its resilience, one-click operations, and kubectl independence, as it directly connects with the Kubernetes API.

## Getting Started with KFtray
Setting up KFtray is straightforward. Here’s a quick start guide to get you up and running:

1.  **Configuring Port Forwards:**  
    The intuitive UI allows you to easily add and manage port forward settings with fields for workload type (Proxy or Service), unique alias, Kubernetes context, namespace, service, remote address (for Proxy), protocol (TCP/UDP), and local/remote ports.

![create new configuration](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/219kcrvq32g6pyax9m1o.png)

1.  **Activating Configurations:**  
    You can start a single port forward configuration with a simple click or launch multiple configurations simultaneously, making it a breeze to handle complex setups.

![multiple configurations](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/zj58q4p2ny6nhb05it73.png)

1.  **Managing Configurations:**  
    KFtray provides options to export/import configurations as JSON files, ensuring that you can share or backup your configurations effortlessly. It also securely saves configurations locally in “$HOME/.kftray/configs.db”. This is an example of the JSON format expected by KFTray:

```json
[  
  {  
    "alias": "consul-ui",  
    "context": "kind-7",  
    "local_port": 8500,  
    "namespace": "consul",  
    "protocol": "tcp",  
    "remote_port": 8500,  
    "service": "consul-ui",  
    "workload_type": "service"  
  },  
  {  
    "alias": "redis-gcp",  
    "context": "kind-6",  
    "local_port": 26379,  
    "namespace": "default",  
    "protocol": "udp",  
    "remote_address": "redis-prod.gcp.internal",  
    "remote_port": 6379,  
    "workload_type": "proxy"  
  }  
]
```

**Features that Set KFtray Apart:**
*   **Resilient Port Forwarding Connection:** KFtray ensures your services remain accessible by automatically reconnecting to alternate running pods, should one fail.
*   **One-Click Multiple Port Forwards:** Rapidly set up multiple port forwarding instances with a single click — an indispensable feature for multitasking professionals.
*   **Independent of Kubectl:** KFtray’s direct interface with the Kubernetes API removes the dependency on kubectl, providing a smoother experience and catering to those who prefer graphical interfaces over the command line.
*   **Multi-Protocol Support**: Expanding beyond just TCP, KFtray’s support for multiple protocols including UDP, allows access to a variety of services, both internal and external to your Kubernetes clusters.

## Final Thoughts

KFtray aims to improve the port forwarding experience by providing a simple, efficient, and reliable solution. Whether you’re debugging services or accessing internal resources, KFtray offers the flexibility and reliability required in fast-paced development environments.

If you think KFtray is as useful as we do, consider giving us a star on GitHub at https://github.com/hcavarsan/kftray.

Should you encounter any issues or have questions regarding KFtray, please create an issue on our repository or reach out to us. We’re committed to continually improving KFtray based on your feedback.