driver

type Deps ¶

type Deps struct {
	Paths  *config.Paths
	Runner execx.Runner
	Stderr io.Writer

	// Provider is the loaded infrastructure provider (bash: the sourced
	// provider:: functions), nil when none was loaded.
	Provider Provider
	// ProviderName is the loaded provider's name (bash: PROVIDER_NAME).
	ProviderName string
	// ProviderConfigFile is the resolved provider config path (bash:
	// PROVIDER_CONFIG_FILE — a configRef file or an inline-config temp file).
	ProviderConfigFile string
}

Deps is what the dispatch hands a driver factory. Provider fields are nil or empty until the dispatch loads a provider (bash sources the provider into globals AFTER sourcing the driver; the shared pointer mirrors that — the dispatch may fill the provider fields after construction, before Provision runs).

type Driver ¶

type Driver interface {
	Provision(ctx context.Context, domain string) error
	Destroy(ctx context.Context, domain string) error
	Status(ctx context.Context, domain string) (string, error)
	Kubeconfig(ctx context.Context, domain string) (string, error)
}

Driver is the required contract (bash: driver::provision, driver::destroy, driver::status, driver::kubeconfig).

Status returns the single status word the bash contract printed to stdout ("Running", "NotFound", "Healthy", "Degraded", "NotProvisioned", "Unknown", …) — the dispatch prints it.

Kubeconfig returns the path of the cluster's kubeconfig under .kubeconfig/ (materializing it first when the driver can).

type ExitError ¶

type ExitError struct {
	Code int
	Err  error
}

ExitError carries an explicit process exit code through the dispatch, preserving the wrapped cause.

func (e *ExitError) Error() string

func (e *ExitError) Unwrap() error

type Exporter ¶

type Exporter interface {
	Export(ctx context.Context, domain string) error
}

Exporter is the optional driver::export hook: export the spec-derived env that spec.bootstrap addons consume (LOK8S_SPEC_*, …). MUST be idempotent — dispatch calls it on BOTH the full provision and the --bootstrap path, so a re-applied bootstrap graph renders with the same env a fresh provision would set.

type Factory ¶

type Factory func(deps *Deps) (Driver, error)

Factory builds a driver instance over its dispatch-provided dependencies.

func Get(name string) (Factory, bool)

type PostProvisioner ¶

type PostProvisioner interface {
	PostProvision(ctx context.Context, domain string) error
}

PostProvisioner is the optional driver::post_provision hook: driver side-effects that need already-provisioned infrastructure (rare). Runs on the full-provision path only, never under --bootstrap.

type Provider ¶

type Provider interface {
	Validate(ctx context.Context, configFile string) error
	CredentialData(ctx context.Context, configFile string) (map[string]string, error)
	Provision(ctx context.Context, configFile, workDir string) error
	Destroy(ctx context.Context, configFile, workDir string) error
	Output(ctx context.Context, configFile string) ([]byte, error)
}

Provider is the infrastructure-provider contract (.lok8s/utils/provider.sh): the seam between drivers and clouds. The hetzner provider is still the bash plugin; internal/provider/bridge runs it as a child process behind this interface, and tests install fakes.

Output returns the standard inventory JSON (api/access/nodes/network — see the schema in utils/provider.sh); every provider produces the same shape, every driver reads it.

type ProviderStatuser ¶

type ProviderStatuser interface {
	ProviderStatus(ctx context.Context, configFile string) (string, error)
}

ProviderStatuser is the optional provider::status hook (Running | Partial | NotFound). The bash also documents optional provider::rebuild and provider::doctor hooks — those belong to the recover/doctor port, not this layer.