Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vmware-archive/kubecfg

A tool for managing complex enterprise Kubernetes environments as code.
https://github.com/vmware-archive/kubecfg

infrastructure-as-code jsonnet kubernernetes-resources kubernetes

Last synced: 6 days ago
JSON representation

A tool for managing complex enterprise Kubernetes environments as code.

Awesome Lists containing this project

README 

        
# kubecfg



[![Build Status](https://app.travis-ci.com/bitnami/kubecfg.svg?branch=main)](https://app.travis-ci.com/github/bitnami/kubecfg)

[![Go Report Card](https://goreportcard.com/badge/github.com/bitnami/kubecfg)](https://goreportcard.com/report/github.com/bitnami/kubecfg)



## WARNING: kubecfg is no longer actively maintained by VMware.

VMware has made the difficult decision to stop driving this project and therefore we will no longer actively respond to issues or pull requests. The project will be externally maintained in the following fork: https://github.com/kubecfg/kubecfg



Thank You.



## Overview



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 ;)



## Install



Pre-compiled executables exist for some platforms on

the [Github releases](https://github.com/bitnami/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/bitnami/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.