mirror of
https://github.com/holos-run/holos.git
synced 2026-03-21 09:45:00 +00:00
53cb9ba7fb
Previously a couple of methods were defined on the Result struct. This patch moves the methods to an internal wrapper struct to remove them from the API documentation. With this patch the API between holos and CUE is entirely a data API.
45 lines
2.0 KiB
Go
45 lines
2.0 KiB
Go
package v1alpha2
|
|
|
|
import "google.golang.org/protobuf/types/known/structpb"
|
|
|
|
// Label is an arbitrary unique identifier internal to holos itself. The holos
|
|
// cli is expected to never write a Label value to rendered output files,
|
|
// therefore use a [Label] then the identifier must be unique and internal.
|
|
// Defined as a type for clarity and type checking.
|
|
//
|
|
// A Label is useful to convert a CUE struct to a list, for example producing a list of [APIObject] resources from an [APIObjectMap]. A CUE struct using
|
|
// Label keys is guaranteed to not lose data when rendering output because a
|
|
// Label is expected to never be written to the final output.
|
|
type Label string
|
|
|
|
// Kind is a kubernetes api object kind. Defined as a type for clarity and type checking.
|
|
type Kind string
|
|
|
|
// APIObject represents the most basic generic form of a single kubernetes api
|
|
// object. Represented as a JSON object internally for compatibility between
|
|
// tools, for example loading from CUE.
|
|
type APIObject structpb.Struct
|
|
|
|
// APIObjectMap represents the marshalled yaml representation of kubernetes api
|
|
// objects. Do not produce an APIObjectMap directly, instead use [APIObjects]
|
|
// to produce the marshalled yaml representation from CUE data, then provide the
|
|
// result to [HolosComponent].
|
|
type APIObjectMap map[Kind]map[Label]string
|
|
|
|
// APIObjects represents Kubernetes API objects defined directly from CUE code.
|
|
// Useful to mix in resources to any kind of [HolosComponent], for example
|
|
// adding an ExternalSecret resource to a [HelmChart].
|
|
//
|
|
// [Kind] must be the resource kind, e.g. Deployment or Service.
|
|
//
|
|
// [Label] is an arbitrary internal identifier to uniquely identify the resource
|
|
// within the context of a `holos` command. Holos will never write the
|
|
// intermediate label to rendered output.
|
|
//
|
|
// Refer to [HolosComponent] which accepts an [APIObjectMap] field provided by
|
|
// [APIObjects].
|
|
type APIObjects struct {
|
|
APIObjects map[Kind]map[Label]APIObject `json:"apiObjects"`
|
|
APIObjectMap APIObjectMap `json:"apiObjectMap"`
|
|
}
|