Setup System for Kubernetes Deployment

Setup System for Kubernetes Deployment#

Install Required Programs#

sshkube: a cli our team maintains for simplifying kubernetes access
kube-compose: a cli our team maintains for simplifying kubernetes deployment
python/pipx: required to install/run our cli
docker: build and run containers locally
docker-compose: manage multiple containers operating together
kubectl: a CLI for kubernetes
helm: a package manager for kubernetes

Mac OS X#

It’s recommended that you install homebrew on your mac to make installation easier and more consistent.

After instlaling homebrew, in a terminal, run the following commands:

brew update
brew install git pipx kubernetes-cli helm
brew install --cask docker-desktop

pipx ensurepath
pipx install sshkube kube-compose

Linux#

In a terminal, run the following commands:

sudo apt-get update -y
sudo apt-get install -y git docker docker-compose pipx kubectl
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash

pipx ensurepath
pipx install sshkube kube-compose

Windows#

WSL is recommended with the linux instructions, but we do try to support native windows, let us know if you experience issues.

It’s recommended that you install scoop on your windows machine to make installation easier and more consistent.

Afer installing scoop, in a terminal, run the following commands:

scoop install git docker docker-compose python pipx kubectl helm

pipx ensurepath
# reload your terminal
pipx install sshkube kube-compose

# in an administrator terminal run
dockerd --register-service

Create a Github Account#

You will need a github account both to manage source code and to register a ssh public key.