Documentation
¶
Overview ¶
Package schematic provides a data model for requested image schematic.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Customization ¶
type Customization struct {
// EmbeddedMachineConfiguration is the initial embedded machine configuration.
EmbeddedMachineConfiguration string `yaml:"embeddedMachineConfiguration,omitempty"`
// 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"`
// Bootloader specifies the bootloader to be used in the image.
Bootloader imageropts.BootloaderKind `yaml:"bootloader,omitempty"`
// SecureBoot represents the secure boot options for the image.
SecureBoot SecureBootCustomization `yaml:"secureboot,omitempty"`
// DiskImage represents the disk image options for the image.
DiskImage DiskImageCustomization `yaml:"diskImage,omitempty"`
}
Customization represents the Talos image customization.
type DiskImageCustomization ¶ added in v1.3.3
type DiskImageCustomization struct {
// SectorSize is the size of the disk image sector in bytes.
//
// Defaults to 512 if not set.
SectorSize uint `yaml:"sectorSize,omitempty"`
}
DiskImageCustomization represents the disk image options for the image.
type ForbiddenTag ¶ added in v1.2.0
type ForbiddenTag struct{}
ForbiddenTag is a tag for access denied errors (authenticated but not the owner).
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 ¶ added in v0.3.0
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 RequiresAuthenticationTag ¶ added in v1.2.0
type RequiresAuthenticationTag struct{}
RequiresAuthenticationTag is a tag for schematics that require authentication to access.
type Schematic ¶
type Schematic struct {
// Owner is the name (username) of the schematic owner.
//
// If owner is set, the schematic is only accessible to the owner and
// requires authentication to access.
//
// Note: this field is only supported in Enterprise edition.
Owner string `yaml:"owner,omitempty"`
// 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.
type SecureBootCustomization ¶ added in v0.5.0
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.