etcd

package

v0.7.0 Latest Latest Go to latest Published: Apr 14, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mirendev/runtime

Links

Open Source Insights

Documentation ¶

Overview ¶

Package etcd provides a component for managing an etcd server using containerd. The component uses host networking with non-default ports (12379 for client, 12380 for peer) to avoid conflicts with existing etcd installations.

Index ¶

type EtcdComponent
- func NewEtcdComponent(log *slog.Logger, cc *containerd.Client, namespace, dataPath string) *EtcdComponent
type EtcdConfig
type TLSConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type EtcdComponent ¶

type EtcdComponent struct {
	*base.BaseComponent
	// contains filtered or unexported fields
}

func NewEtcdComponent ¶

func NewEtcdComponent(log *slog.Logger, cc *containerd.Client, namespace, dataPath string) *EtcdComponent

func (*EtcdComponent) ClientEndpoint ¶

func (e *EtcdComponent) ClientEndpoint() string

func (*EtcdComponent) PeerEndpoint ¶

func (e *EtcdComponent) PeerEndpoint() string

func (*EtcdComponent) Start ¶

func (e *EtcdComponent) Start(ctx context.Context, config EtcdConfig) error

func (*EtcdComponent) StartMaintenanceLoop ¶ added in v0.7.0

func (e *EtcdComponent) StartMaintenanceLoop(ctx context.Context)

StartMaintenanceLoop runs a background goroutine that periodically checks etcd database health and triggers defragmentation when the BoltDB file has grown significantly larger than its live data. Compaction (already configured as periodic/1h) marks old revisions as deleted, but BoltDB never releases pages without an explicit defrag.

func (*EtcdComponent) TLSEnabled ¶ added in v0.4.0

func (e *EtcdComponent) TLSEnabled() bool

TLSEnabled returns whether TLS is enabled for client connections.

type EtcdConfig ¶

type EtcdConfig struct {
	Name           string
	DataDir        string
	ClientPort     int
	HTTPClientPort int
	PeerPort       int
	InitialToken   string
	ClusterState   string
	TLS            *TLSConfig // If set, enables mTLS for client connections
}

type TLSConfig ¶ added in v0.4.0

type TLSConfig struct {
	CertsDir string // Directory containing ca.crt, server.crt, server.key
}

TLSConfig holds TLS certificate paths for etcd mTLS. When configured, etcd will require client certificate authentication.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL