⚠️ Work in Progress
You are viewing development documentation built from the latest commit on main. APIs and features are subject to change.

API Reference

API Reference

Kure’s public API is organized into focused packages. Each package README below is auto-synced from the source code.

For full Go API documentation, see pkg.go.dev/github.com/go-kure/kure .

Core Domain

PackageDescriptionReference
StackCluster, Node, Bundle, Application domain modelpkg.go.dev
Flux EngineFluxCD workflow implementationpkg.go.dev
Layout EngineManifest directory organizationpkg.go.dev

Resource Operations

PackageDescriptionReference
IOYAML/JSON serialization and resource printingpkg.go.dev
Manifest ClassificationCRD recognition and object scope classificationpkg.go.dev
Kubernetes BuildersCore K8s resource constructors (GVK, HPA, PDB)pkg.go.dev
Cert-Manager Builderscert-manager CRD constructors (Certificate, Issuer, ClusterIssuer)pkg.go.dev
Cilium BuildersCilium CRD constructors (network policies and related resources)pkg.go.dev
CloudNativePG BuildersCloudNativePG and Barman Cloud CRD constructorspkg.go.dev
External Secrets BuildersExternal Secrets Operator constructors (ExternalSecret, SecretStore)pkg.go.dev
FluxCD BuildersLow-level Flux resource constructorspkg.go.dev
MetalLB BuildersMetalLB constructors (IPAddressPool, L2Advertisement)pkg.go.dev
Prometheus BuildersPrometheus Operator CRD constructors (ServiceMonitor, PodMonitor, PrometheusRule)pkg.go.dev
VolSync BuildersVolSync backup/restore CRD constructorspkg.go.dev

Utilities

PackageDescriptionReference
ErrorsStructured error typespkg.go.dev
LoggerStructured loggingpkg.go.dev

Compatibility

ArgoCD

ArgoCD support exists at pkg/stack/argocd/ but is not yet production-ready. It is not featured in guides or examples. The Flux workflow is the primary supported GitOps integration.