Home

Awesome

Typhoon

Release Stars Sponsors Mastodon

<img align="right" src="https://storage.googleapis.com/poseidon/typhoon-logo.png">

Typhoon is a minimal and free Kubernetes distribution.

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

Features <a href="https://www.cncf.io/certification/software-conformance/"><img align="right" src="https://storage.googleapis.com/poseidon/certified-kubernetes.png"></a>

Modules

Typhoon provides a Terraform Module for defining a Kubernetes cluster on each supported operating system and platform.

Typhoon is available for Fedora CoreOS.

PlatformOperating SystemTerraform ModuleStatus
AWSFedora CoreOSaws/fedora-coreos/kubernetesstable
AzureFedora CoreOSazure/fedora-coreos/kubernetesalpha
Bare-MetalFedora CoreOSbare-metal/fedora-coreos/kubernetesstable
DigitalOceanFedora CoreOSdigital-ocean/fedora-coreos/kubernetesbeta
Google CloudFedora CoreOSgoogle-cloud/fedora-coreos/kubernetesstable
PlatformOperating SystemTerraform ModuleStatus
AWSFedora CoreOS (ARM64)aws/fedora-coreos/kubernetesalpha

Typhoon is available for Flatcar Linux.

PlatformOperating SystemTerraform ModuleStatus
AWSFlatcar Linuxaws/flatcar-linux/kubernetesstable
AzureFlatcar Linuxazure/flatcar-linux/kubernetesalpha
Bare-MetalFlatcar Linuxbare-metal/flatcar-linux/kubernetesstable
DigitalOceanFlatcar Linuxdigital-ocean/flatcar-linux/kubernetesbeta
Google CloudFlatcar Linuxgoogle-cloud/flatcar-linux/kubernetesstable
PlatformOperating SystemTerraform ModuleStatus
AWSFlatcar Linux (ARM64)aws/flatcar-linux/kubernetesalpha
AzureFlatcar Linux (ARM64)azure/flatcar-linux/kubernetesalpha

Typhoon also provides Terraform Modules for optionally managing individual components applied onto clusters.

NameTerraform ModuleStatus
CoreDNSaddons/corednsbeta
Ciliumaddons/ciliumbeta
flanneladdons/flannelbeta

Documentation

Usage

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

module "yavin" {
  source = "git::https://github.com/poseidon/typhoon//google-cloud/fedora-coreos/kubernetes?ref=v1.32.0"

  # Google Cloud
  cluster_name  = "yavin"
  region        = "us-central1"
  dns_zone      = "example.com"
  dns_zone_name = "example-zone"

  # configuration
  ssh_authorized_key = "ssh-ed25519 AAAAB3Nz..."

  # optional
  worker_count = 2
  worker_preemptible = true
}

# Obtain cluster kubeconfig
resource "local_file" "kubeconfig-yavin" {
  content         = module.yavin.kubeconfig-admin
  filename        = "/home/user/.kube/configs/yavin-config"
  file_permission = "0600"
}

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

$ terraform init
$ terraform plan
Plan: 62 to add, 0 to change, 0 to destroy.
$ terraform apply
Apply complete! Resources: 62 added, 0 changed, 0 destroyed.

In 4-8 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.

$ export KUBECONFIG=/home/user/.kube/configs/yavin-config
$ kubectl get nodes
NAME                                       ROLES    STATUS  AGE  VERSION
yavin-controller-0.c.example-com.internal  <none>   Ready   6m   v1.32.0
yavin-worker-jrbf.c.example-com.internal   <none>   Ready   5m   v1.32.0
yavin-worker-mzdm.c.example-com.internal   <none>   Ready   5m   v1.32.0

List the pods.

$ kubectl get pods --all-namespaces
NAMESPACE     NAME                                      READY  STATUS    RESTARTS  AGE
kube-system   cilium-1cs8z                              1/1    Running   0         6m
kube-system   cilium-d1l5b                              1/1    Running   0         6m
kube-system   cilium-sp9ps                              1/1    Running   0         6m
kube-system   cilium-operator-68d778b448-g744f          1/1    Running   0         6m
kube-system   coredns-1187388186-zj5dl                  1/1    Running   0         6m
kube-system   coredns-1187388186-dkh3o                  1/1    Running   0         6m
kube-system   kube-apiserver-controller-0               1/1    Running   0         6m
kube-system   kube-controller-manager-controller-0      1/1    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-controller-0               1/1    Running   0         6m

Non-Goals

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

Help

Schedule a meeting via Github Sponsors to discuss your use case.

Motivation

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 Kubernetes distributions is healthy.

Social Contract

Typhoon is not a product, trial, or free-tier. Typhoon does not offer support, services, or charge money. And Typhoon is independent of operating system or platform vendors.

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

Sponsors

Poseidon's Github Sponsors support the infrastructure and operational costs of providing Typhoon.

<a href="https://www.digitalocean.com/"> <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px"> </a> <br> <br> <a href="https://deploy.equinix.com/"> <img src="https://storage.googleapis.com/poseidon/equinix.png" width="201px"> </a> <br> <br>

If you'd like your company here, please contact dghubble at psdn.io.