A CLI tool for provisioning kubernetes clusters on Hetzner Cloud
Clone or download
xetys Merge pull request #220 from mavimo/feature/189-use-xdg-config-home-a…
…s-config-base-dir

refs #189: set config dir based on XDG Base Directory Specification
Latest commit 908dcf6 Nov 13, 2018

README.md

Build Status Go Report Card Maintainability Gitter chat

hetzner-kube: fast and easy setup of kubernetes clusters on Hetzner Cloud

This project contains a CLI tool to easily provision kubernetes clusters on Hetzner Cloud.

This is my very first tool written in Go.

How to install

Binary releases

Get the binary from releases page

From source

hetzner-kube is written in Go. To install Go please follow the instructions on its homepage.

To get and build hetzner-kube from source run this command:

$ go get -u github.com/xetys/hetzner-kube

The project source will now be in your $GOPATH directory ($GOPATH/src/github.com/xetys/hetzner-kube) and the binary will be in $GOPATH/bin.

If you want to build it yourself later, you can change into the source directory and run go build or go install.

Code completion

To load completion for bash env run

. <(hetzner-kube completion)

To configure your bash shell to load completions for each session add to your .bashrc file:

# ~/.bashrc or ~/.profile
. <(hetzner-kube completion)

Or you can add it to your bash_completition.d folder:

# On linux
hetzner-kube completion > /etc/bash_completion.d/hetzner-kube
# On OSX with completion installed via brew (`brew intall bash-completion`)
hetzner-kube completion > /usr/local/etc/bash_completion.d/hetzner-kube

Usage

In your Hetzner Console generate an API token and

$ hetzner-kube context add my-project
Token: <PASTE-TOKEN-HERE>

Then you need to add an SSH key:

$ hetzner-kube ssh-key add -n my-key

This assumes, you already have a SSH keypair ~/.ssh/id_rsa and ~/.ssh/id_rsa.pub

And finally, you can create a cluster by running:

$ hetzner-kube cluster create --name my-cluster --ssh-key my-key

This will provision a brand new kubernetes cluster in latest version!

For a full list of options that can be passed to the cluster create command, see the Cluster Create Guide for more information.

HA-clusters

You can build high available clusters with hetzner-kube. Read the High availability Guide for further information.

Custom Options

addons

You can install some addons to your cluster using the cluster addon sub-command. Get a list of addons using:

$ hetzner-kube cluster addon list

contributing new addons

You want to add some cool stuff to hetzner-kube? It's quite easy! Learn how to add new addons in the Developing Addons documentation.

cloud-init

If you like to run some scripts or install some additional packages while provisioning new servers, you can use cloud-init

$ hetzner-kube cluster create --name my-cluster --nodes 3 --ssh-key my-key --cloud-init <PATH-TO-FILE>

An example file to make all nodes ansible ready. The comment on the first line is important:

#cloud-config
package_update: true
packages:
 - python

Full tutorial

This article guides through a full cluster setup.