extensions

Documentation

Overview

Package extensions contains Talos extensions specific API.

Index

• Variables
• type Compatibility
• type Config
  • func (cfg *Config) Read(path string) error
  • func (cfg *Config) Write(path string) error
• type Constraint
• type Extension
  • func Load(path string) (*Extension, error)
  • func New(rootfsPath, directory string, manifest Manifest) *Extension
  • func (ext *Extension) Directory() string
  • func (ext *Extension) RootfsPath() string
  • func (ext *Extension) Validate() error
• type Layer
  • func (o Layer) DeepCopy() Layer
• type Manifest
• type Metadata

Variables

var AllowedPaths = []string{
	"/etc/cri/conf.d",
	"/lib/firmware",
	"/lib/modules",
	"/lib64/ld-linux-x86-64.so.2",
	"/usr/etc/udev/rules.d",
	"/usr/local",

	"/usr/share/glvnd",
	"/usr/share/egl",
	"/etc/vulkan",
}

AllowedPaths lists paths allowed in the extension images.

Types

type Compatibility

type Compatibility struct {
	Talos Constraint `yaml:"talos" protobuf:"1"`
}

Compatibility describes extension compatibility.

type Config

type Config struct {
	Layers []*Layer `yaml:"layers"`
}

Config specifies Talos installer extensions configuration.

func (*Config) Read

func (cfg *Config) Read(path string) error

Read extensions config from a file.

func (*Config) Write

func (cfg *Config) Write(path string) error

Write extensions config to a file.

type Constraint

type Constraint struct {
	Version string `yaml:"version" protobuf:"1"`
}

Constraint describes compatibility constraint.

type Extension

type Extension struct {
	Manifest Manifest
	// contains filtered or unexported fields
}

Extension represents unpacked extension in the filesystem.

func Load

func Load(path string) (*Extension, error)

Load extension from the filesystem.

This performs initial validation of the extension file structure.

func New

func New(rootfsPath, directory string, manifest Manifest) *Extension

New creates a new extension from the rootfs path, directory name and manifest.

func (*Extension) Directory

func (ext *Extension) Directory() string

Directory returns the directory name of the extension.

func (*Extension) RootfsPath

func (ext *Extension) RootfsPath() string

RootfsPath returns the path to the rootfs directory.

func (*Extension) Validate

func (ext *Extension) Validate() error

Validate the extension: compatibility, contents, etc.

type Layer

type Layer struct {
	Image    string   `yaml:"image" protobuf:"1"`
	Metadata Metadata `yaml:"metadata" protobuf:"2"`
}

Layer defines overlay mount layer.

func (Layer) DeepCopy

func (o Layer) DeepCopy() Layer

DeepCopy generates a deep copy of Layer.

type Manifest

type Manifest struct {
	Version  string   `yaml:"version"`
	Metadata Metadata `yaml:"metadata"`
}

Manifest is the structure of the extension manifest.yaml file.

type Metadata

type Metadata struct {
	Name          string        `yaml:"name" protobuf:"1"`
	Version       string        `yaml:"version" protobuf:"2"`
	Author        string        `yaml:"author" protobuf:"3"`
	Description   string        `yaml:"description" protobuf:"4"`
	Compatibility Compatibility `yaml:"compatibility" protobuf:"5"`
	ExtraInfo     string        `yaml:"extraInfo,omitempty" protobuf:"6"`
}

Metadata describes base extension metadata.