k8s-insider

A zero-config way to access you kubernetes cluster network

Overview

Originally a workaround that got out of hand, k8s-insider is a one-stop-shop for accessing your development kubernetes cluster networked resources.

The app works by deploying an operator to the cluster and applying CRDs with network and tunnel definitions, which are then reconciled by the operator pods. After networks and tunnels are applied to the cluster and reconciled, the CLI app reads their state and generates and/or applies WireGuard configurations on the user's machine.

Network and Tunnel CRDs are namespaced and can be RBACed easily. The traffic is routed through separate router pods and can be shaped with network policies.

Features

• Multiple networks per cluster
• Dynamic IP assignment
• Automatic detection of service and pod CIDRs for:
  • Flannel (installed with Helm/CLI)
  • Cilium (installed with Helm/CLI)
• DNS resolution for pods and services

Planned features

• NAT-free routing
• IPv6 support

Requirements

• GNU/Linux:
  • kubectl with configured contexts
  • wireguard-tools for creating local tunnels
  • systemd-resolved for DNS patch functionality
• Windows:
  • kubectl with configured contexts
  • WireGuard for Windows for creating local tunnels

Installation

cargo (GNU/Linux and Windows)

bash cargo install --locked k8s-insider

Quickstart

bash k8s-insider install k8s-insider create network k8s-insider connect

Current limitations

Some autodetection functionality might not work properly on single-binary kubernetes distributions (k3s, k0s, etc.). Please feel free to create an issue or submit a PR for these.

License notice

Copyright (C) 2023 Marcin Jędrasik

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.