Service Exporter

? Kubernetes Service Port Forwarding with ngrok

A CLI tool that helps you expose Kubernetes services to the internet using ngrok tunnels with interactive configuration.

Table of Contents

• Demo
• Installation
• Quick Start
• Usage
• Prerequisites
• Development

Demo

Installation

Option 1: Download Prebuilt Binary (Recommended)

Download the latest release for your platform from GitHub Releases:

Manual Download

Linux (AMD64)

# Download and install
curl -L -o service-exporter https://github.com/Goalt/service-exporter/releases/latest/download/serviceexporter-linux-amd64
chmod +x service-exporter
sudo mv service-exporter /usr/local/bin/

Linux (ARM64)

# Download and install
curl -L -o service-exporter https://github.com/Goalt/service-exporter/releases/latest/download/serviceexporter-linux-arm64
chmod +x service-exporter
sudo mv service-exporter /usr/local/bin/

macOS (Intel)

# Download and install
curl -L -o service-exporter https://github.com/Goalt/service-exporter/releases/latest/download/serviceexporter-darwin-amd64
chmod +x service-exporter
sudo mv service-exporter /usr/local/bin/

macOS (Apple Silicon)

# Download and install
curl -L -o service-exporter https://github.com/Goalt/service-exporter/releases/latest/download/serviceexporter-darwin-arm64
chmod +x service-exporter
sudo mv service-exporter /usr/local/bin/

Windows

1. Download serviceexporter-windows-amd64.exe
2. Rename to service-exporter.exe
3. Add to your PATH or run from the download directory

Verify Installation

service-exporter
# Should start the interactive configuration prompt
# Press Ctrl+C to exit

Option 2: Build from Source

Requires Go 1.25+ and access to the source code:

git clone https://github.com/Goalt/service-exporter.git
cd service-exporter
make build

Or build directly:

go build -o service-exporter ./cmd

Quick Start

1. Install the binary using one of the methods above
2. Get your ngrok auth token from ngrok.com
3. Run the application:
4. Follow the interactive prompts to configure and expose your service

Features

• Interactive Configuration: Choose between environment variables or manual parameter input
• Service Discovery: Automatically lists available Kubernetes services
• Port Forwarding: Creates secure port forwarding to selected services
• ngrok Integration: Exposes local ports via ngrok tunnels for external access
• Graceful Shutdown: Properly cleans up resources on exit

Usage

Running the Application

When you start the application, you'll be presented with a configuration choice:

⚙️  Configuration Setup
=====================
? Configuration mode: 
  ▸ Use default values from environment variables
    Provide parameters manually

Configuration Options

Option 1: Use Default Values (Environment Variables)

Select this option to use environment variables for configuration:

• NGROK_AUTH_TOKEN (required): Your ngrok authentication token
• KUBECONFIG (optional): Path to your kubeconfig file (defaults to ~/.kube/config)

Example:

export NGROK_AUTH_TOKEN="your_ngrok_token_here"
export KUBECONFIG="/path/to/your/kubeconfig"
service-exporter

Option 2: Provide Parameters Manually

Select this option to be prompted for each parameter:

1. Ngrok Auth Token: Enter your ngrok authentication token (input will be masked for security)
2. Kubeconfig Path: Enter the path to your kubeconfig file (or press Enter for default)

Complete Workflow

1. Configuration: Choose your preferred configuration method
2. Service Selection: Select from a list of available Kubernetes services
3. Port Selection: Choose which port of the selected service to forward
4. Port Forwarding: The tool forwards the selected service port to a local port
5. ngrok Tunnel: Creates a public URL for external access
6. Access: Use the provided public URL to access your service

Example output: