cluster

Documentation

Index

• Constants
• type Affiliate
  • func NewAffiliate(namespace resource.Namespace, id resource.ID) *Affiliate
• type AffiliateExtension
  • func (r AffiliateExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type AffiliateSpec
  • func (o AffiliateSpec) DeepCopy() AffiliateSpec
  • func (spec *AffiliateSpec) Merge(other *AffiliateSpec)
• 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 ControlPlane
• type Identity
  • func NewIdentity(namespace resource.Namespace, id resource.ID) *Identity
• type IdentityExtension
  • func (IdentityExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type IdentitySpec
  • func (o IdentitySpec) DeepCopy() IdentitySpec
• type Info
  • func NewInfo() *Info
• type InfoExtension
  • func (InfoExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type InfoSpec
  • func (o InfoSpec) DeepCopy() InfoSpec
• type KubeSpanAffiliateSpec
• type Member
  • func NewMember(namespace resource.Namespace, id resource.ID) *Member
• type MemberExtension
  • func (MemberExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type MemberSpec
  • func (o MemberSpec) DeepCopy() MemberSpec

Constants

const AffiliateType = resource.Type("Affiliates.cluster.talos.dev")

AffiliateType is type of Affiliate resource.

const ConfigID = resource.ID("cluster")

ConfigID the singleton config resource ID.

const ConfigType = resource.Type("DiscoveryConfigs.cluster.talos.dev")

ConfigType is type of Config resource.

const IdentityType = resource.Type("Identities.cluster.talos.dev")

IdentityType is type of Identity resource.

const InfoID = resource.ID("current")

InfoID is the resource ID for the current cluster info.

const InfoType = resource.Type("Infos.cluster.talos.dev")

InfoType is type of Info resource.

const LocalIdentity = resource.ID("local")

LocalIdentity is the resource ID for the local node identity.

const MemberType = resource.Type("Members.cluster.talos.dev")

MemberType is type of Member resource.

const NamespaceName resource.Namespace = "cluster"

NamespaceName contains resources related to cluster as a whole.

const RawNamespaceName resource.Namespace = "cluster-raw"

RawNamespaceName contains raw resources which haven't gone through the merge phase yet.

Types

type Affiliate

type Affiliate = typed.Resource[AffiliateSpec, AffiliateExtension]

Affiliate resource holds information about cluster affiliate: it is discovered potential cluster member and/or KubeSpan peer.

Controller builds local Affiliate structure for the node itself, other Affiliates are pulled from the registry during the discovery process.

func NewAffiliate

func NewAffiliate(namespace resource.Namespace, id resource.ID) *Affiliate

NewAffiliate initializes the Affiliate resource.

type AffiliateExtension

type AffiliateExtension struct{}

AffiliateExtension provides auxiliary methods for Affiliate.

func (AffiliateExtension) ResourceDefinition

func (r AffiliateExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type AffiliateSpec

type AffiliateSpec struct {
	NodeID          string                `yaml:"nodeId" protobuf:"1"`
	Addresses       []netip.Addr          `yaml:"addresses" protobuf:"2"`
	Hostname        string                `yaml:"hostname" protobuf:"3"`
	Nodename        string                `yaml:"nodename,omitempty" protobuf:"4"`
	OperatingSystem string                `yaml:"operatingSystem" protobuf:"5"`
	MachineType     machine.Type          `yaml:"machineType" protobuf:"6"`
	KubeSpan        KubeSpanAffiliateSpec `yaml:"kubespan,omitempty" protobuf:"7"`
	ControlPlane    *ControlPlane         `yaml:"controlPlane,omitempty" protobuf:"8"`
}

AffiliateSpec describes Affiliate state.

func (AffiliateSpec) DeepCopy

func (o AffiliateSpec) DeepCopy() AffiliateSpec

DeepCopy generates a deep copy of AffiliateSpec.

func (*AffiliateSpec) Merge

func (spec *AffiliateSpec) Merge(other *AffiliateSpec)

Merge two AffiliateSpecs.

type Config

type Config = typed.Resource[ConfigSpec, ConfigExtension]

Config resource holds KubeSpan 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 {
	DiscoveryEnabled          bool   `yaml:"discoveryEnabled" protobuf:"1"`
	RegistryKubernetesEnabled bool   `yaml:"registryKubernetesEnabled" protobuf:"2"`
	RegistryServiceEnabled    bool   `yaml:"registryServiceEnabled" protobuf:"3"`
	ServiceEndpoint           string `yaml:"serviceEndpoint" protobuf:"4"`
	ServiceEndpointInsecure   bool   `yaml:"serviceEndpointInsecure,omitempty" protobuf:"5"`
	ServiceEncryptionKey      []byte `yaml:"serviceEncryptionKey" protobuf:"6"`
	ServiceClusterID          string `yaml:"serviceClusterID" protobuf:"7"`
}

ConfigSpec describes KubeSpan configuration.

func (ConfigSpec) DeepCopy

func (o ConfigSpec) DeepCopy() ConfigSpec

DeepCopy generates a deep copy of ConfigSpec.

type ControlPlane

type ControlPlane struct {
	APIServerPort int `yaml:"port" protobuf:"1"`
}

ControlPlane describes ControlPlane data if any.

type Identity

type Identity = typed.Resource[IdentitySpec, IdentityExtension]

Identity resource holds node identity (as a member of the cluster).

func NewIdentity

func NewIdentity(namespace resource.Namespace, id resource.ID) *Identity

NewIdentity initializes a Identity resource.

type IdentityExtension

type IdentityExtension struct{}

IdentityExtension provides auxiliary methods for Identity.

func (IdentityExtension) ResourceDefinition

func (IdentityExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type IdentitySpec

type IdentitySpec struct {
	// NodeID is a random value which is persisted across reboots,
	// but it gets reset on wipe.
	NodeID string `yaml:"nodeId" protobuf:"1"`
}

IdentitySpec describes status of rendered secrets.

Note: IdentitySpec is persisted on disk in the STATE partition, so YAML serialization should be kept backwards compatible.

func (IdentitySpec) DeepCopy

func (o IdentitySpec) DeepCopy() IdentitySpec

DeepCopy generates a deep copy of IdentitySpec.

type Info

type Info = typed.Resource[InfoSpec, InfoExtension]

Info resource holds cluster information.

func NewInfo

func NewInfo() *Info

NewInfo initializes an Info resource.

type InfoExtension

type InfoExtension struct{}

InfoExtension provides auxiliary methods for Info.

func (InfoExtension) ResourceDefinition

func (InfoExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type InfoSpec

type InfoSpec struct {
	ClusterID   string `yaml:"clusterId" protobuf:"1"`
	ClusterName string `yaml:"clusterName" protobuf:"2"`
}

InfoSpec describes cluster information.

func (InfoSpec) DeepCopy

func (o InfoSpec) DeepCopy() InfoSpec

DeepCopy generates a deep copy of InfoSpec.

type KubeSpanAffiliateSpec

type KubeSpanAffiliateSpec struct {
	PublicKey           string           `yaml:"publicKey" protobuf:"1"`
	Address             netip.Addr       `yaml:"address" protobuf:"2"`
	AdditionalAddresses []netip.Prefix   `yaml:"additionalAddresses" protobuf:"3"`
	Endpoints           []netip.AddrPort `yaml:"endpoints" protobuf:"4"`
}

KubeSpanAffiliateSpec describes additional information specific for the KubeSpan.

type Member

type Member = typed.Resource[MemberSpec, MemberExtension]

Member resource contains information about discovered cluster members.

Members are usually derived from Affiliates.

func NewMember

func NewMember(namespace resource.Namespace, id resource.ID) *Member

NewMember initializes a Member resource.

type MemberExtension

type MemberExtension struct{}

MemberExtension provides auxiliary methods for Member.

func (MemberExtension) ResourceDefinition

func (MemberExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type MemberSpec

type MemberSpec struct {
	NodeID          string        `yaml:"nodeId" protobuf:"1"`
	Addresses       []netip.Addr  `yaml:"addresses" protobuf:"2"`
	Hostname        string        `yaml:"hostname" protobuf:"3"`
	MachineType     machine.Type  `yaml:"machineType" protobuf:"4"`
	OperatingSystem string        `yaml:"operatingSystem" protobuf:"5"`
	ControlPlane    *ControlPlane `yaml:"controlPlane,omitempty" protobuf:"6"`
}

MemberSpec describes Member state.

func (MemberSpec) DeepCopy

func (o MemberSpec) DeepCopy() MemberSpec

DeepCopy generates a deep copy of MemberSpec.