probe

package
v0.1.4 Latest Latest
Warning

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

Go to latest
Published: Oct 14, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package probe finds which user-set values change a chart's rendered output: it removes each subtree, re-renders and compares with a baseline.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Finding

type Finding struct {
	Path        []string
	Status      Status
	Value       interface{}
	Default     interface{}
	HasDefault  bool
	Implicit    bool
	Toggle      []string
	RequiresAPI []string
	Err         string
}

func (Finding) Key

func (f Finding) Key() string

type Options

type Options struct {
	Render   RenderFunc
	User     map[string]interface{}
	Defaults map[string]interface{}
	Workers  int
	Logf     func(format string, args ...interface{})

	// MissingAPIs are API versions the chart checks with
	// .Capabilities.APIVersions.Has that the render capabilities lack.
	// RenderWithAPIs renders as if the cluster also served them. When both
	// are set, keys that only matter with one of those APIs are reported as
	// CONDITIONAL instead of DEAD.
	MissingAPIs    []string
	RenderWithAPIs func(vals map[string]interface{}, apis []string) (compare.Snapshot, error)
}

type RenderFunc

type RenderFunc func(map[string]interface{}) (compare.Snapshot, error)

type Result

type Result struct {
	Findings []Finding
	Renders  int64
	Base     compare.Snapshot
	Noise    map[string]bool
}

func Run

func Run(o Options) (*Result, error)

func (*Result) Find

func (r *Result) Find(path []string) (Finding, bool)

Find returns the finding for path, or for its closest ancestor when the key was classified as part of a larger subtree (GROUP).

type Status

type Status int
const (
	Alive Status = iota
	Group
	Error
	Redundant
	Conditional
	Dead
)

func (Status) Effective

func (s Status) Effective() bool

Effective reports whether the key has an effect on the rendered output.

func (Status) String

func (s Status) String() string

Jump to

Keyboard shortcuts

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