siderolink

Documentation

Overview

Package siderolink contains SideroLink-related resources.

Index

• Constants
• type Config
  • func NewConfig(namespace resource.Namespace, id resource.ID) *Config
• type ConfigExtension
  • func (ConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type ConfigSpec
  • func (o ConfigSpec) DeepCopy() ConfigSpec
• type Status
  • func NewStatus() *Status
• type StatusExtension
  • func (StatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type StatusSpec
  • func (o StatusSpec) DeepCopy() StatusSpec
• type Tunnel
  • func NewTunnel() *Tunnel
• type TunnelExtension
  • func (TunnelExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type TunnelSpec
  • func (o TunnelSpec) DeepCopy() TunnelSpec

Constants

const ConfigID = resource.ID("siderolink")

ConfigID the singleton config resource ID.

const ConfigType = resource.Type("SiderolinkConfigs.siderolink.talos.dev")

ConfigType is type of Config resource.

const StatusID = resource.ID("siderolink-status")

StatusID the singleton status resource ID.

const StatusType = resource.Type("SiderolinkStatuses.siderolink.talos.dev")

StatusType is the type of Status resource.

const TunnelID = resource.ID("siderolink-tunnel")

TunnelID the singleton tunnel resource ID.

const TunnelType = resource.Type("SiderolinkTunnels.siderolink.talos.dev")

TunnelType is type of Tunnel resource.

Types

type Config

type Config = typed.Resource[ConfigSpec, ConfigExtension]

Config resource holds Siderolink configuration.

func NewConfig

func NewConfig(namespace resource.Namespace, id resource.ID) *Config

NewConfig initializes a Config resource.

type ConfigExtension

type ConfigExtension struct{}

ConfigExtension provides auxiliary methods for Config.

func (ConfigExtension) ResourceDefinition

func (ConfigExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type ConfigSpec

type ConfigSpec struct {
	APIEndpoint string `yaml:"apiEndpoint" protobuf:"1"`
	Host        string `yaml:"host" protobuf:"2"`
	JoinToken   string `yaml:"joinToken" protobuf:"3"`
	Insecure    bool   `yaml:"insecure" protobuf:"4"`
	Tunnel      bool   `yaml:"tunnel" protobuf:"5"`
}

ConfigSpec describes Siderolink configuration.

func (ConfigSpec) DeepCopy

func (o ConfigSpec) DeepCopy() ConfigSpec

DeepCopy generates a deep copy of ConfigSpec.

type Status

type Status = typed.Resource[StatusSpec, StatusExtension]

Status resource holds Siderolink status.

func NewStatus

func NewStatus() *Status

NewStatus initializes a Status resource.

type StatusExtension

type StatusExtension struct{}

StatusExtension provides auxiliary methods for Status.

func (StatusExtension) ResourceDefinition

func (StatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type StatusSpec

type StatusSpec struct {
	// Host is the Siderolink target host.
	Host string `yaml:"host" protobuf:"1"`
	// Connected is the status of the Siderolink GRPC connection.
	Connected bool `yaml:"connected" protobuf:"2"`
}

StatusSpec describes Siderolink status.

func (StatusSpec) DeepCopy

func (o StatusSpec) DeepCopy() StatusSpec

DeepCopy generates a deep copy of StatusSpec.

type Tunnel

type Tunnel = typed.Resource[TunnelSpec, TunnelExtension]

Tunnel resource holds Siderolink GRPC Tunnel configuration.

func NewTunnel

func NewTunnel() *Tunnel

NewTunnel initializes a Config resource.

type TunnelExtension

type TunnelExtension struct{}

TunnelExtension provides auxiliary methods for Tunnel.

func (TunnelExtension) ResourceDefinition

func (TunnelExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type TunnelSpec

type TunnelSpec struct {
	// APIEndpoint is the Siderolink WireGuard over GRPC endpoint.
	APIEndpoint string `yaml:"apiEndpoint" protobuf:"1"`
	// LinkName is the name to use for WireGuard tunnel.
	LinkName string `yaml:"linkName" protobuf:"2"`
	// MTU is the maximum transmission unit for the tunnel.
	MTU int `yaml:"mtu" protobuf:"3"`
	// NodeAddress is the virtual address of our node. It's used to identify our node in the WireGuard GRPC streamer.
	// It's not the address of the actual WireGuard interface.
	NodeAddress netip.AddrPort `yaml:"nodeAddress" protobuf:"4"`
}

TunnelSpec describes Siderolink GRPC Tunnel configuration.

func (TunnelSpec) DeepCopy

func (o TunnelSpec) DeepCopy() TunnelSpec

DeepCopy generates a deep copy of TunnelSpec.