schematic

Documentation

Overview

Package schematic provides a data model for requested image schematic.

Index

• type Customization
• type InvalidErrorTag
• type MetaValue
• type Overlay
• type Schematic
  • func Unmarshal(data []byte) (*Schematic, error)
  • func (cfg *Schematic) ID() (string, error)
  • func (cfg *Schematic) Marshal() ([]byte, error)
• type SecureBootCustomization
• type SystemExtensions

Types

type Customization

type Customization struct {
	// Extra kernel arguments to be passed to the kernel.
	ExtraKernelArgs []string `yaml:"extraKernelArgs,omitempty"`
	// Meta provides initial META contents for the image.
	Meta []MetaValue `yaml:"meta,omitempty"`
	// SystemExtensions represents the Talos system extensions to be installed.
	SystemExtensions SystemExtensions `yaml:"systemExtensions,omitempty"`
	// SecureBoot represents the secure boot options for the image.
	SecureBoot SecureBootCustomization `yaml:"secureboot,omitempty"`
}

Customization represents the Talos image customization.

type InvalidErrorTag

type InvalidErrorTag struct{}

InvalidErrorTag is a tag for invalid schematic errors.

type MetaValue

type MetaValue struct {
	// Key is the META key.
	Key uint8 `yaml:"key"`
	// Value is the META value.
	Value string `yaml:"value"`
}

MetaValue provides initial META contents for the image.

type Overlay

type Overlay struct {
	Image   string         `yaml:"image"`
	Name    string         `yaml:"name"`
	Options map[string]any `yaml:"options,omitempty"`
}

Overlay represents the overlay options for image generation.

type Schematic

type Schematic struct {
	// Overlay represents the overlay options for image generation.
	Overlay Overlay `yaml:"overlay,omitempty"`
	// Customization represents the Talos image customization.
	Customization Customization `yaml:"customization"`
}

Schematic represents the requested image customization.

func Unmarshal

func Unmarshal(data []byte) (*Schematic, error)

Unmarshal the schematic from text representation.

func (*Schematic) ID

func (cfg *Schematic) ID() (string, error)

ID returns the identifier of the schematic.

ID is stable (does not change if the schematic is same). ID matches sha256 hash of the canonical representation of the schematic.

func (*Schematic) Marshal

func (cfg *Schematic) Marshal() ([]byte, error)

Marshal the schematic to text representation.

Marshal result should be stable if new schematic fields are added.

type SecureBootCustomization

type SecureBootCustomization struct {
	// Include well-known UEFI certificates in the auto-enrollment database.
	IncludeWellKnownCertificates bool `yaml:"includeWellKnownCertificates,omitempty"`
}

SecureBootCustomization represents the secure boot options for the image.

type SystemExtensions

type SystemExtensions struct {
	// OfficialExtensions represents the Talos official system extensions to be installed.
	//
	// The image factory will pick up automatically the version compatible with Talos version.
	OfficialExtensions []string `yaml:"officialExtensions,omitempty"`
}

SystemExtensions represents the Talos system extensions to be installed.