mirrord

</div>

GitHub release (latest SemVer)

mirrord lets developers run local processes in the context of their Kubernetes environment. It’s meant to provide the benefits of running your service on a cloud environment (e.g. staging) without actually going through the hassle of deploying it there, and without disrupting the environment by deploying untested code. It comes as a Visual Studio Code extension, an IntelliJ plugin and a CLI tool. You can read more about it here.

Contents

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

VS Code Extension

Installation

Get the extension here.

How To Use

Click "Enable mirrord" on the status bar
Start debugging your project
Choose pod to impersonate
The debugged process will be plugged into the selected pod by mirrord

IntelliJ Plugin

Installation

Get the plugin here.

How To Use

Click the mirrord icon in the Navigation Toolbar
Start debugging your project
Choose a namespace and pod to impersonate
The debugged process will be plugged into the selected pod by mirrord

CLI Tool

Installation

You can use either

brew install metalbear-co/mirrord/mirrord

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> --target <target-path>

e.g.

mirrord exec node app.js --target pod/my-pod

How It Works

When you select a pod to impersonate, mirrord launches a pod on the same node as the pod you selected. The new pod is then used to connect your local process and the impersonated pod: it mirrors incoming traffic from the pod to your process, routes outgoing traffic from your process through the pod, and does the same for file reads, file writes, and environment variables. You can read more about it here.

Additional capabilities

Container run inside the pod launched by mirrord requires additional Linux capabilities:

CAP_NET_ADMIN and CAP_NET_RAW - for modifying routing tables
CAP_SYS_PTRACE - for reading target pod environment
CAP_SYS_ADMIN - for joining target pod network namespace

However, you can disable any subset of those in the configuration. This will possibly limit mirrord functionalities or even make it unusable in some setups.

MIRRORD_AGENT_DISABLED_CAPABILITIES=CAP_NET_RAW,CAP_SYS_PTRACE mirrord exec node app.js --target pod/my-pod

FAQ

Our FAQ is available here. If you have a question that's not on there, feel free to ask in our Discussions or on Discord.

Contributing

Contributions are very welcome. Start by checking out our open issues, and by going through our contributing guide. We're available on Discord for any questions.

Help and 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.