Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.74 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.74 KB
Raw

Kapitan Generators

This repository contains the current efforts in creating Kapitan Generators.

These are meant to be used as part of the Kapitan project and not on their own. Please see <kapitan.dev> or https://github.com/kapicorp/kapitan-reference to get started.

What are Generators

As explained in the blog post Keep your ship together with Kapitan, (Kapitan) generators are a powerful idea to simplify the management your configuration setup.

Think of them as universal templates that you can use to quickly create configurations (for instance, Kubernetes resources) through a domain-specific configuration.

For example, the configuration:

parameters:
  components:
    nginx:
      image: nginx

Instructs the "Kubernetes Generator" to create a Deployment Kubernetes resource for nginx. The configuration can be extended to include Secrets, ConfigMaps, Services, env variables, ports and more.

The same configuration can be used by a "Documentation Generator" to create an nginx.md file with a description of the configuration to be consumed as documentation.

Kapicorp Generators

Name Description Documentation
documentation Documentation generator Documentation
kubernetes Kubernetes resources generator Documentation
terraform Terraform generator