config

Documentation

Index

• type Factory
• type Plan

Types

type Factory

type Factory interface {
	// New return an empty config Plan.
	New() Plan

	// YAML returns a Plan with the given YAML and target namespace.
	YAML(ns string, yamlText ...string) Plan

	// File reads the given files and calls YAML.
	File(ns string, paths ...string) Plan

	// Eval the same as YAML, but it evaluates the template parameters.
	Eval(ns string, args any, yamlText ...string) Plan

	// EvalFile the same as File, but it evaluates the template parameters.
	EvalFile(ns string, args any, paths ...string) Plan
}

Factory for config Plan resources.

type Plan

type Plan interface {
	// Factory for appending to this Config.
	Factory

	// Copy returns a deep copy of this Plan.
	Copy() Plan

	// Apply this config.
	Apply(opts ...apply.Option) error
	ApplyOrFail(t test.Failer, opts ...apply.Option)

	// Delete this config.
	Delete() error
	DeleteOrFail(t test.Failer)
}

Plan for configuration that can be applied or deleted as an atomic unit. A Plan is initially created by a Factory, but then can continually be appended to before finally calling Apply or Delete.