mirrord

mirrord copied to clipboard

mirrord lets you easily mirror traffic from your Kubernetes cluster to your development environment. It comes as both a Visual Studio Code extension and a CLI tool.

Getting Started

• VSCode Extension
• CLI Tool

mirrord uses your machine's default kubeconfig for access to the Kubernetes API.

Make sure your local process is listening on the same port as the remote pod.

VSCode Extension

Installation

Get the extension here.

How To Use

• Click "Enable mirrord" on the status bar
• Start debugging your project
• Choose pod to mirror traffic from
• The debugged process will start with mirrord, and receive traffic

CLI Tool

Installation

curl -fsSL https://raw.githubusercontent.com/metalbear-co/mirrord/main/scripts/install.sh | bash

• Windows isn't currently supported (you can use WSL)

How To Use

mirrord exec <process command> --pod-name <name of the pod to impersonate>

e.g.

mirrord exec node app.js --pod-name my-pod

How It Works

mirrord works by letting you select a pod to mirror traffic from. It launches a privileged pod on the same node which enters the namespace of the selected pod and captures traffic from it.

Contributing

Contributions are much welcome. Start by checking out issues. If you wish to work an issue, please comment so you can be assigned.

Development

Read our development guide here.

Help & Community 🎉✉️

Join our Discord Server for questions, support and fun.

Code of Conduct

We take our community seriously and we are dedicated to providing a safe and welcoming environment for everyone. Please take a few minutes to review our Code of Conduct.

License

MIT