manifest

package

v3.15.13 Latest Latest Go to latest Published: Sep 11, 2026 License: Apache-2.0 Imports: 25 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/databus23/helm-diff

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Generate(actionConfig *action.Configuration, originalManifest, targetManifest []byte, ...) ([]byte, []byte, error)
func Parse(manifest []byte, defaultNamespace string, normalizeManifests bool, ...) map[string]*MappingResult
type GenerateOption
- func WithThreeWayMergeMode(mode ThreeWayMergeMode) GenerateOption
type MappingResult
- func ParseObject(object runtime.Object, defaultNamespace string, excludedHooks ...string) (*MappingResult, string, error)
type ThreeWayMergeMode

Constants ¶

View Source

const (
	Helm2TestSuccessHook = "test-success"
	Helm3TestHook        = "test"
)

Variables ¶

View Source

var ValidThreeWayMergeModes = []string{
	string(ThreeWayMergeAuto),
	string(ThreeWayMergeServer),
	string(ThreeWayMergeClient),
}

ValidThreeWayMergeModes lists every accepted ThreeWayMergeMode value.

Functions ¶

func Generate ¶ added in v3.10.0

func Generate(actionConfig *action.Configuration, originalManifest, targetManifest []byte, opts ...GenerateOption) ([]byte, []byte, error)

func Parse ¶

func Parse(manifest []byte, defaultNamespace string, normalizeManifests bool, excludedHooks ...string) map[string]*MappingResult

Parse parses manifest bytes into MappingResult

Types ¶

type GenerateOption ¶ added in v3.15.13

type GenerateOption func(*generateOptions)

GenerateOption customizes the behavior of Generate.

func WithThreeWayMergeMode ¶ added in v3.15.13

func WithThreeWayMergeMode(mode ThreeWayMergeMode) GenerateOption

WithThreeWayMergeMode selects how the three-way merge patch is applied. It defaults to ThreeWayMergeAuto.

type MappingResult ¶

type MappingResult struct {
	Name           string
	Kind           string
	Content        string
	ResourcePolicy string
}

MappingResult to store result of diff

func ParseObject ¶ added in v3.11.0

func ParseObject(object runtime.Object, defaultNamespace string, excludedHooks ...string) (*MappingResult, string, error)

type ThreeWayMergeMode ¶ added in v3.15.13

type ThreeWayMergeMode string

ThreeWayMergeMode selects how the three-way merge patch is turned into the object that the diff is computed against.

const (
	// ThreeWayMergeAuto sends the patch to the API server as a dry-run and
	// falls back to merging locally when the server refuses the request because
	// the user has no permission to patch the resource.
	ThreeWayMergeAuto ThreeWayMergeMode = "auto"
	// ThreeWayMergeServer always sends the patch to the API server as a dry-run
	// and fails when that is not permitted.
	ThreeWayMergeServer ThreeWayMergeMode = "server"
	// ThreeWayMergeClient always merges locally and never sends a patch to the
	// API server, so that only read permissions are required.
	ThreeWayMergeClient ThreeWayMergeMode = "client"
)

Source Files ¶

View all Source files

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