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 Layer
• type Manifest
• type Metadata

Variables

var AllowedPaths = []string{
	"/etc/cri/conf.d",
	"/lib/firmware",
	"/usr/etc/udev/rules.d",
	"/usr/local",
}

AllowedPaths lists paths allowed in the extension images.

Types

type Compatibility

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

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"`
}

Constraint describes compatibility constraint.

type Layer

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

Layer defines overlay mount 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"`
	Version       string        `yaml:"version"`
	Author        string        `yaml:"author"`
	Description   string        `yaml:"description"`
	Compatibility Compatibility `yaml:"compatibility"`
}

Metadata describes base extension metadata.