etcd

Documentation

Overview

Package etcd provides resources which interface with etcd.

Index

• Constants
• func FormatMemberID(memberID uint64) string
• func ParseMemberID(memberID string) (uint64, error)
• 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 Member
  • func NewMember(namespace resource.Namespace, id resource.ID) *Member
• type MemberExtension
  • func (MemberExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type MemberSpec
  • func (o MemberSpec) DeepCopy() MemberSpec
• type PKIStatus
  • func NewPKIStatus(namespace resource.Namespace, id resource.ID) *PKIStatus
• type PKIStatusExtension
  • func (PKIStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type PKIStatusSpec
  • func (o PKIStatusSpec) DeepCopy() PKIStatusSpec
• type Spec
  • func NewSpec(namespace resource.Namespace, id resource.ID) *Spec
• type SpecExtension
  • func (SpecExtension) ResourceDefinition() meta.ResourceDefinitionSpec
• type SpecReadyCondition
  • func NewSpecReadyCondition(state state.State) *SpecReadyCondition
  • func (condition *SpecReadyCondition) String() string
  • func (condition *SpecReadyCondition) Wait(ctx context.Context) error
• type SpecSpec
  • func (o SpecSpec) DeepCopy() SpecSpec

Constants

const ConfigID = resource.ID("etcd")

ConfigID is resource ID for Config resource for etcd.

const ConfigType = resource.Type("EtcdConfigs.etcd.talos.dev")

ConfigType is type of Config resource.

const LocalMemberID = resource.ID("local")

LocalMemberID is resource ID for Member resource for etcd.

const MemberType = resource.Type("EtcdMembers.etcd.talos.dev")

MemberType is type of Member resource.

const NamespaceName resource.Namespace = "etcd"

NamespaceName contains resources supporting etcd service.

const PKIID = resource.ID("etcd")

PKIID is resource ID for PKIStatus resource for etcd.

const PKIStatusType = resource.Type("PKIStatuses.etcd.talos.dev")

PKIStatusType is type of PKIStatus resource.

const SpecID = resource.ID("etcd")

SpecID is resource ID for Spec resource for etcd.

const SpecType = resource.Type("EtcdSpecs.etcd.talos.dev")

SpecType is type of Spec resource.

Functions

func FormatMemberID

func FormatMemberID(memberID uint64) string

FormatMemberID represents a uint64 in hexadecimal notation.

func ParseMemberID

func ParseMemberID(memberID string) (uint64, error)

ParseMemberID converts a member ID in hexadecimal notation to a uint64.

Types

type Config

type Config = typed.Resource[ConfigSpec, ConfigExtension]

Config resource holds status of rendered secrets.

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 {
	AdvertiseValidSubnets   []string `yaml:"advertiseValidSubnets,omitempty" protobuf:"1"`
	AdvertiseExcludeSubnets []string `yaml:"advertiseExcludeSubnets" protobuf:"2"`

	ListenValidSubnets   []string `yaml:"listenValidSubnets,omitempty" protobuf:"5"`
	ListenExcludeSubnets []string `yaml:"listenExcludeSubnets" protobuf:"6"`

	Image     string            `yaml:"image" protobuf:"3"`
	ExtraArgs map[string]string `yaml:"extraArgs" protobuf:"4"`
}

ConfigSpec describes (some) configuration settings of etcd.

func (ConfigSpec) DeepCopy

func (o ConfigSpec) DeepCopy() ConfigSpec

DeepCopy generates a deep copy of ConfigSpec.

type Member

type Member = typed.Resource[MemberSpec, MemberExtension]

Member resource holds status of rendered secrets.

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 {
	MemberID string `yaml:"memberID" protobuf:"1"`
}

MemberSpec holds information about an etcd member.

func (MemberSpec) DeepCopy

func (o MemberSpec) DeepCopy() MemberSpec

DeepCopy generates a deep copy of MemberSpec.

type PKIStatus

type PKIStatus = typed.Resource[PKIStatusSpec, PKIStatusExtension]

PKIStatus resource holds status of rendered secrets.

func NewPKIStatus

func NewPKIStatus(namespace resource.Namespace, id resource.ID) *PKIStatus

NewPKIStatus initializes a PKIStatus resource.

type PKIStatusExtension

type PKIStatusExtension struct{}

PKIStatusExtension provides auxiliary methods for PKIStatus.

func (PKIStatusExtension) ResourceDefinition

func (PKIStatusExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type PKIStatusSpec

type PKIStatusSpec struct {
	Ready   bool   `yaml:"ready" protobuf:"1"`
	Version string `yaml:"version" protobuf:"2"`
}

PKIStatusSpec describes status of rendered secrets.

func (PKIStatusSpec) DeepCopy

func (o PKIStatusSpec) DeepCopy() PKIStatusSpec

DeepCopy generates a deep copy of PKIStatusSpec.

type Spec

type Spec = typed.Resource[SpecSpec, SpecExtension]

Spec resource holds status of rendered secrets.

func NewSpec

func NewSpec(namespace resource.Namespace, id resource.ID) *Spec

NewSpec initializes a Spec resource.

type SpecExtension

type SpecExtension struct{}

SpecExtension provides auxiliary methods for Spec.

func (SpecExtension) ResourceDefinition

func (SpecExtension) ResourceDefinition() meta.ResourceDefinitionSpec

ResourceDefinition implements typed.Extension interface.

type SpecReadyCondition

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

SpecReadyCondition implements condition which waits for the etcd spec to be ready.

func NewSpecReadyCondition

func NewSpecReadyCondition(state state.State) *SpecReadyCondition

NewSpecReadyCondition builds a condition which waits for the etcd spec to be ready.

func (*SpecReadyCondition) String

func (condition *SpecReadyCondition) String() string

func (*SpecReadyCondition) Wait

func (condition *SpecReadyCondition) Wait(ctx context.Context) error

Wait implements condition interface.

type SpecSpec

type SpecSpec struct {
	Name                  string            `yaml:"name" protobuf:"1"`
	AdvertisedAddresses   []netip.Addr      `yaml:"advertisedAddresses" protobuf:"2"`
	ListenPeerAddresses   []netip.Addr      `yaml:"listenPeerAddresses" protobuf:"5"`
	ListenClientAddresses []netip.Addr      `yaml:"listenClientAddresses" protobuf:"6"`
	Image                 string            `yaml:"image" protobuf:"3"`
	ExtraArgs             map[string]string `yaml:"extraArgs" protobuf:"4"`
}

SpecSpec describes (some) Specuration settings of etcd.

func (SpecSpec) DeepCopy

func (o SpecSpec) DeepCopy() SpecSpec

DeepCopy generates a deep copy of SpecSpec.