models

type BackupConfiguration struct {
	// Interval configures intervals between backups. If set to 0, etcd backups for this cluster are disabled.
	Interval time.Duration `yaml:"interval,omitempty"`
}

type BootstrapSpec struct {
	// ClusterUUID defines the UUID of the cluster to restore from.
	ClusterUUID string `yaml:"clusterUUID"`

	// Snapshot defines the snapshot file name to restore from.
	Snapshot string `yaml:"snapshot"`
}

type Cluster struct {
	Meta `yaml:",inline"`

	// SystemExtensions are the system extensions to install on the machines of the cluster.
	SystemExtensions OptionalList `yaml:"systemExtensions,omitempty"`

	// Name is the name of the cluster.
	Name string `yaml:"name"`

	// Descriptors are the user descriptors to apply to the cluster.
	Descriptors Descriptors `yaml:",inline"`

	// Kubernetes settings.
	Kubernetes KubernetesCluster `yaml:"kubernetes"`

	// Talos settings.
	Talos TalosCluster `yaml:"talos"`

	// Features settings.
	Features Features `yaml:"features,omitempty"`

	// Cluster-wide patches.
	Patches PatchList `yaml:"patches,omitempty"`

	// KernelArgs are the additional kernel arguments.
	KernelArgs OptionalList `yaml:"kernelArgs,omitempty"`
}

type ControlPlane struct {
	MachineSet `yaml:",inline"`
}

type Descriptors struct {
	// Labels are the user labels to apply to the resource.
	Labels map[string]string `yaml:"labels,omitempty"`

	// Annotations are the user annotations to apply to the resource.
	Annotations map[string]string `yaml:"annotations,omitempty"`
}

type Features struct {
	// DiskEncryption enables KMS encryption.
	DiskEncryption bool `yaml:"diskEncryption,omitempty"`
	// EnableWorkloadProxy enables workload proxy.
	EnableWorkloadProxy bool `yaml:"enableWorkloadProxy,omitempty"`
	// UseEmbeddedDiscoveryService enables the use of embedded discovery service.
	UseEmbeddedDiscoveryService bool `yaml:"useEmbeddedDiscoveryService,omitempty"`
	// BackupConfiguration contains backup configuration settings.
	BackupConfiguration BackupConfiguration `yaml:"backupConfiguration,omitempty"`
}

type FileContext struct {
	// Root restricts file access to a single directory tree. When nil, no restriction is applied.
	Root *os.Root
	// Dir is the directory used to resolve relative file paths from the template.
	// When empty, callers should treat it as "." (for example, for non-file-backed templates).
	Dir string
}

type InlineContent struct {
	// contains filtered or unexported fields
}

type KubernetesCluster struct {
	// Version is the Kubernetes version.
	Version string `yaml:"version"`
	// Manifests allow defining Kubernetes manifests to be applied to the deployed Omni cluster.
	Manifests KubernetesManifestsList `yaml:"manifests,omitempty"`
	// Healthchecks are advanced healthcheck definitions deployed into the cluster.
	Healthchecks KubernetesHealthCheckList `yaml:"healthchecks,omitempty"`
}

type KubernetesHealthCheck struct {
	// Descriptors are the user descriptors to apply to the resource.
	Descriptors Descriptors `yaml:",inline"`

	// IDOverride overrides the generated resource ID. When set, the prefix is ignored.
	IDOverride string `yaml:"idOverride,omitempty"`

	// Name of the healthcheck, used to derive the resource ID.
	Name string `yaml:"name,omitempty"`

	// Job is the inline Kubernetes Job manifest Omni runs to perform the healthcheck. Mutually exclusive with File.
	Job *InlineContent `yaml:"job,omitempty"`

	// File is the path to a file whose contents are used as the Job manifest. Mutually exclusive with Job.
	File string `yaml:"file,omitempty"`

	// Interval is how often Omni re-checks while it is holding an upgrade. If not set, a default interval of
	// 30s is used.
	Interval time.Duration `yaml:"interval,omitempty"`
}

type KubernetesHealthCheckList []KubernetesHealthCheck

type KubernetesManifest struct {
	Inline      *InlineContent         `yaml:"inline,omitempty"`
	Descriptors Descriptors            `yaml:",inline"`
	Name        string                 `yaml:"name"`
	File        string                 `yaml:"file,omitempty"`
	Mode        KubernetesManifestMode `yaml:"mode"`
}

type KubernetesManifestMode specs.KubernetesManifestGroupSpec_Mode

type KubernetesManifestsList []KubernetesManifest

type List []Model

type Machine struct {
	Meta `yaml:",inline"`

	// SystemExtensions are the system extensions to install on the machine.
	SystemExtensions OptionalList `yaml:"systemExtensions,omitempty"`

	// Machine name (ID).
	Name MachineID `yaml:"name"`

	// Descriptors are the user descriptors to apply to the cluster.
	Descriptors Descriptors `yaml:",inline"`

	// Locked locks the machine, so no config updates, upgrades and downgrades will be performed on the machine.
	Locked bool `yaml:"locked,omitempty"`

	// Install specification.
	Install MachineInstall `yaml:"install,omitempty"`

	// ClusterMachine patches.
	Patches PatchList `yaml:"patches,omitempty"`

	// KernelArgs are the additional kernel arguments.
	KernelArgs OptionalList `yaml:"kernelArgs,omitempty"`
}

type MachineClassConfig struct {
	// Name defines used machine class name.
	Name string `yaml:"name"`

	// Size sets the number of machines to be pulled from the machine class.
	Size Size `yaml:"size"`
}

type MachineID string

type MachineIDList []MachineID

type MachineInstall struct {
	// Disk device name.
	Disk string `yaml:"disk"`
}

type MachineSet struct {
	Meta `yaml:",inline"`

	// SystemExtensions are the system extensions to install on the machines of the machine set.
	SystemExtensions OptionalList `yaml:"systemExtensions,omitempty"`

	// Name is the name of the machine set. When empty, the default name will be used.
	Name string `yaml:"name,omitempty"`

	// Descriptors are the user descriptors to apply to the cluster.
	Descriptors Descriptors `yaml:",inline"`

	BootstrapSpec *BootstrapSpec `yaml:"bootstrapSpec,omitempty"`

	// MachineSet machines.
	Machines MachineIDList `yaml:"machines,omitempty"`

	MachineClass *MachineClassConfig `yaml:"machineClass,omitempty"`

	// UpdateStrategy defines the update strategy for the machine set.
	UpdateStrategy *UpdateStrategyConfig `yaml:"updateStrategy,omitempty"`

	// DeleteStrategy defines the delete strategy for the machine set.
	DeleteStrategy *UpdateStrategyConfig `yaml:"deleteStrategy,omitempty"`

	// UpgradeStrategy defines the upgrade strategy for the machine set.
	UpgradeStrategy *UpdateStrategyConfig `yaml:"upgradeStrategy,omitempty"`

	// MachineSet patches.
	Patches PatchList `yaml:"patches,omitempty"`

	// KernelArgs are the additional kernel arguments.
	KernelArgs OptionalList `yaml:"kernelArgs,omitempty"`
}

type Meta struct {
	Kind string `yaml:"kind"`
}

type Model interface {
	Validate(ValidateOptions) error
	Translate(TranslateContext) ([]resource.Resource, error)
}

type OptionalList struct {
	// contains filtered or unexported fields
}

type Patch struct {
	// Name of the patch.
	//
	// Optional for 'path' patches, mandatory for 'inline' patches if idOverride is not set.
	Name string `yaml:"name,omitempty"`

	// IDOverride overrides the ID of the patch. When set, the ID will not be generated using the name and/or the file path.
	IDOverride string `yaml:"idOverride,omitempty"`

	// Descriptors are the user descriptors to apply to the resource.
	Descriptors Descriptors `yaml:",inline"`

	// File path to the file containing the patch.
	//
	// Mutually exclusive with `inline:`.
	File string `yaml:"file,omitempty"`

	// Inline patch content.
	Inline *InlineContent `yaml:"inline,omitempty"`
}

type PatchList []Patch

type RollingUpdateStrategyConfig struct {
	MaxParallelism uint32 `yaml:"maxParallelism,omitempty"`
}

type Size struct {
	Value          uint32
	AllocationType specs.MachineSetSpec_MachineAllocation_Type
}

type TalosCluster struct {
	// Version is the Talos version.
	Version string `yaml:"version"`
}

type TranslateContext struct {
	FileContext
	LockedMachines            map[MachineID]struct{}
	MachineDescriptors        map[MachineID]Descriptors
	MachineSetLevelKernelArgs map[MachineID]OptionalList
	ClusterName               string
	ClusterLevelKernelArgs    OptionalList
}

type UpdateStrategyConfig struct {
	Type    *UpdateStrategyType          `yaml:"type,omitempty"`
	Rolling *RollingUpdateStrategyConfig `yaml:"rolling,omitempty"`
}

type UpdateStrategyType uint32

type ValidateOptions struct {
	FileContext
}

type Workers struct {
	MachineSet `yaml:",inline"`
}