Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kubecfg/kubecfg
A tool for managing complex enterprise Kubernetes environments as code.
https://github.com/kubecfg/kubecfg
infrastructure-as-code jsonnet kubernetes kubernetes-resources
Last synced: 3 months ago
JSON representation
A tool for managing complex enterprise Kubernetes environments as code.
- Host: GitHub
- URL: https://github.com/kubecfg/kubecfg
- Owner: kubecfg
- License: apache-2.0
- Created: 2021-11-17T10:33:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T14:24:52.000Z (6 months ago)
- Last Synced: 2024-05-20T16:17:35.391Z (6 months ago)
- Topics: infrastructure-as-code, jsonnet, kubernetes, kubernetes-resources
- Language: Go
- Homepage:
- Size: 19.9 MB
- Stars: 192
- Watchers: 4
- Forks: 22
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# kubecfg
[](https://goreportcard.com/report/github.com/kubecfg/kubecfg)
A tool for managing Kubernetes resources as code.
`kubecfg` allows you to express the patterns across your
infrastructure and reuse these powerful "templates" across many
services, and then manage those templates as files in version control.
The more complex your infrastructure is, the more you will gain from
using kubecfg.
Yes, Google employees will recognise this as being very similar to a
similarly-named internal tool ;)
## Documentation
https://kubecfg.github.io/kubecfg/
## Install
Pre-compiled executables exist for some platforms on
the [Github releases](https://github.com/kubecfg/kubecfg/releases)
page.
On macOS, it can also be installed via [Homebrew](https://brew.sh/):
`brew install kubecfg`
To build from source:
```console
% PATH=$PATH:$GOPATH/bin
% go get github.com/kubecfg/kubecfg
```
## Quickstart
```console
# Show generated YAML
% kubecfg show -o yaml examples/guestbook.jsonnet
# Create resources
% kubecfg update examples/guestbook.jsonnet
# Modify configuration (downgrade gb-frontend image)
% sed -i.bak '\,gcr.io/google-samples/gb-frontend,s/:v4/:v3/' examples/guestbook.jsonnet
# See differences vs server
% kubecfg diff examples/guestbook.jsonnet
# Update to new config
% kubecfg update examples/guestbook.jsonnet
# Clean up after demo
% kubecfg delete examples/guestbook.jsonnet
```
## Features
- Supports JSON, YAML or jsonnet files (by file suffix).
- Best-effort sorts objects before updating, so that dependencies are
pushed to the server before objects that refer to them.
- Additional jsonnet builtin functions. See `lib/kubecfg.libsonnet`.
- Optional "garbage collection" of objects removed from config (see
`--gc-tag`).
## Infrastructure-as-code Philosophy
The idea is to describe *as much as possible* about your configuration
as files in version control (eg: git).
Changes to the configuration follow a regular review, approve, merge,
etc code change workflow (github pull-requests, phabricator diffs,
etc). At any point, the config in version control captures the entire
desired-state, so the system can be easily recreated in a QA cluster
or to recover from disaster.
### Jsonnet
Kubecfg relies heavily on [jsonnet](http://jsonnet.org/) to describe
Kubernetes resources, and is really just a thin Kubernetes-specific
wrapper around jsonnet evaluation. You should read the jsonnet
[tutorial](http://jsonnet.org/docs/tutorial.html), and skim the functions available in the jsonnet [`std`](http://jsonnet.org/docs/stdlib.html)
library.
## Community
- [#jsonnet on Kubernetes Slack](https://kubernetes.slack.com/messages/jsonnet)
Click [here](http://slack.k8s.io) to sign up to the Kubernetes Slack org.