# Kapitan: advanced configuration management tool
[![Test, Build and Publish docker image](https://github.com/kapicorp/kapitan/actions/workflows/test-build-publish.yml/badge.svg?branch=master&event=push)](https://github.com/kapicorp/kapitan/actions/workflows/test-build-publish.yml)
![Python Version](https://img.shields.io/pypi/pyversions/kapitan)
![Downloads](https://img.shields.io/pypi/dm/kapitan)
![Docker Pulls](https://img.shields.io/docker/pulls/kapicorp/kapitan)
[![Releases](https://img.shields.io/github/release/kapicorp/kapitan.svg)](https://github.com/kapicorp/kapitan/releases)
[![Docker Image Size](https://img.shields.io/docker/image-size/kapicorp/kapitan/latest.svg)](https://hub.docker.com/r/kapicorp/kapitan)
<img src="docs/images/kapitan_logo.png" width="25">
**`Kapitan`** aims to be your *one-stop tool* to help you manage the ever growing complexity of your configurations.
Join the community [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3)
## [**Official site**](https://kapitan.dev) <https://kapitan.dev>
## [**Quick Start**](https://kapitan.dev/getting_started/#quickstart)
## Install Kapitan
### Docker (recommended)
```shell
docker run -t --rm -v $(pwd):/src:delegated kapicorp/kapitan -h
```
On Linux you can add `-u $(id -u)` to `docker run` to preserve file permissions.
### Pip
Kapitan needs Python 3.7.
#### Install Python 3.7
* Linux: `sudo apt-get update && sudo apt-get install -y python3.7-dev python3-pip python3-yaml git`
* Mac: `brew install python3 libyaml git libmagic`
#### Install Kapitan
User (`$HOME/.local/lib/python3.7/bin` on Linux or `$HOME/Library/Python/3.7/bin` on macOS):
```shell
pip3 install --user --upgrade kapitan
```
System-wide (not recommended):
```shell
sudo pip3 install --upgrade kapitan
```
## Build Kapitan
### Docker
To build a docker image for the architecture of your machine, run `docker build . -t you-kapitan-image`, and to build for a specific platform, add `--platform linux/arm64`.
To build a multi-platform image (as the CI does), follow [the docker multi-platform documentation](https://docs.docker.com/build/building/multi-platform/).
## Related projects
* [Tesoro](https://github.com/kapicorp/tesoro) - Kubernetes Admission Controller for Kapitan Secrets
* [Kapitan Reference](https://github.com/kapicorp/kapitan-reference) - our reference repository to get started with Kapitan
Raw data
{
"_id": null,
"home_page": "https://github.com/kapicorp/kapitan",
"name": "kapitan",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "jsonnet,kubernetes,reclass,jinja",
"author": "Ricardo Amaro",
"author_email": "ramaro@kapicorp.com",
"download_url": "https://files.pythonhosted.org/packages/13/de/a1db80eb547f0d97f1cec8ed6be7d49dc76ec588e94dd69c1c88bf594ad3/kapitan-0.33.0.tar.gz",
"platform": null,
"description": "# Kapitan: advanced configuration management tool\n\n[![Test, Build and Publish docker image](https://github.com/kapicorp/kapitan/actions/workflows/test-build-publish.yml/badge.svg?branch=master&event=push)](https://github.com/kapicorp/kapitan/actions/workflows/test-build-publish.yml)\n![Python Version](https://img.shields.io/pypi/pyversions/kapitan)\n![Downloads](https://img.shields.io/pypi/dm/kapitan)\n![Docker Pulls](https://img.shields.io/docker/pulls/kapicorp/kapitan)\n[![Releases](https://img.shields.io/github/release/kapicorp/kapitan.svg)](https://github.com/kapicorp/kapitan/releases)\n[![Docker Image Size](https://img.shields.io/docker/image-size/kapicorp/kapitan/latest.svg)](https://hub.docker.com/r/kapicorp/kapitan)\n\n<img src=\"docs/images/kapitan_logo.png\" width=\"25\">\n\n\n**`Kapitan`** aims to be your *one-stop tool* to help you manage the ever growing complexity of your configurations.\n\nJoin the community [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3)\n\n## [**Official site**](https://kapitan.dev) <https://kapitan.dev>\n\n\n## [**Quick Start**](https://kapitan.dev/getting_started/#quickstart)\n\n## Install Kapitan\n\n### Docker (recommended)\n\n```shell\ndocker run -t --rm -v $(pwd):/src:delegated kapicorp/kapitan -h\n```\n\nOn Linux you can add `-u $(id -u)` to `docker run` to preserve file permissions.\n\n### Pip\n\nKapitan needs Python 3.7.\n\n#### Install Python 3.7\n\n* Linux: `sudo apt-get update && sudo apt-get install -y python3.7-dev python3-pip python3-yaml git`\n* Mac: `brew install python3 libyaml git libmagic`\n\n#### Install Kapitan\n\nUser (`$HOME/.local/lib/python3.7/bin` on Linux or `$HOME/Library/Python/3.7/bin` on macOS):\n\n```shell\npip3 install --user --upgrade kapitan\n```\n\nSystem-wide (not recommended):\n\n```shell\nsudo pip3 install --upgrade kapitan\n```\n\n## Build Kapitan\n\n### Docker\n\nTo build a docker image for the architecture of your machine, run `docker build . -t you-kapitan-image`, and to build for a specific platform, add `--platform linux/arm64`.\n\nTo build a multi-platform image (as the CI does), follow [the docker multi-platform documentation](https://docs.docker.com/build/building/multi-platform/).\n\n## Related projects\n\n* [Tesoro](https://github.com/kapicorp/tesoro) - Kubernetes Admission Controller for Kapitan Secrets\n* [Kapitan Reference](https://github.com/kapicorp/kapitan-reference) - our reference repository to get started with Kapitan\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Generic templated configuration management for Kubernetes, Terraform and other things",
"version": "0.33.0",
"project_urls": {
"Documentation": "https://kapitan.dev/",
"Homepage": "https://github.com/kapicorp/kapitan",
"Repository": "https://github.com/kapicorp/kapitan"
},
"split_keywords": [
"jsonnet",
"kubernetes",
"reclass",
"jinja"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df29d85570e005dc1ddb5484747ae05460210d7218f35274283852f6d9626c11",
"md5": "52aacd577bfd29aa62b4357b7544a988",
"sha256": "14cb9c0ab58a5a90ec9de553d1517a56161b8423b57cc65a258854fc4faf5d22"
},
"downloads": -1,
"filename": "kapitan-0.33.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52aacd577bfd29aa62b4357b7544a988",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 254331,
"upload_time": "2024-01-30T08:47:10",
"upload_time_iso_8601": "2024-01-30T08:47:10.699663Z",
"url": "https://files.pythonhosted.org/packages/df/29/d85570e005dc1ddb5484747ae05460210d7218f35274283852f6d9626c11/kapitan-0.33.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13dea1db80eb547f0d97f1cec8ed6be7d49dc76ec588e94dd69c1c88bf594ad3",
"md5": "ea6e7819d16f7d9f1b653086de2d4e32",
"sha256": "7b2e0545208aac552ca05f5a07d256fe075642f2053773cab01eed47391e0821"
},
"downloads": -1,
"filename": "kapitan-0.33.0.tar.gz",
"has_sig": false,
"md5_digest": "ea6e7819d16f7d9f1b653086de2d4e32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 161746,
"upload_time": "2024-01-30T08:47:13",
"upload_time_iso_8601": "2024-01-30T08:47:13.027145Z",
"url": "https://files.pythonhosted.org/packages/13/de/a1db80eb547f0d97f1cec8ed6be7d49dc76ec588e94dd69c1c88bf594ad3/kapitan-0.33.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 08:47:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kapicorp",
"github_project": "kapitan",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kapitan"
}