meta

Documentation

Overview

Package meta provides access to META partition: key-value partition persisted across reboots.

Index

• Constants
• type Meta
  • func New(ctx context.Context, st state.State, opts ...Option) (*Meta, error)
  • func (meta *Meta) DeleteTag(ctx context.Context, t uint8) (bool, error)
  • func (meta *Meta) Flush() error
  • func (meta *Meta) ReadTag(t uint8) (val string, ok bool)
  • func (meta *Meta) ReadTagBytes(t uint8) (val []byte, ok bool)
  • func (meta *Meta) Reload(ctx context.Context) error
  • func (meta *Meta) SetTag(ctx context.Context, t uint8, val string) (bool, error)
  • func (meta *Meta) SetTagBytes(ctx context.Context, t uint8, val []byte) (bool, error)
• type Option
  • func WithFixedPath(path string) Option
  • func WithPrinter(printer func(string, ...any)) Option
• type Options

Constants

const (
	// Upgrade is the upgrade tag.
	Upgrade = iota + 6
	// StagedUpgradeImageRef stores image reference for staged upgrade.
	StagedUpgradeImageRef
	// StagedUpgradeInstallOptions stores JSON-serialized install.Options.
	StagedUpgradeInstallOptions
	// StateEncryptionConfig stores JSON-serialized v1alpha1.Encryption.
	StateEncryptionConfig
	// MetalNetworkPlatformConfig stores serialized NetworkPlatformConfig for the `metal` platform.
	MetalNetworkPlatformConfig
	// DownloadURLCode stores the value of the `${code}` variable in the download URL for talos.config= URL.
	DownloadURLCode
	// UserReserved1 is reserved for user-defined metadata.
	UserReserved1
	// UserReserved2 is reserved for user-defined metadata.
	UserReserved2
	// UserReserved3 is reserved for user-defined metadata.
	UserReserved3
	// UUIDOverride stores the UUID that this machine will use instead of the one from the hardware.
	UUIDOverride
	// UniqueMachineToken store the unique token for this machine. It's useful because UUID may repeat or be filled with zeros.
	UniqueMachineToken
)

Types

type Meta

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

Meta represents the META reader/writer.

Meta abstracts away all details about loading/storing the metadata providing an easy to use interface.

func New

func New(ctx context.Context, st state.State, opts ...Option) (*Meta, error)

New initializes empty META, trying to probe the existing META first.

func (*Meta) DeleteTag

func (meta *Meta) DeleteTag(ctx context.Context, t uint8) (bool, error)

DeleteTag deletes a tag from the META.

func (*Meta) Flush

func (meta *Meta) Flush() error

Flush writes the META to the disk.

func (*Meta) ReadTag

func (meta *Meta) ReadTag(t uint8) (val string, ok bool)

ReadTag reads a tag from the META.

func (*Meta) ReadTagBytes

func (meta *Meta) ReadTagBytes(t uint8) (val []byte, ok bool)

ReadTagBytes reads a tag from the META.

func (*Meta) Reload

func (meta *Meta) Reload(ctx context.Context) error

Reload refreshes the META from the disk.

func (*Meta) SetTag

func (meta *Meta) SetTag(ctx context.Context, t uint8, val string) (bool, error)

SetTag writes a tag to the META.

func (*Meta) SetTagBytes

func (meta *Meta) SetTagBytes(ctx context.Context, t uint8, val []byte) (bool, error)

SetTagBytes writes a tag to the META.

type Option

type Option func(*Options)

Option is a functional option.

func WithFixedPath

func WithFixedPath(path string) Option

WithFixedPath sets the fixed path to META partition.

func WithPrinter

func WithPrinter(printer func(string, ...any)) Option

WithPrinter sets the function to print the logs, default is log.Printf.

type Options

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

Options configures the META.