Kubestack

The Open Source Terraform framework for Kubernetes Platform Engineering

Join Our Contributors!

Introduction

Kubestack is a Terraform framework for Kubernetes Platform Engineering teams to define the entire cloud native stack in one Terraform code base and continuously evolve the platform safely through GitOps.

Highlights

• Convention over configuration platform engineering framework that makes the power of platforms accessible to your whole engineering team
• Platform architecture and GitOps workflow enabling all team members to safely iterate while protecting your application environments
• Extendable, future-proof, low-maintenance Terraform code base and robust automation even for complex Kubernetes platforms

Getting Started

For the easiest way to get started, follow the Kubestack tutorial. The tutorial will help you get started with the Kubestack framework and build a Kubernetes platform application teams love.

Getting Help

Official Documentation
Refer to the official documentation for a deeper dive into how to use and configure Kubestack.

Community Help
If you have any questions while following the tutorial, join the #kubestack channel on the Kubernetes community. To create an account request an invitation.

Contributing

This repository holds Terraform modules in directories matching the respective provider name, e.g. aws, azurerm, google. Additionally common holds the modules that are used for all providers. Most notably the metadata module that ensures a consistent naming scheme and the cluster_services module which integrates Kustomize into the Terraform apply.

Each cloud provider specific module directory always has a cluster and _modules directories. The cluster module is user facing and once Kubestack is out of beta the goal is to not change the module interface unless the major version changes. The cluster module then internally uses the module in _modules that holds the actual implementation.

The quickstart directory is home to the source for the zip files that are used to bootstrap the user repositories when following the tutorial.

The tests directory holds a set of happy path tests.

Contributions to the Kubestack framework are welcome and encouraged. Before contributing, please read the Contributing and Code of Conduct Guidelines.

One super simple way to contribute to the success of this project is to give it a star.

Kubestack Repositories

• kbst/terraform-kubestack (this repository)
  • Terraform framework for Kubernetes Platform Engineering teams - Define your entire cloud native Kubernetes stack in one Terraform code base and continuously evolve the platform safely through GitOps.
• kbst/kbst
  • Kubestack CLI kbst - The CLI helps you scaffold the Terraform code that defines the clusters, node pools or services of your platform. The CLI works on local files only, you can see any change it makes with git status.
• kbst/terraform-provider-kustomization
  • Kustomize Terraform Provider - A Kubestack maintained Terraform provider for Kustomize, available in the Terraform registry.
• kbst/catalog
  • Catalog of Terraform modules for Kubernetes platforms - The Kubestack Terraform modules make it easy for platform engineering teams to deliver common platform features in production ready configurations.