# README
kindsys
This is the cue+thema + global kindsys wrapper for k8s objects.
Further development on thema is on hold while we evaluate options, but this package includes all thema bindings needed for app platform.
# Functions
BindCustom creates a Custom-implementing type from a def, runtime, and opts
nolint:lll.
No description provided by the author
CUEFramework returns a cue.Value representing all the kindsys framework raw CUE files.
LoadInstance returns a build.Instance populated with the CueSchemaFS at the root and an optional overlay filesystem.
ToDef takes a cue.Value expected to represent a kind of the category specified by the type parameter and populates a Def from the CUE value.
ToKindProps takes a cue.Value expected to represent a kind of the category specified by the type parameter and populates the Go type from the cue.Value.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
CueSchemaFS embeds all CUE files in the Kindsys project.
ErrInvalidCUE indicates that the CUE representing the kind is invalid.
ErrValueNotAKind indicates that a provided CUE value is not any variety of Kind.
ErrValueNotExist indicates that a necessary CUE value did not exist.
# Structs
CommonProperties contains the metadata common to all categories of kinds.
CustomProperties represents the static properties in the definition of a Custom kind that are representable with basic Go types.
Def represents a single kind definition, having been loaded and validated by a func such as [LoadCoreKindDef].
SomeDef represents a single kind definition, having been loaded and validated by a func such as [LoadCoreKindDef].
# Interfaces
No description provided by the author
Kind describes a Grafana kind object: a Go representation of the definition of one of Grafana's categories of kinds.
KindProperties is a type parameter that comprises the base possible set of kind metadata configurations.
SomeKindProperties is an interface type to abstract over the different kind property struct types: [CoreProperties], [CustomProperties]
It is the traditional interface counterpart to the generic type constraint KindProperties.
# Type aliases
TODO docs.