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
| Package | Description | Reference |
|---|---|---|
| Stack | Cluster, Node, Bundle, Application domain model | pkg.go.dev |
| Flux Engine | FluxCD workflow implementation | pkg.go.dev |
| Generators | Application generator system (GVK) | pkg.go.dev |
| Layout Engine | Manifest directory organization | pkg.go.dev |
Package System
| Package | Description | Reference |
|---|---|---|
| Launcher | Kurel package loading, building, validation | pkg.go.dev |
Resource Operations
| Package | Description | Reference |
|---|---|---|
| Patch | JSONPath-based declarative patching | pkg.go.dev |
| IO | YAML/JSON serialization and resource printing | pkg.go.dev |
| Kubernetes Builders | Core K8s resource constructors (GVK, HPA, PDB) | pkg.go.dev |
| FluxCD Builders | Low-level Flux resource constructors | pkg.go.dev |
Utilities
| Package | Description | Reference |
|---|---|---|
| Errors | Structured error types | pkg.go.dev |
| CLI Utilities | Factory, IOStreams, Printer | pkg.go.dev |
| Logger | Structured logging | pkg.go.dev |
Compatibility
- Compatibility Matrix - Supported Kubernetes and dependency versions
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.