metalbear-co/mirrord Preview Environment

Start or stop a mirrord preview environment

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Apr 10, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: metalbear-co/mirrord-preview@441260afa3bea790b133038a70e00914629d3ba6 # 0.1.4

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
actionAction to perform: "start" or "stop"yes
targetKubernetes target path (e.g. deployment/my-app). Required for start.no
namespaceKubernetes namespace of the target. Optional, defaults to current context namespace.no
modeTraffic mode: "steal" or "mirror". Default: stealnosteal
filterHeader filter regex applied to incoming HTTP traffic (and future SQS/Kafka filters). May reference {key}.no
portsJSON array of HTTP filter ports, e.g. [80, 8080]no
ttl_minsSession time-to-live in minutes. Integer or "infinite".no
imageContainer image for the preview environment (e.g. myrepo/myapp:latest). Required for start.no
keyUnique preview session key. Optional for start (auto-generated if omitted), required for stop.no
cli_pathPath to mirrord cli, will be used instead of the latest version when specified. Note that this works by symlinking `/usr/local/bin/mirrord` to this path.no
extra_configJSON object merged into the generated mirrord.json. Allows setting any additional mirrord config options. Overrides generated fields if overlapping.no
namedescription
session-keyThe preview session key (extracted from mirrord CLI output)