kure

module

v0.2.0-alpha.1 Latest Latest Go to latest Published: May 4, 2026 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/go-kure/kure

Links

Open Source Insights

README ¶

Kure

Kure is a Go library for programmatically building Kubernetes resources used by GitOps tools like Flux, cert-manager, MetalLB, and External Secrets. The library emphasizes strongly-typed object construction over templating engines, providing a clean, type-safe approach to Kubernetes manifest generation.

Features

Type-safe Kubernetes resource builders (Deployments, Services, RBAC, etc.)
GitOps workflow support (Flux CD and ArgoCD)
Hierarchical domain model (Cluster → Node → Bundle → Application)
Declarative JSONPath-based patching
Certificate management (cert-manager, ACME)
Secret management (External Secrets, multiple cloud providers)
Network configuration (MetalLB)
Manifest layout engine with auto-generated kustomization.yaml
Built-in configuration validation

Installation

go get github.com/go-kure/kure

CLI Tools

Kure ships a CLI tool: kure for manifest generation. Run kure --help for usage details.

Documentation

Website — guides, architecture, and tutorials
API Reference — full Go package documentation
examples/ — cluster configurations and patching samples

Development

DEVELOPMENT.md — setup, build, test, and lint instructions
CHANGELOG.md — release history

Quick commands:

make build   # Build all executables
make test    # Run tests
make lint    # Run linter

License

This project is licensed under the Apache License 2.0.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
demo command
gendocs command cmd/gendocs generates CLI reference documentation from cobra command trees.	cmd/gendocs generates CLI reference documentation from cobra command trees.
kure command
examples
getting-started command Package main demonstrates the complete Kure pipeline from Cluster definition to on-disk manifest directory.	Package main demonstrates the complete Kure pipeline from Cluster definition to on-disk manifest directory.
internal
certmanager Package certmanager provides helpers for building cert-manager resources such as Certificates, Issuers and ClusterIssuers.	Package certmanager provides helpers for building cert-manager resources such as Certificates, Issuers and ClusterIssuers.
cnpg Package cnpg provides helpers for building CloudNativePG resources such as Clusters (with managed roles), Database CRs (postgresql.cnpg.io/v1), ObjectStore CRs (barmancloud.cnpg.io/v1), and ScheduledBackups.	Package cnpg provides helpers for building CloudNativePG resources such as Clusters (with managed roles), Database CRs (postgresql.cnpg.io/v1), ObjectStore CRs (barmancloud.cnpg.io/v1), and ScheduledBackups.
externalsecrets Package externalsecrets contains helpers for constructing resources used by the External Secrets Operator.	Package externalsecrets contains helpers for constructing resources used by the External Secrets Operator.
fluxcd Package fluxcd provides helper functions for creating Flux CD resources.	Package fluxcd provides helper functions for creating Flux CD resources.
kubernetes Package k8s offers helper functions for core Kubernetes resources such as Deployments, Services and ConfigMaps.	Package k8s offers helper functions for core Kubernetes resources such as Deployments, Services and ConfigMaps.
metallb Package metallb provides constructors for MetalLB custom resources including BGP peers, IPAddressPools and advertisements.	Package metallb provides constructors for MetalLB custom resources including BGP peers, IPAddressPools and advertisements.
prometheus
volsync Package volsync contains the internal builders for VolSync resources.	Package volsync contains the internal builders for VolSync resources.
pkg
cli Package cli provides shared utilities and abstractions for building command-line interfaces in the Kure and kurel tools.	Package cli provides shared utilities and abstractions for building command-line interfaces in the Kure and kurel tools.
cmd/kure
cmd/kure/generate
cmd/kure/initialize Package initialize implements the "kure init" command, which scaffolds a new project directory with cluster configuration and example application templates ready for use with "kure generate cluster".	Package initialize implements the "kure init" command, which scaffolds a new project directory with cluster configuration and example application templates ready for use with "kure generate cluster".
cmd/shared
cmd/shared/options
errors Package errors provides structured error types and handling utilities for the Kure library and kurel tool.	Package errors provides structured error types and handling utilities for the Kure library and kurel tool.
gvk Package gvk provides shared infrastructure for Group, Version, Kind (GVK) based type systems within Kure.	Package gvk provides shared infrastructure for Group, Version, Kind (GVK) based type systems within Kure.
io Package io provides utilities for reading, writing and parsing YAML representations of Kubernetes resources.	Package io provides utilities for reading, writing and parsing YAML representations of Kubernetes resources.
kubernetes Package kubernetes provides helper functions for working with core Kubernetes resource types.	Package kubernetes provides helper functions for working with core Kubernetes resource types.
kubernetes/certmanager Package certmanager exposes helper functions for constructing resources used by the cert-manager project.	Package certmanager exposes helper functions for constructing resources used by the cert-manager project.
kubernetes/cnpg Package cnpg exposes helper functions for constructing resources used by CloudNativePG (CNPG) and the Barman Cloud plugin.	Package cnpg exposes helper functions for constructing resources used by CloudNativePG (CNPG) and the Barman Cloud plugin.
kubernetes/externalsecrets Package externalsecrets exposes helper functions for constructing external-secrets resources.	Package externalsecrets exposes helper functions for constructing external-secrets resources.
kubernetes/fluxcd Package fluxcd exposes helper functions for constructing resources used by the Flux family of controllers.	Package fluxcd exposes helper functions for constructing resources used by the Flux family of controllers.
kubernetes/metallb Package metallb exposes helper functions for constructing MetalLB resources.	Package metallb exposes helper functions for constructing MetalLB resources.
kubernetes/prometheus Package prometheus exposes helper functions for constructing Prometheus operator resources.	Package prometheus exposes helper functions for constructing Prometheus operator resources.
kubernetes/volsync Package volsync provides builders for VolSync (volsync.backube/v1alpha1) resources: ReplicationSource and ReplicationDestination.	Package volsync provides builders for VolSync (volsync.backube/v1alpha1) resources: ReplicationSource and ReplicationDestination.
logger Package logger provides a structured logging interface for the Kure library.	Package logger provides a structured logging interface for the Kure library.
stack Package stack provides the core domain model for defining and generating Kubernetes cluster configurations with GitOps tooling (Flux CD or ArgoCD).	Package stack provides the core domain model for defining and generating Kubernetes cluster configurations with GitOps tooling (Flux CD or ArgoCD).
stack/argocd
stack/fluxcd
stack/generators Package generators provides a pluggable system for generating Kubernetes resources from different configuration formats.	Package generators provides a pluggable system for generating Kubernetes resources from different configuration formats.
stack/generators/appworkload Package appworkload provides generators for creating standard Kubernetes workloads (Deployments, StatefulSets, DaemonSets) along with their associated resources (Services, Ingresses, PersistentVolumeClaims).	Package appworkload provides generators for creating standard Kubernetes workloads (Deployments, StatefulSets, DaemonSets) along with their associated resources (Services, Ingresses, PersistentVolumeClaims).
stack/generators/appworkload/internal
stack/generators/fluxhelm Package fluxhelm provides generators for creating Flux HelmRelease resources along with their associated source resources (HelmRepository, GitRepository, OCIRepository, or Bucket).	Package fluxhelm provides generators for creating Flux HelmRelease resources along with their associated source resources (HelmRepository, GitRepository, OCIRepository, or Bucket).
stack/generators/fluxhelm/internal
stack/generators/kurelpackage Package kurelpackage provides a generator for creating kurel packages from Kubernetes manifests with support for values substitution, patches, and conditional extensions.	Package kurelpackage provides a generator for creating kurel packages from Kubernetes manifests with support for values substitution, patches, and conditional extensions.
stack/helm Package helm provides client-side Helm chart rendering from OCI registries.	Package helm provides client-side Helm chart rendering from OCI registries.
stack/layout Package layout provides utilities for generating cluster directory layouts and for writing Kubernetes and Flux manifests to disk.	Package layout provides utilities for generating cluster directory layouts and for writing Kubernetes and Flux manifests to disk.