Skip to content

Commit

Permalink
Add documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Danny Burke committed Oct 5, 2020
1 parent 541855d commit 26e4a72
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,41 @@
# Hetzner Kubeadm cluster

This Terraform module allows you to very easily spin up a Kubadm provisioned Kubernetes cluster on Hetzner Cloud. It creates one master node and one worker node.

### Why?

kubeadm lets you spin up Kubernetes cluster very easily with little effort, using these Terraform scripts and Hetzner cloud you can easily spin up a master and worker node in seconds with all of the required configuration.
Kubeadm is covered a lot in the Kubernetes Certified Adminstrator exam [CKA](https://www.cncf.io/certification/cka/) - spinning up this cluster gives you practice for that exam and Kubernetes in general.

Kubeadm is used a lot in many productions for provisioning Kubernetes clusters in the cloud, on-prem, bare metal etc.

[kubeadm](https://github.com/kubernetes/kubeadm)


### What do I need to do?

If you haven't already, setup an account at [Hetzner Sign Up](https://accounts.hetzner.com/account/masterdata)

You can call this module in your Terraform project like so:

```bash
module "hetzner_kubeadm" {
source = "git@github.com:dannyburke1/hetzner-kubeadm.git"
}
```

This module assumes that you have a public key in `~/.ssh/id_rsa.pub` and a Hetzner API token ready to be used.

Once you've updated the api key variable, you're ready to run `terraform apply` and spin up these nodes.

You can then SSH to the master with the `root` user and begin following the kubeadm cluster walkthrough.

### Costs

Kubeadm has resource requirements for it to run:
- 2GB Ram
- 2vCPU Cores for the master/control plane node.

This module has the correct instance sizes to run these instances with an estimated cost of:

8.38 euros p/month in Helsinki region for a master and control plane node.

0 comments on commit 26e4a72

Please sign in to comment.