erun-tools

ERun

Multi tenant, Multi-environment deployment and management tool.

ERun implements an opinionated way of how to maintain large scale enterprise projects.

The problem ERun is trying to solve is "how do you use helm, terraform and cloud provider specific CLI tools in multi environment (DEV,TEST,DR,PROD) situation".

The problem escalates to mundane silly everyday tasks and challenges, such as:

• How do I version my project
• How do I increase project version when I build a next version
• How do I deploy my Javascript Single Page Application to CDN
• How do I deploy, develop and maintain my Serverless javascript lambda
• How do I deploy this service only in DEV but not in PROD
• How do I do hot-fixes in PROD without deploying all the mess that is already in develop branch

ERun tries to help solving these issues without getting into the developers way. ERun is entirely optional, all the heavy lifting is done via terraform, helm and git. One can stop using ERun at any point and just navigate and build with these tools.

Install

ERun ships two executables:

• erun - CLI utility
• emcp - MCP server executable

Homebrew

Tap the repository and install erun from it:

brew tap sophium/erun https://github.com/sophium/erun
brew install sophium/erun/erun

Scoop

Add the repository as a Scoop bucket and install erun from it:

scoop bucket add sophium-erun https://github.com/sophium/erun
scoop install sophium-erun/erun

Linux

For Debian and Ubuntu, download and install a specific release from the project's GitHub Releases page:

VERSION="1.0.17" && ARCH="$(dpkg --print-architecture)" && curl -fLo "erun_${VERSION}_${ARCH}.deb" "https://github.com/sophium/erun/releases/download/v${VERSION}/erun_${VERSION}_${ARCH}.deb" && sudo apt install "./erun_${VERSION}_${ARCH}.deb"

Build From Source

If you prefer to build the binaries yourself:

(cd erun-cli && go build -o ../erun .)
(cd erun-mcp && go build -o ../emcp ./cmd/emcp)

How to install development environment

Install GO

brew install go

Install linter

brew install golangci-lint

Enable git hooks

The repository ships a pre-commit hook in .githooks/pre-commit that runs golangci-lint --fix before every commit. Enable it per-clone so that formatting and lint fixes are automatically applied on git commit:

git config core.hooksPath .githooks

Enable DEBUG on Mac (you may not need it if debug works for you)

sudo DevToolsSecurity --enable
xcode-select -p
sudo dseditgroup -o edit -t user -a "$USER" _developer

Contributing

Pull request

When submitting Pull Request try to adhere to best practices described in https://go.dev/doc/effective_go. When commenting use links to https://go.dev/wiki/CodeReviewComments subsection when code is in violation with these rules (most likely linter will not allow these).

Running locally

When developing ERun it is recommended to use aliases

alias erun='~/git/sophium/erun/erun-cli/run.sh'
alias emcp='~/git/sophium/erun/erun-mcp/run.sh'

This keeps local startup consistent for both executables:

erun version
emcp --host 127.0.0.1 --port 17000 --path /mcp

erun mcp launches the separate emcp binary, so local development should build emcp via erun-mcp/run.sh or otherwise make emcp available on PATH.

Design

ERun is a developer tool.

It assumes that bunch of core dependencies such as:

• git
• terraform
• helm
• docker
• your cloud provider tools (such as aws utility for Amazon Web Services)

are deployed.

ERun heavily relies on host machine being able to run basic shell (zsh,bash on Mac,Linux or Git bash on windows).

Once deployed ERun will create docker devops CLI shell, that will deploy all tools necessary for ERun to operate. ERun will launch docker container on per Environment basis, with an option to use mounted host file system, otherwise ERun will use image/container file system with files specific to the particular system release.

Configuration

ERun configuration is stored in $HOME/.erun folder and the CLI exposes a --config flag that points to this folder.

Running

To initialize ERun support for the project, just run erun in any project directory. ERun will try to locate .git directory, and then configuration/tenant for this directory in User Home configuration directory that might vary for different Host (Windows,Mac,Linux) architectures.