Skip to content

Kapitan Overview

Setup your installation

Using our reference repositories you can easily get started with Kapitan

Examples repository

kapicorp/kapitan-reference repository is meant show you many working examples of things you can do with Kapitan. You can use this to get familiar with Kapitan

$ git clone git@github.com:kapicorp/kapitan-reference.git kapitan-templates
$ cd kapitan-templates

$ ./kapitan compile
Compiled postgres-proxy (1.51s)
Compiled tesoro (1.70s)
Compiled echo-server (1.64s)
Compiled mysql (1.67s)
Compiled gke-pvm-killer (1.17s)
Compiled prod-sockshop (4.74s)
Compiled dev-sockshop (4.74s)
Compiled tutorial (1.68s)
Compiled global (0.76s)
Compiled examples (2.60s)
Compiled pritunl (2.03s)
Compiled sock-shop (4.36s)

Minimal repository

Using cruft based cookiecutter

pip3 install cruft

cruft create http://github.com/kapicorp/kapitan-reference --checkout cookiecutter --no-input
Dependency https://github.com/kapicorp/generators.git: saved to system/lib
Dependency https://github.com/kapicorp/generators.git: saved to system/generators/kubernetes
Dependency https://github.com/kapicorp/generators.git: saved to system/generators/terraform
Rendered inventory (1.74s)
Compiled echo-server (0.14s)

running Kapitan

recommended

kapitan wrapper script

If you use the provided repository, we already package a kapitan shell script that wraps the docker command to run Kapitan

$ ./kapitan compile
Compiled postgres-proxy (1.51s)
Compiled tesoro (1.70s)
Compiled echo-server (1.64s)
Compiled mysql (1.67s)
Compiled gke-pvm-killer (1.17s)
Compiled prod-sockshop (4.74s)
Compiled dev-sockshop (4.74s)
Compiled tutorial (1.68s)
Compiled global (0.76s)
Compiled examples (2.60s)
Compiled pritunl (2.03s)
Compiled sock-shop (4.36s)

Other installation methods

Docker

Releases

recommended

Docker

Docker Pulls Docker Image Size Docker

alias kapitan="docker run -t --rm -u $(id -u) -v $(pwd):/src:delegated kapicorp/kapitan"
kapitan -h

alias kapitan="docker run -t --rm -v $(pwd):/src:delegated kapicorp/kapitan"
kapitan -h

Pip

Install Python

Python version Unit Tests

sudo apt-get update && sudo apt-get install -y python3.8-dev python3-pip python3-yaml

brew install python3 libyaml libmagic

Install Kapitan using pip

downloads

User

kapitan will be installed in $HOME/.local/lib/python3.7/bin

pip3 install --user --upgrade kapitan

kapitan will be installed in $HOME/Library/Python/3.7/bin

pip3 install --user --upgrade kapitan
System-wide

not recommended

sudo pip3 install --upgrade kapitan