distrocfg

type AdminCredentials struct {
	// CertificateAuthority is the CA certificate the API server's serving cert is signed with
	CertificateAuthority []byte
	// ClientCertificate is the admin client certificate
	ClientCertificate []byte
	// ClientKey is the key for ClientCertificate
	ClientKey []byte
}

type Common struct {
	// Binary name of the engine binary
	Binary string
	// BinaryDir where the engine binary is stored in
	BinaryDir string
	// Config where the engine config is located
	Config string
	// Data where the engine data is located
	Data string
	// ID the id used to identify the distro
	ID string
	// PackageDir where staged .rpm/.deb package files are uploaded to. Empty means DataDirPath
	// doubles as the staging directory -- see PackageStagingDir.
	PackageDir string
	// ServiceController the controller service
	ServiceController string
	// ServiceWorker the worker service
	ServiceWorker string
	// Token the token path
	Token string
}

type DesiredFile struct {
	// Content is the full desired content of the file.
	Content []byte
	// Mode is the file mode as chmod spells it, e.g. "0600".
	Mode string
	// NoRestart indicates changes to this file do not require draining or restarting the engine.
	NoRestart bool
}

type Distro interface {
	// AdminCredentials returns the cluster CA certificate and the admin client key pair
	// for a given controller host and data directory
	AdminCredentials(*cluster.ZarfHost, string) (AdminCredentials, error)
	// BinaryName returns the engine binary name
	BinaryName() string
	// BinaryPath returns the full path to the engine binary
	BinaryPath() string
	// CleanupPaths returns every path on a host the engine owns outright, for an uninstall
	// to remove recursively. Paths that are unset or too broad to safely remove are left out.
	CleanupPaths() []string
	// ConfigPath returns the full path for the config directory used by the engine
	ConfigPath() string
	// ConfigureEngine does distro specific configuration on a host
	ConfigureEngine(context.Context, *cluster.ZarfHost, cluster.ZarfRuntimeMeta, distro.ZarfDistro) error
	// DataDirPath returns the full path for the data directory used by the engine
	DataDirPath() string
	// DesiredFiles returns the full set of engine config files (path -> desired file) this
	// distro would write for the given host/run/dis state -- e.g. registries.yaml, audit.yaml,
	// pss.yaml -- used both to pre-seed a fresh host and, by the engine-config-sync phases, to
	// detect drift on an already-running host.
	DesiredFiles(*cluster.ZarfHost, cluster.ZarfRuntimeMeta, distro.ZarfDistro) (map[string]DesiredFile, error)
	// ManagedDirs returns the directories on a host cargoship prunes, so that a file in one of
	// them that DesiredFiles no longer names can be removed rather than left behind. A
	// directory cargoship shares with the engine names the files that are its own. A distro
	// that keeps no such directory returns nil.
	ManagedDirs() []ManagedDir
	// PackageStagingDir returns the directory staged .rpm/.deb package files are uploaded to,
	// so the uninstall phase knows where to recover installed package names from. A distro that
	// installs from a single binary rather than staged package files shares this with
	// DataDirPath, since nothing else uses the value.
	PackageStagingDir() string
	// DistroCmdf returns a string that can be used to execute commands on the core engine binary
	DistroCmdf(string, ...any) string
	// GetClusterCIDR returns a string array with the all the known cluster cidr blocks
	GetClusterCIDR(distro.ZarfDistro) []string
	// GetControllerService returns the name of the controller service
	GetControllerService() string
	// GetWorkerService returns the name of the worker service
	GetWorkerService() string
	// JoinTokenPath returns the path of the token to join the cluster
	JoinTokenPath() string
	// JoinTokenPathAgent returns the path of the token to join the cluster.
	// Distro's like RKE2 and K3S allow for agent tokens, so this allows for some level of access control if a node is allowed to be a controller or an agent.
	JoinTokenPathAgent() string
	// KubeconfigPath returns the path to the admin config for a given
	KubeconfigPath(*cluster.ZarfHost, string) string
	// KubectlCmdf returns a string with that can be executed to interact with the kubernetes cluster
	KubectlCmdf(*cluster.ZarfHost, string, string, ...any) string
	// RunningVersion returns the version of the distro being ran, if the engine is not running it throws an "ErrVersionNotDetected" error
	RunningVersion(*cluster.ZarfHost) (string, error)
	// SetPath takes in a key value pair to change how the distro values are configured, if a key is not valid it will throw an "ErrPathKey" error
	SetPath(key string, value string) error
	// StopControllerService stops the controller service on the host
	StopControllerService(*cluster.ZarfHost) error
	// StopWorkerService stops the controller service on the host
	StopWorkerService(*cluster.ZarfHost) error
}

type K3S struct {
	RancherCommon
}

type ManagedDir struct {
	// Path is the directory on the host.
	Path string
	// Glob limits pruning to the file names it matches, for a directory cargoship shares with
	// something else. An empty Glob means every file in the directory is cargoship's.
	//
	// The engine's manifest directory is the case this exists for: cargoship writes the
	// HelmChartConfig files in it, while the engine ships its own charts there, and removing
	// those would take the cluster apart.
	Glob string
}

type RKE2 struct {
	RancherCommon
}

type RancherCommon struct {
	Common
}

type Upstream struct {
	Common
}