Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/metalbear-co/mirrord

Connect your local process and your cloud environment, and run local code in cloud conditions.
https://github.com/metalbear-co/mirrord

api backend backend-development cli cloud cloud-native debug develop developer-tools development devops devtool ide kubernetes rust shift-left sniffer traffic vscode vscode-extension

Last synced: 2 days ago
JSON representation

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

Awesome Lists containing this project

README 

        



![mirrord logo](./images/logo.svg)






[![Discord](https://img.shields.io/discord/933706914808889356?color=5865F2&label=Discord&logo=discord&logoColor=white)](https://discord.gg/metalbear)

![License](https://img.shields.io/badge/license-MIT-green)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/metalbear-co/mirrord)

[![Twitter Follow](https://img.shields.io/twitter/follow/metalbearco?style=social)](https://twitter.com/metalbearco)



[mirrord lets developers run local processes in the context of their Kubernetes environment](https://mirrord.dev/).

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](https://mirrord.dev/docs/overview/introduction/).



# Contents



- [Contents](#contents)

  - [Getting Started](#getting-started)

  - [VS Code Extension](#vs-code-extension)

    - [Installation](#installation)

    - [How To Use](#how-to-use)

  - [IntelliJ Plugin](#intellij-plugin)

    - [Installation](#installation-1)

    - [How To Use](#how-to-use-1)

  - [CLI Tool](#cli-tool)

    - [Installation](#installation-2)

    - [How To Use](#how-to-use-2)

  - [How It Works](#how-it-works)

    - [Additional capabilities](#additional-capabilities)

  - [FAQ](#faq)

  - [Contributing](#contributing)

  - [Help and Community](#help-and-community)

  - [Code of Conduct](#code-of-conduct)

  - [License](#license)



---



## Getting Started



- [VS Code Extension](#vs-code-extension)

- [IntelliJ Plugin](#intellij-plugin)

- [CLI Tool](#cli-tool)



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



---



## VS Code Extension



### Installation



Get the extension [here](https://marketplace.visualstudio.com/items?itemName=MetalBear.mirrord).



### 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](https://plugins.jetbrains.com/plugin/19772-mirrord).



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



```sh

brew install metalbear-co/mirrord/mirrord

```



or



```sh

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



```sh

mirrord exec  --target 

```



e.g.



```sh

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](https://mirrord.dev/docs/overview/introduction/).



### Additional capabilities



Container run inside the pod launched by mirrord requires additional [Linux capabilities](https://man7.org/linux/man-pages/man7/capabilities.7.html):



- `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](https://mirrord.dev/docs/reference/configuration/).

This will possibly limit mirrord functionalities or even make it unusable in some setups.



```bash

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

```





  How It Works




## FAQ



Our FAQ is available [here](https://mirrord.dev/docs/faq/general/).

If you have a question that's not on there, feel free to ask in our [Discussions](https://github.com/metalbear-co/mirrord/discussions)

or on [Discord](https://discord.gg/metalbear).



## Contributing



Contributions are very welcome. Start by checking out our [open issues](https://github.com/metalbear-co/mirrord/issues), and by going through our [contributing guide](CONTRIBUTING.md).

We're available on [Discord](https://discord.gg/metalbear) for any questions.



## Help and Community



Join our [Discord Server](https://discord.gg/metalbear) 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](./CODE_OF_CONDUCT.md).



## License



[MIT](./LICENSE)