strategicpatch

Documentation

Index

• func CreateThreeWayMergePatch(original, modified, current []byte, dataStruct interface{}, overwrite bool, ...) ([]byte, error)
• func CreateTwoWayMergePatch(original, modified []byte, dataStruct interface{}, ...) ([]byte, error)
• func MergingMapsHaveConflicts(left, right map[string]interface{}, dataStruct interface{}) (bool, error)
• func StrategicMergePatch(original, patch []byte, dataStruct interface{}) ([]byte, error)
• type JSONMap
  • func CreateTwoWayMergeMapPatch(original, modified JSONMap, dataStruct interface{}, ...) (JSONMap, error)
  • func StrategicMergeMapPatch(original, patch JSONMap, dataStruct interface{}) (JSONMap, error)
• type SortableSliceOfMaps
  • func (ss SortableSliceOfMaps) Len() int
  • func (ss SortableSliceOfMaps) Less(i, j int) bool
  • func (ss SortableSliceOfMaps) Swap(i, j int)
• type SortableSliceOfScalars
  • func (ss SortableSliceOfScalars) Len() int
  • func (ss SortableSliceOfScalars) Less(i, j int) bool
  • func (ss SortableSliceOfScalars) Swap(i, j int)

Functions

func CreateThreeWayMergePatch

func CreateThreeWayMergePatch(original, modified, current []byte, dataStruct interface{}, overwrite bool, fns ...mergepatch.PreconditionFunc) ([]byte, error)

CreateThreeWayMergePatch reconciles a modified configuration with an original configuration, while preserving any changes or deletions made to the original configuration in the interim, and not overridden by the current configuration. All three documents must be passed to the method as json encoded content. It will return a strategic merge patch, or an error if any of the documents is invalid, or if there are any preconditions that fail against the modified configuration, or, if overwrite is false and there are conflicts between the modified and current configurations. Conflicts are defined as keys changed differently from original to modified than from original to current. In other words, a conflict occurs if modified changes any key in a way that is different from how it is changed in current (e.g., deleting it, changing its value). We also propagate values fields that do not exist in original but are explicitly defined in modified.

func CreateTwoWayMergePatch

func CreateTwoWayMergePatch(original, modified []byte, dataStruct interface{}, fns ...mergepatch.PreconditionFunc) ([]byte, error)

CreateTwoWayMergePatch creates a patch that can be passed to StrategicMergePatch from an original document and a modified document, which are passed to the method as json encoded content. It will return a patch that yields the modified document when applied to the original document, or an error if either of the two documents is invalid.

func MergingMapsHaveConflicts

func MergingMapsHaveConflicts(left, right map[string]interface{}, dataStruct interface{}) (bool, error)

MergingMapsHaveConflicts returns true if the left and right JSON interface objects overlap with different values in any key. All keys are required to be strings. Since patches of the same Type have congruent keys, this is valid for multiple patch types. This method supports strategic merge patch semantics.

func StrategicMergePatch

func StrategicMergePatch(original, patch []byte, dataStruct interface{}) ([]byte, error)

StrategicMergePatch applies a strategic merge patch. The patch and the original document must be json encoded content. A patch can be created from an original and a modified document by calling CreateStrategicMergePatch.

Types

type JSONMap

type JSONMap map[string]interface{}

JSONMap is a representations of JSON object encoded as map[string]interface{} where the children can be either map[string]interface{}, []interface{} or primitive type). Operating on JSONMap representation is much faster as it doesn't require any json marshaling and/or unmarshaling operations.

func CreateTwoWayMergeMapPatch

func CreateTwoWayMergeMapPatch(original, modified JSONMap, dataStruct interface{}, fns ...mergepatch.PreconditionFunc) (JSONMap, error)

CreateTwoWayMergeMapPatch creates a patch from an original and modified JSON objects, encoded JSONMap. The serialized version of the map can then be passed to StrategicMergeMapPatch.

func StrategicMergeMapPatch

func StrategicMergeMapPatch(original, patch JSONMap, dataStruct interface{}) (JSONMap, error)

StrategicMergePatch applies a strategic merge patch. The original and patch documents must be JSONMap. A patch can be created from an original and modified document by calling CreateTwoWayMergeMapPatch. Warning: the original and patch JSONMap objects are mutated by this function and should not be reused.

type SortableSliceOfMaps

type SortableSliceOfMaps struct {
	// contains filtered or unexported fields
}

func (SortableSliceOfMaps) Len

func (ss SortableSliceOfMaps) Len() int

func (SortableSliceOfMaps) Less

func (ss SortableSliceOfMaps) Less(i, j int) bool

func (SortableSliceOfMaps) Swap

func (ss SortableSliceOfMaps) Swap(i, j int)

type SortableSliceOfScalars

type SortableSliceOfScalars struct {
	// contains filtered or unexported fields
}

func (SortableSliceOfScalars) Len

func (ss SortableSliceOfScalars) Len() int

func (SortableSliceOfScalars) Less

func (ss SortableSliceOfScalars) Less(i, j int) bool

func (SortableSliceOfScalars) Swap

func (ss SortableSliceOfScalars) Swap(i, j int)