config

package
v0.0.0-...-367ed20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2024 License: Apache-2.0 Imports: 2 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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