k8t
Pronounced katie [ˈkeɪti]
Simple cluster and environment specific aware templating for kubernetes manifests.
Table of Contents generated with DocToc
installation
run this
$ pip install --user --upgrade k8t
note: k8t is not Python 2 compatible
usage
scaffolding
Create a new project folder with a cluster directory and an empty defaults file
$ k8t new project foobar
Create a new cluster
$ k8t new cluster A
Create a new environment
$ k8t new environment staging -c A
$ k8t new environment production
Generate a new deployment template for cluster A (currently only deployment and service are supported)
$ k8t new template deployment -c A
Specify prefixes for secrets
$ k8t edit config --cluster A --environment staging
secrets:
prefix: "staging/application"```
Values can be easily added/modified in the same way
$ k8t edit values --cluster Ano creds to it anyway or dont know where to get
A typical setup should look something like this
.deploy/
├── clusters
│ ├── A
│ │ ├── config.yaml
│ │ ├── environments
│ │ │ ├── production
│ │ │ │ ├── config.yaml
│ │ │ │ ├── files
│ │ │ │ ├── templates
│ │ │ │ └── values.yaml
│ │ │ └── staging
│ │ │ ├── config.yaml
│ │ │ ├── files
│ │ │ ├── templates
│ │ │ └── values.yaml
│ │ ├── files
│ │ ├── templates
│ │ └── values.yaml
│ └── local
│ ├── environments
│ ├── files
│ ├── secret.yaml.j2
│ ├── templates
│ │ ├── database.yaml.j2
│ │ └── secret.yaml.j2
│ └── values.yaml
├── config.yaml
├── files
├── templates
│ ├── deployment.yaml.j2
│ └── secret.yaml.j2
└── values.yaml
validate files
While validation is done before generating, templates can be validated for environment files easily.
$ k8t validate
To validate for clusters/environments the usual options can be used
$ k8t validate -c A -e production
generate files
The --cluster flag will load variables from a directory. By default the file default.yaml in that directory will be loaded, however an environment can be specified with --environment.
$ k8t gen -c A -e staging
Additionally k8t will attempt to load a file defaults.yaml in the root directory. This way a set of default variables can be specified and selectively overriden via cluster and environment.
Additional values can be given via flag --value-file in the form of a file or --value KEY VALUE, both can be supplied multiple times.
Variables will be merged via deep merging. Default merge strategy is left-to-right. For the merge order see the output of
$ k8t --help
Overriding templates
Templates can be overriden on a cluster/environment level.
If a file application.yaml exists in the root templates folder, simply add a file with the same name to the
cluster/environment template folder.
Managing secrets
SSM
Setup secrets on SSM
$ k8t edit config
secrets:
provider: ssm
prefix: "foobar"
TODO
- testing needs to be expanded
- add more templates for manifest scaffolding
- the ability to add additional template directories via the CLI
- validation functions for template values (e.g. memory/cpu values)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file k8t-0.1.11.tar.gz.
File metadata
- Download URL: k8t-0.1.11.tar.gz
- Upload date:
- Size: 21.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.8.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d838ec350d793b8b450fd73512d6d8359fd74d151166992d628cd8d7402910b
|
|
| MD5 |
8b6d78c057d88a80a2be0775bbebfd5a
|
|
| BLAKE2b-256 |
126ab1056ff8d4c478e522a0dd5551e298611557835b6a386f1abe953fde5d4b
|
File details
Details for the file k8t-0.1.11-py3-none-any.whl.
File metadata
- Download URL: k8t-0.1.11-py3-none-any.whl
- Upload date:
- Size: 21.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.8.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c63678e8c6f695ce275cfe543c4d0fe33d155f24f391437451bb1084dcc1e062
|
|
| MD5 |
e2cf4e3bd81ba143d836d954f037998e
|
|
| BLAKE2b-256 |
15c9511a73c702f0509b445a370321db6d23ecf9388208725c2a9834a1ab9605
|
