00mjk / mirrord

Connect your local process and your cloud environment, and run local code in cloud conditions.

mirrord lets developers run local processes in the context of their cloud 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

• Contents
  • Getting Started
  • VS Code Extension
    • Installation
    • How To Use
  • IntelliJ Plugin
    • Installation
    • How To Use
  • CLI Tool
    • Installation
    • How To Use
  • How It Works
  • FAQ
  • Contributing
  • Development
  • Help and Community
  • Code of Conduct
  • License

---

Getting Started

• VS Code Extension
• IntelliJ Plugin
• CLI Tool

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

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 privileged 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.

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

License

MIT