GOKP Documentation

This is the documentation page for gokp

GOKP aims to be a GitOps native Kubernetes Platform. You can read more at the above link. This repo is intended to be the source of documentation for the PoC. The documentation (like the PoC) is "best effort" and is also in a "Proof of Concept" state. Please feel free to submit a PR if you find something is missing.

• Quickstart AWS
• Quickstart Azure
• Quickstart Docker

Getting The Binary

I've hand tested this on Ubuntu 21.04, Fedora 34, and Mac OS Big Sur (11.6) all on X86_64. However, since this is a PoC, YMMV.

Build From Source

If you want to build from source (built on go1.17.1)...

go install github.com/christianh814/gokp

If you don't have your GOBIN in your PATH, you need to set that

export PATH=$GOBIN:$PATH

Download

If you don't want to build you can download binary

Linux

sudo wget -O /usr/local/bin/gokp https://github.com/christianh814/gokp/releases/download/v0.0.8/gokp-amd64-linux

Mac OS x86_64

sudo wget -O /usr/local/bin/gokp https://github.com/christianh814/gokp/releases/download/v0.0.8/gokp-amd64-darwin

Make sure to make it executable

sudo chmod +x /usr/local/bin/gokp

Bash Completion

Now that you have the gokp cli, you can get bash completion.

source <(gokp completion bash)

NOTE: On Mac OS, you probably want to do gokp completion zsh

Questions?

Any questions, I can be found on the Kubernetes Slack, I am the user @christianh814.