No description
Find a file
2017-10-27 02:55:41 +02:00
context fix templater: Don't template default.yml files 2017-08-31 18:41:57 +02:00
docs docs: Add tables of content to all documentation files 2017-08-04 23:11:27 +02:00
example feat templater: Add 'pass' lookup function 2017-02-09 15:44:18 +01:00
image chore image: Bump Docker image to build v1.2.0 2017-08-22 20:02:10 +02:00
templater feat templater: Add IP lookup function 2017-10-20 09:43:02 +02:00
util fix templater: Don't template default.yml files 2017-08-31 18:41:57 +02:00
.gitignore feat release: Add simple release script 2017-05-08 11:15:20 +02:00
.travis.yml feat build: Test if 'go fmt' has been applied 2017-07-03 14:27:48 +02:00
build-release.sh Version 1.2.0 2017-08-22 19:18:14 +02:00
CODE_OF_CONDUCT.md docs: Add official code of conduct 2017-06-22 15:12:51 +02:00
diff-deps.fish feat: Add shell script to check if dependencies are up-to-date 2017-06-11 23:16:22 +02:00
kontemplate.frm Version 1.2.0 2017-08-22 19:18:14 +02:00
kontemplate.rb chore brew: Update Homebrew formula to v1.2.0 2017-08-22 20:02:10 +02:00
LICENSE chore: Add LICENSE 2017-02-08 11:58:26 +01:00
main.go fix main: Do not stop templater if a single resource set is empty 2017-10-27 02:55:41 +02:00
PKGBUILD feat build: Add ArchLinux PKGBUILD 2017-05-08 13:47:53 +02:00
README.md docs: Complete cycle by linking back to kontemplate.works 2017-08-04 23:11:27 +02:00

Kontemplate - A simple Kubernetes templater

Build Status

Kontemplate is a simple CLI tool that can take sets of Kubernetes resource files with placeholders and insert values per environment.

This tool was made because in many cases all I want in terms of Kubernetes configuration is simple value interpolation per environment (i.e. Kubernetes cluster), but with the same deployment files.

In my experience this is often enough and more complex solutions such as Helm are not required.

Check out a Kontemplate setup example and the feature list below!

Table of Contents

Features

Example

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. That's it!

You can also set up more complicated folder structures for organisation, for example:

.
├── api
│   ├── image-api
│   │   └── deployment.yaml
│   └── music-api
│       └── deployment.yaml
│   │   └── default.json
├── frontend
│   ├── main-app
│   │   ├── deployment.yaml
│   │   └── service.yaml
│   └── user-page
│       ├── deployment.yaml
│       └── service.yaml
├── prod-cluster.yaml
└── test-cluster.yaml

And selectively template or apply resources with a command such as kontemplate apply test-cluster.yaml --include api --include frontend/user-page to only update the api resource sets and the frontend/user-page resource set.

Installation

It is recommended to install Kontemplate from the signed binary releases available on the releases page. Release binaries are available for Linux, OS X, FreeBSD and Windows.

Homebrew

OS X users with Homebrew installed can "tap" Kontemplate like such:

brew tap tazjin/kontemplate https://github.com/tazjin/kontemplate
brew install kontemplate

Arch Linux

An AUR package is available for Arch Linux and other pacman-based distributions.

Building repeatably from source

Version pinning for Go dependencies is provided by a Repeatr formula. After cloning the repository the latest release can be built with repeatr run kontemplate.frm.

This will place release binaries in the release folder.

Building from source

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

Check out the feature list and the individual feature documentation above and read the best practices. Then you should be good to go!

Contributing

Feel free to contribute pull requests, file bugs and open issues with feature suggestions!

Please follow the code of conduct.