1.0.4 • Published 3 years ago

mirrord v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

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

Getting Started


VSCode Extension

Installation

Get the extension here.

How to use

  • Start debugging your project
  • Click "Start mirrord" on the status bar
  • Choose pod to mirror traffic from
  • To stop mirroring, click "Stop mirrord" (or stop debugging)

Currently the extension only captures port 80, but that will be configurable soon. The extension automatically detects which port your debugged process listens on and directs the mirrored traffic to it. If you prefer to direct traffic to a different local port, edit launch.json:

{ "mirrord": { "port": "<port to send traffic to>" } }


CLI Tool

Installation

npm install -g mirrord

How to use

mirrord <pod name>

For more options, run:

mirrord --help


How it works

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

For more technical information, see TECHNICAL.md

Caveats

  • mirrord currently supports Kubernetes clusters using containerd runtime only. Support for more runtimes will be added if there's demand.

Contributing

Contributions are welcome via PRs.

Help & Community 🎉✉️

Join our Discord Server for questions, support and fun.

Icon Credit: flaticon.com

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago