config

Documentation

Overview

Package config provides a generic configuration loader for the kat application.

It provides a Loader type that can load, validate, and parse configuration files in YAML format for any type implementing github.com/macropower/kat/api/v1beta1.Object.

Configuration types are defined in sub-packages of github.com/macropower/kat/api/v1beta1:

• github.com/macropower/kat/api/v1beta1/configs - Global configuration
• github.com/macropower/kat/api/v1beta1/policies - Policy configuration
• github.com/macropower/kat/api/v1beta1/runtimeconfigs - Runtime configuration

Index

• type Loader
  • func NewLoaderFromBytes[T v1beta1.Object](data []byte, newFunc func() T, defaultValidator Validator, opts ...LoaderOpt) *Loader[T]
  • func NewLoaderFromFile[T v1beta1.Object](path string, newFunc func() T, defaultValidator Validator, opts ...LoaderOpt) (*Loader[T], error)
  • func (l *Loader[T]) GetTheme() *theme.Theme
  • func (l *Loader[T]) Load() (T, error)
  • func (l *Loader[T]) Validate() error
• type LoaderOpt
  • func WithThemeFromData() LoaderOpt
  • func WithValidator(v Validator) LoaderOpt
• type Validator

Types

type Loader

type Loader[T v1beta1.Object] struct {
	// contains filtered or unexported fields
}

Loader is a generic configuration loader that handles validation, YAML parsing, and error formatting for any config type T.

func NewLoaderFromBytes

func NewLoaderFromBytes[T v1beta1.Object](
	data []byte,
	newFunc func() T,
	defaultValidator Validator,
	opts ...LoaderOpt,
) *Loader[T]

NewLoaderFromBytes creates a Loader from byte data. The newFunc parameter is the constructor for type T (e.g., config.New).

func NewLoaderFromFile

func NewLoaderFromFile[T v1beta1.Object](
	path string,
	newFunc func() T,
	defaultValidator Validator,
	opts ...LoaderOpt,
) (*Loader[T], error)

NewLoaderFromFile creates a Loader from a file path.

func (*Loader[T]) GetTheme

func (l *Loader[T]) GetTheme() *theme.Theme

GetTheme returns the theme for error formatting.

func (*Loader[T]) Load

func (l *Loader[T]) Load() (T, error)

Load parses and returns the configuration.

func (*Loader[T]) Validate

func (l *Loader[T]) Validate() error

Validate validates the configuration data against the schema.

type LoaderOpt

type LoaderOpt func(*loaderOptions)

LoaderOpt configures a Loader.

func WithThemeFromData

func WithThemeFromData() LoaderOpt

WithThemeFromData extracts the theme from the config data for error formatting.

func WithValidator

func WithValidator(v Validator) LoaderOpt

WithValidator sets a custom validator.

type Validator

type Validator interface {
	Validate(data any) error
}

Validator validates configuration data against a schema.