config

Documentation

Overview

Package config provides configuration types for SSH-based automation.

Index

• type NodeConfig
  • func (c NodeConfig) GetArg(key string) string
  • func (c NodeConfig) GetArgOr(key, defaultValue string) string
  • func (c NodeConfig) GetLoggerOrDefault() *slog.Logger
  • func (c NodeConfig) SSHAddr() string

Types

type NodeConfig

type NodeConfig struct {
	// SSH connection settings
	SSHHost  string
	SSHPort  string
	SSHLogin string
	SSHKey   string

	// User settings
	RootUser    string
	NonRootUser string

	// Database settings (when applicable)
	DBPort         string
	DBRootPassword string

	// Extra arguments passed via command line
	Args map[string]string

	// Logger for structured logging. Defaults to slog.Default() if nil.
	Logger *slog.Logger

	// IsDryRunMode indicates whether to simulate execution without making changes.
	// When true, ssh.Run() will log commands and return "[dry-run]" marker instead of executing.
	IsDryRunMode bool
}

NodeConfig holds all configuration variables for remote server operations.

func (NodeConfig) GetArg

func (c NodeConfig) GetArg(key string) string

GetArg retrieves an argument from the Args map. Returns empty string if not found.

func (NodeConfig) GetArgOr

func (c NodeConfig) GetArgOr(key, defaultValue string) string

GetArgOr retrieves an argument from the Args map with a default value.

func (NodeConfig) GetLoggerOrDefault

func (c NodeConfig) GetLoggerOrDefault() *slog.Logger

GetLoggerOrDefault returns the configured logger or slog.Default() if nil.

func (NodeConfig) SSHAddr

func (c NodeConfig) SSHAddr() string

SSHAddr returns the full SSH address as host:port. Defaults to port 22 if SSHPort is not set.