No description
Find a file
2017-05-08 10:37:24 +02:00
context fix test: Assert variable override order 2017-04-04 20:06:15 +02:00
docs docs: Document template format 2017-05-08 10:37:24 +02:00
example feat templater: Add 'pass' lookup function 2017-02-09 15:44:18 +01:00
templater feat templater: Warn if no valid resource sets are included 2017-05-04 18:45:03 +02:00
util style: Apply go fmt 2017-02-20 14:25:39 +01:00
.gitignore chore: Add .gitignore 2017-02-08 11:50:18 +01:00
.travis.yml feat build: Add Travis.CI support 2017-02-08 13:00:34 +01:00
LICENSE chore: Add LICENSE 2017-02-08 11:58:26 +01:00
main.go refactor main: Move to Kingpin CLI library 2017-05-04 18:49:43 +02:00
README.md docs README: Update usage examples for kingpin CLI 2017-05-04 18:49:43 +02:00

Kontemplate - A simple Kubernetes templater

Build Status

I made this tool out of frustration with the available ways to template Kubernetes resource files. All I want out of such a tool is a way to specify lots of resources with placeholders that get filled in with specific values, based on which context (i.e. k8s cluster) is specified.

Overview

Kontemplate lets you describe resources as you normally would in a simple folder structure:

.
├── prod-cluster.yaml
└── some-api
    ├── deployment.yaml
    └── service.yaml

This example has all resources belonging to some-api (no file naming conventions enforced at all!) in the some-api folder and the configuration for the cluster prod-cluster in the corresponding file.

Lets take a short look at prod-cluster.yaml:

---
context: k8s.prod.mydomain.com
global:
  globalVar: lizards
include:
  - name: some-api
    values:
      version: 1.0-0e6884d
      importantFeature: true
      apiPort: 4567

Those values are then templated into the resource files of some-api.

Installation

Assuming you have Go configured correctly, you can simply go get github.com/tazjin/kontemplate/....

Usage

You must have kubectl installed to use Kontemplate effectively.

usage: kontemplate [<flags>] <command> [<args> ...]

simple Kubernetes resource templating

Flags:
  -h, --help                 Show context-sensitive help (also try --help-long and --help-man).
  -i, --include=INCLUDE ...  Resource sets to include explicitly
  -e, --exclude=EXCLUDE ...  Resource sets to exclude explicitly

Commands:
  help [<command>...]
    Show help.

  template <file>
    Template resource sets and print them

  apply [<flags>] <file>
    Template resources and pass to 'kubectl apply'

  replace <file>
    Template resources and pass to 'kubectl replace'

  delete <file>
    Template resources and pass to 'kubectl delete'

  create <file>
    Template resources and pass to 'kubectl create'

Examples:

# Look at output for a specific resource set and check to see if it's correct ...
kontemplate template example/prod-cluster.yaml -i some-api

# ... maybe do a dry-run to see what kubectl would do:
kontemplate apply example/prod-cluster.yaml --dry-run

# And actually apply it if you like what you see:
kontemplate apply example/prod-cluster.yaml