devenv

README

Outreach Kubernetes Developer Environment

System Requirements | Lifecycle | Interacting with Services |

Getting Started

1. Download the latest release for your platform and install the devenv binary to /usr/local/bin/:

tar xvf devenv_**_**.tar.gz
mv devenv /usr/local/bin/

# Linux/WSL2 optional: allow your user to update the devenv
sudo chown $(id -u):$(id -g) $(command -v devenv)

1. (macOS only) Ensure the devenv binary is authorized to run.

xattr -c $(command -v devenv)

1. Follow the instructions for your platform in the detailed system requirements docs

Defining a Box

Creating the Developer Environment

To create a developer environment, run:

devenv provision

Next there's a manual step that you'll need to do. You'll need to add a KUBECONFIG environment variable, this can be done by adding the line below to your shellrc (generally ~/.zshrc or ~/.zsh_profile or ~/.bashrc):

# Add the dev-environment to our kube config
export KUBECONFIG="$HOME/.kube/config:$HOME/.outreach/kubeconfig.yaml"

You now have a developer environment provisioned!

Be careful: from now on, your dev tools look a lot like production tools. To help with this, when you want to run kubectl commands against your dev environment cluster it is recommended you use the built-in wrapper:

$ devenv kubectl <the rest of your kubectl command>