Directories
¶
| Path | Synopsis |
|---|---|
|
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
|
|
|
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. |
|
pkg
|
|
|
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 the scheme, the generic constructor and the admissible sugar helpers for building Kubernetes objects under the builder contract (ADR-038).
|
Package kubernetes provides the scheme, the generic constructor and the admissible sugar helpers for building Kubernetes objects under the builder contract (ADR-038). |
|
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/cilium
Package cilium exposes helper functions for constructing Cilium network policy resources.
|
Package cilium exposes helper functions for constructing Cilium network policy resources. |
|
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/internal/admission
Package admission classifies the exported Set*/Add* sugar helpers under pkg/kubernetes by the builder contract's admission classes (ADR-038 §4).
|
Package admission classifies the exported Set*/Add* sugar helpers under pkg/kubernetes by the builder contract's admission classes (ADR-038 §4). |
|
kubernetes/internal/crds
Package crds reads the CustomResourceDefinition manifests a pinned module ships alongside its Go source, so a kind's scope can be taken from what controller-gen actually emitted for it.
|
Package crds reads the CustomResourceDefinition manifests a pinned module ships alongside its Go source, so a kind's scope can be taken from what controller-gen actually emitted for it. |
|
kubernetes/internal/gen
command
Command gen emits the per-kind constructor wrappers under pkg/kubernetes and the kinds registry the identity test walks, from the registered scheme and the scope table in internal/kinds.
|
Command gen emits the per-kind constructor wrappers under pkg/kubernetes and the kinds registry the identity test walks, from the registered scheme and the scope table in internal/kinds. |
|
kubernetes/internal/kinds
Package kinds enumerates the object kinds registered in the pkg/kubernetes scheme and states each one's scope.
|
Package kinds enumerates the object kinds registered in the pkg/kubernetes scheme and states each one's scope. |
|
kubernetes/internal/markers
Package markers parses the controller-gen marker comments that upstream API types carry, so kure derives a kind's scope and a field's maturity from the pinned module sources instead of a hand-kept table.
|
Package markers parses the controller-gen marker comments that upstream API types carry, so kure derives a kind's scope and a field's maturity from the pinned module sources instead of a hand-kept table. |
|
kubernetes/internal/maturity
Package maturity reports which fields of the API types kure builds are gated, alpha, beta or deprecated upstream.
|
Package maturity reports which fields of the API types kure builds are gated, alpha, beta or deprecated upstream. |
|
kubernetes/internal/upstream
Package upstream loads the pinned API module sources that back the registered kinds, so scope and maturity are read from the modules kure actually builds against rather than from a table maintained by hand.
|
Package upstream loads the pinned API module sources that back the registered kinds, so scope and maturity are read from the modules kure actually builds against rather than from a table maintained by hand. |
|
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. |
|
manifest
Package manifest provides shared classification of Kubernetes manifests: recognizing CustomResourceDefinitions and determining the namespacing (scope) of an arbitrary object.
|
Package manifest provides shared classification of Kubernetes manifests: recognizing CustomResourceDefinitions and determining the namespacing (scope) of an arbitrary object. |
|
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/helm
Package helm provides client-side Helm chart rendering from OCI registries and HTTP Helm repositories.
|
Package helm provides client-side Helm chart rendering from OCI registries and HTTP Helm repositories. |
|
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. |
|
versions
Package versions exposes kure's supported-version metadata as a stable Go API, so consumers do not have to parse versions.yaml key paths by hand.
|
Package versions exposes kure's supported-version metadata as a stable Go API, so consumers do not have to parse versions.yaml key paths by hand. |
Click to show internal directories.
Click to hide internal directories.