Generators

Generators - Application Generator System

The generators package provides a type-safe system for creating Kubernetes application workloads from configuration. Generators implement the stack.ApplicationConfig interface, allowing them to be used as applications within the domain model.

Overview

Generators use the GroupVersionKind (GVK) type system to identify and instantiate application configurations. Each generator is registered in a global registry and can be referenced by its GVK identifier.

Available Generators

Usage

Creating a Generator from GVK

import "github.com/go-kure/kure/pkg/stack/generators"

// Look up generator by GVK
factory, err := generators.GetGenerator("generators/AppWorkload")

// Create application config from YAML configuration
config, err := factory.FromConfig(yamlData)

// Use in domain model
app := stack.NewApplication("my-app", "default", config)

YAML Configuration Format

Generators are typically configured via YAML:

apiVersion: generators/v1
kind: AppWorkload
metadata:
  name: my-web-app
spec:
  image: nginx:1.25
  replicas: 3
  ports:
    - containerPort: 80
      servicePort: 80
  env:
    - name: LOG_LEVEL
      value: info

Registry

Register custom generators:

generators.Register("mycompany/CustomApp", &MyGeneratorFactory{})

Query available generators:

// List all registered generator GVKs
gvks := generators.ListRegistered()

Sub-packages

appworkload

General-purpose application generator that produces:

• Deployment with configurable replicas, image, resources
• Service with port mappings
• Optional ConfigMap for configuration data
• Optional ServiceAccount

fluxhelm

Generates Flux HelmRelease resources for Helm-based applications:

• HelmRelease with chart reference
• HelmRepository source (if needed)
• Values configuration

kurelpackage

References kurel packages as applications within the stack hierarchy, enabling package-based deployments in cluster definitions.

Related Packages

• stack - Core domain model and ApplicationConfig interface
• stack/fluxcd - Flux workflow engine