mirror of
https://github.com/holos-run/holos.git
synced 2026-04-07 18:15:00 +00:00
d0b392cfe0
The API docs are not published yet becuase the module is private. Our own docs site does not have any API reference docs. This patch adds auto-generated markdown docs for the core v1alpha2 types by generating them directly from the go source code. Some light editing of the output of `gomarkdoc` is necessary to get the heading anchor tags to align correctly for Docusaurus.
27 lines
1.2 KiB
Go
27 lines
1.2 KiB
Go
// Package v1alpha2 contains the core API contract between the holos cli and CUE
|
|
// configuration code. Platform designers, operators, and software developers
|
|
// use this API to write configuration in CUE which `holos` loads. The overall
|
|
// shape of the API defines imperative actions `holos` should carry out to
|
|
// render the complete yaml that represents a Platform.
|
|
//
|
|
// [Platform] defines the complete configuration of a platform. With the holos
|
|
// reference platform this takes the shape of one management cluster and at
|
|
// least two workload cluster. Each cluster has multiple [HolosComponent]
|
|
// resources applied to it.
|
|
//
|
|
// Each holos component path, e.g. `components/namespaces` produces exactly one
|
|
// [BuildPlan] which in turn contains a set of [HolosComponent] kinds.
|
|
//
|
|
// The primary kinds of [HolosComponent] are:
|
|
//
|
|
// 1. [HelmChart] to render config from a helm chart.
|
|
// 2. [KustomizeBuild] to render config from [Kustomize]
|
|
// 3. [KubernetesObjects] to render [APIObjects] defined directly in CUE
|
|
// configuration.
|
|
//
|
|
// Note that Holos operates as a data pipeline, so the output of a [HelmChart]
|
|
// may be provided to [Kustomize] for post-processing.
|
|
package v1alpha2
|
|
|
|
//go:generate ../../../hack/gendoc
|