Minimal and free Kubernetes distribution with Terraform
Go to file
Dalton Hubble ec46bc13ae Add support for Calico networking on GCE
* Calico on GCE with IP-in-IP encapsulation and MTU 1440
* Calico on DO with IP-in-IP encapsulation and MTU 1440
* Digital Ocean firewalls don't support IPIP protocol yet
2017-09-05 18:22:14 -07:00
.github Fix typo in the issue template 2017-09-04 20:56:01 -07:00
addons addons: Disable Google Analytics in CLUO 2017-08-27 21:06:49 -07:00
bare-metal/container-linux bare-metal: Add support for Calico networking 2017-09-01 17:52:22 -07:00
digital-ocean/container-linux/kubernetes Add support for Calico networking on GCE 2017-09-05 18:22:14 -07:00
docs docs: Fix broken addons overview.md link 2017-08-27 21:11:24 -07:00
google-cloud/container-linux Add support for Calico networking on GCE 2017-09-05 18:22:14 -07:00
CONTRIBUTING.md Add CONTRIBUTING.md and DCO agreement 2017-08-13 12:27:17 -07:00
DCO Add CONTRIBUTING.md and DCO agreement 2017-08-13 12:27:17 -07:00
LICENSE Rename project and organization 2017-08-14 19:24:04 -07:00
README.md README.md: fix addons link 2017-08-29 10:49:01 -07:00
mkdocs.yml Add concepts, tutorials, and faq docs 2017-08-27 15:21:57 -07:00
requirements.txt Add concepts, tutorials, and faq docs 2017-08-27 15:21:57 -07:00

README.md

Typhoon

Typhoon is a minimal and free Kubernetes distribution.

  • Minimal, stable base Kubernetes distribution
  • Declarative infrastructure and configuration
  • Free (freedom and cost) and privacy-respecting
  • Practical for labs, datacenters, and clouds

Typhoon distributes upstream Kubernetes, architectural conventions, and cluster addons, much like a GNU/Linux distribution provides the Linux kernel and userspace components.

Features

  • Kubernetes v1.7.3 (upstream, via kubernetes-incubator/bootkube)
  • Self-hosted control plane, single or multi master, workloads isolated to workers
  • On-cluster etcd with TLS, RBAC-enabled
  • Ready for Ingress, Metrics, Dashboards, and other optional addons

Modules

Typhoon provides a Terraform Module for each supported operating system and platform.

Platform Operating System Terraform Module
Bare-Metal Container Linux bare-metal/container-linux/kubernetes
Digital Ocean Container Linux digital-ocean/container-linux/kubernetes
Google Cloud Container Linux google-cloud/container-linux/kubernetes

Usage

Example

Define a Kubernetes cluster by using the Terraform module for your chosen platform and operating system. Here's a minimal example:

module "google-cloud-yavin" {
  source = "git::https://github.com/poseidon/typhoon//google-cloud/container-linux/kubernetes"

  # Google Cloud
  zone          = "us-central1-c"
  dns_zone      = "example.com"
  dns_zone_name = "example-zone"
  os_image      = "coreos-stable-1465-6-0-v20170817"

  cluster_name       = "yavin"
  controller_count   = 1
  worker_count       = 2
  ssh_authorized_key = "ssh-rsa AAAAB3Nz..."

  # output assets dir
  asset_dir = "/home/user/.secrets/clusters/yavin"
}

Fetch modules, plan the changes to be made, and apply the changes.

$ terraform get --update
$ terraform plan
Plan: 37 to add, 0 to change, 0 to destroy.
$ terraform apply
Apply complete! Resources: 37 added, 0 changed, 0 destroyed.

In 5-10 minutes (varies by platform), the cluster will be ready. This Google Cloud example creates a yavin.example.com DNS record to resolve to a network load balancer across controller nodes.

$ KUBECONFIG=/home/user/.secrets/clusters/yavin/auth/kubeconfig
$ kubectl get nodes
NAME                                          STATUS   AGE    VERSION
yavin-controller-1682.c.example-com.internal  Ready    6m     v1.7.3+coreos.0
yavin-worker-jrbf.c.example-com.internal      Ready    5m     v1.7.3+coreos.0
yavin-worker-mzdm.c.example-com.internal      Ready    5m     v1.7.3+coreos.0

List the pods.

$ kubectl get pods --all-namespaces
NAMESPACE     NAME                                      READY  STATUS    RESTARTS  AGE
kube-system   etcd-operator-3329263108-f443m            1/1    Running   1         6m
kube-system   kube-apiserver-zppls                      1/1    Running   0         6m
kube-system   kube-controller-manager-3271970485-gh9kt  1/1    Running   0         6m
kube-system   kube-controller-manager-3271970485-h90v8  1/1    Running   1         6m
kube-system   kube-dns-1187388186-zj5dl                 3/3    Running   0         6m
kube-system   kube-etcd-0000                            1/1    Running   0         5m
kube-system   kube-etcd-network-checkpointer-crznb      1/1    Running   0         6m
kube-system   kube-flannel-1cs8z                        2/2    Running   0         6m
kube-system   kube-flannel-d1l5b                        2/2    Running   0         6m
kube-system   kube-flannel-sp9ps                        2/2    Running   0         6m
kube-system   kube-proxy-117v6                          1/1    Running   0         6m
kube-system   kube-proxy-9886n                          1/1    Running   0         6m
kube-system   kube-proxy-njn47                          1/1    Running   0         6m
kube-system   kube-scheduler-3895335239-5x87r           1/1    Running   0         6m
kube-system   kube-scheduler-3895335239-bzrrt           1/1    Running   1         6m
kube-system   pod-checkpointer-l6lrt                    1/1    Running   0         6m

Non-Goals

Typhoon is strict about minimalism, maturity, and scope. These are not in scope:

  • In-place Kubernetes Upgrades
  • Adding every possible option
  • Openstack or Mesos platforms

Background

Typhoon powers the author's cloud and colocation clusters. The project has evolved through operational experience and Kubernetes changes. Typhoon is shared under a free license to allow others to use the work freely and contribute to its upkeep.

Typhoon addresses real world needs, which you may share. It is honest about limitations or areas that aren't mature yet. It avoids buzzword bingo and hype. It does not aim to be the one-solution-fits-all distro. An ecosystem of free (or enterprise) Kubernetes distros is healthy.

Social Contract

Typhoon is not a product, trial, or free-tier. It is not run by a company, does not offer support or services, and does not accept or make any money. It is not associated with any operating system or platform vendor.

Typhoon clusters will contain only free components. Cluster components will not collect data on users without their permission.

Disclosure: The author works for CoreOS and previously wrote Matchbox and original Tectonic for bare-metal and AWS. This project is not associated with CoreOS.