kubeformation

Create declarative specifications for your managed Kubernetes cloud vendor (GKE, AKS).

Kubeformation Diagram

Motivation

With Kubernetes, it becomes possible to start making everything about your application declarative. As cloud vendors start providing managed Kubernetes services, provisioning a Kubernetes cluster via the vendor’s API becomes declarative as well.

Kubeformation is a simple web UI and CLI that helps you create “Google Deployment manager” or “Azure Resoure Manager” templates which are a little painful to create by hand.

Once you have this file, you can run your cloud vendor CLI on it to provision your cluster. You can edit this file to add vendor specific configuration too.

Usage

Write cluster spec. [docs]
Use the kubeformation CLI to generate template. [docs]
Follow provider specific instructions to create the cluster. [docs]

Example

Here's a spec that defines a Kubernetes cluster: cluster.yaml

version: v1
name: cluster-name
provider: gke
k8sVersion: "1.9"
nodePools:
- name: db-pool
  type: n1-standard-1
  size: 1
  labels:
    app: postgres
- name: backend-pool
  type: n1-standard-2
  size: 2
  labels:
    app: backend
volumes:
- name: postgres
  size: 10

kubeformation can read this file and generate Google Cloud Deployment Manager template, which can then be used with gcloud command to create the GKE cluster. This is a declarative template that can be used to further do create or modify the cluster.

$ kubeformation -f cluster.yaml -o templates

Then, use gcloud CLI to create the deployment. [docs]

$ gcloud deployment-manager deployments create my-cluster --config templates/gke-cluster.yaml

NOTE: kubeformation is exclusively meant for managed Kubernetes providers. The following providers are currently supported:

Google Kubernetes Engine (GKE)
Azure Container Service (AKS)

Installation

Download CLI for your platform from the releases page, add it to PATH and give execute permissions.

$ chmod +x kubeformation

Docs

Read complete docs here.

FAQ

Why cloud provider specific information, such as zone/region/location etc. does not appear in the cluster spec?
- The purpose of Kubeformation is to bootstrap a cloud provider specific template that you can later modify according to your needs.

Roadmap

Kubeformation is open to evolution. Current goal is to support all managed Kubernetes vendors that support declarative specification.

EKS support (#10)
Other providers (#11)

Contributing

Kubeformation is an open source project licensed under Apache 2.0. Checkout the contributing guide to get started.

Maintainers

Current maintainers: @shahidh_k, @arvishankar, @JaisonTitus.

hasura / kubeformation

readme