cluster

package

v0.35.0 Latest Latest Go to latest Published: May 3, 2026 License: MIT Imports: 14 Imported by: 0

Details

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

Repository

github.com/VitruvianSoftware/devx

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cluster orchestrates the full lifecycle of a homelab K8s cluster. It coordinates Lima VM provisioning, K3s installation, and cluster operations across multiple remote macOS hosts.

Index ¶

func Apply(ctx context.Context, cfg *config.Config, dryRun bool) error
func Backup(ctx context.Context, cfg *config.Config, outputDir string) error
func Destroy(ctx context.Context, cfg *config.Config, force, dryRun bool) error
func Init(ctx context.Context, cfg *config.Config, opts InitOptions) error
func Join(ctx context.Context, cfg *config.Config, dryRun bool) error
func Remove(ctx context.Context, cfg *config.Config, hostName string, dryRun bool) error
func Restore(ctx context.Context, cfg *config.Config, snapshotPath string) error
func Status(ctx context.Context, cfg *config.Config) error
func Upgrade(ctx context.Context, cfg *config.Config, dryRun bool) error
type InitOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Apply ¶

func Apply(ctx context.Context, cfg *config.Config, dryRun bool) error

Apply iterates over all nodes in the cluster, gracefully rolling updates to VM configurations (CPUs, Memory) one at a time to ensure zero downtime.

func Backup ¶

func Backup(ctx context.Context, cfg *config.Config, outputDir string) error

Backup creates an etcd snapshot on the init node and downloads it locally.

func Destroy ¶

func Destroy(ctx context.Context, cfg *config.Config, force, dryRun bool) error

Destroy tears down the entire cluster.

func Init ¶

func Init(ctx context.Context, cfg *config.Config, opts InitOptions) error

Init bootstraps a new cluster from scratch. It is idempotent.

func Join ¶

func Join(ctx context.Context, cfg *config.Config, dryRun bool) error

Join adds nodes that are in the config but not yet in the cluster.

func Remove ¶

func Remove(ctx context.Context, cfg *config.Config, hostName string, dryRun bool) error

Remove drains and removes a specific node from the cluster.

func Restore ¶

func Restore(ctx context.Context, cfg *config.Config, snapshotPath string) error

Restore restores etcd from a snapshot file.

func Status ¶

func Status(ctx context.Context, cfg *config.Config) error

Status displays the current state of all configured nodes.

func Upgrade ¶

func Upgrade(ctx context.Context, cfg *config.Config, dryRun bool) error

Upgrade performs a rolling upgrade of K3s across all nodes. Agents are upgraded first, then servers one at a time to maintain quorum.

Types ¶

type InitOptions ¶

type InitOptions struct {
	DryRun      bool
	AutoInstall bool
}

InitOptions configures the Init operation.

Source Files ¶

View all Source files

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