apimachinery: k8s.io/apimachinery/pkg/util/strategicpatch Index | Files | Directories

package strategicpatch

import "k8s.io/apimachinery/pkg/util/strategicpatch"


Package Files

errors.go meta.go patch.go types.go

func CreateDeleteDirective Uses

func CreateDeleteDirective(mergeKey string, mergeKeyValue interface{}) map[string]interface{}

func CreateThreeWayMergePatch Uses

func CreateThreeWayMergePatch(original, modified, current []byte, schema LookupPatchMeta, 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 Uses

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 CreateTwoWayMergePatchUsingLookupPatchMeta Uses

func CreateTwoWayMergePatchUsingLookupPatchMeta(
    original, modified []byte, schema LookupPatchMeta, fns ...mergepatch.PreconditionFunc) ([]byte, error)

func GetTagStructTypeOrDie Uses

func GetTagStructTypeOrDie(dataStruct interface{}) reflect.Type

func ItemAddedToModifiedSlice Uses

func ItemAddedToModifiedSlice(original, modified string) bool

func ItemMatchesOriginalAndModifiedSlice Uses

func ItemMatchesOriginalAndModifiedSlice(original, modified string) bool

func ItemRemovedFromModifiedSlice Uses

func ItemRemovedFromModifiedSlice(original, modified string) bool

func MergingMapsHaveConflicts Uses

func MergingMapsHaveConflicts(left, right map[string]interface{}, schema LookupPatchMeta) (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 NewKindItem Uses

func NewKindItem(key string, path *openapi.Path) *kindItem

func NewSliceItem Uses

func NewSliceItem(key string, path *openapi.Path) *sliceItem

func StrategicMergePatch Uses

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.

func StrategicMergePatchUsingLookupPatchMeta Uses

func StrategicMergePatchUsingLookupPatchMeta(original, patch []byte, schema LookupPatchMeta) ([]byte, error)

type DiffOptions Uses

type DiffOptions struct {
    // SetElementOrder determines whether we generate the $setElementOrder parallel list.
    SetElementOrder bool
    // IgnoreChangesAndAdditions indicates if we keep the changes and additions in the patch.
    IgnoreChangesAndAdditions bool
    // IgnoreDeletions indicates if we keep the deletions in the patch.
    IgnoreDeletions bool
    // We introduce a new value retainKeys for patchStrategy.
    // It indicates that all fields needing to be preserved must be
    // present in the `retainKeys` list.
    // And the fields that are present will be merged with live object.
    // All the missing fields will be cleared when patching.
    BuildRetainKeysDirective bool

type FieldNotFoundError Uses

type FieldNotFoundError struct {
    Path  string
    Field string

func (FieldNotFoundError) Error Uses

func (e FieldNotFoundError) Error() string

type InvalidTypeError Uses

type InvalidTypeError struct {
    Path     string
    Expected string
    Actual   string

func (InvalidTypeError) Error Uses

func (e InvalidTypeError) Error() string

type JSONMap Uses

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 Uses

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 CreateTwoWayMergeMapPatchUsingLookupPatchMeta Uses

func CreateTwoWayMergeMapPatchUsingLookupPatchMeta(original, modified JSONMap, schema LookupPatchMeta, fns ...mergepatch.PreconditionFunc) (JSONMap, error)

func MergeStrategicMergeMapPatchUsingLookupPatchMeta Uses

func MergeStrategicMergeMapPatchUsingLookupPatchMeta(schema LookupPatchMeta, patches ...JSONMap) (JSONMap, error)

MergeStrategicMergeMapPatchUsingLookupPatchMeta merges strategic merge patches retaining `null` fields and parallel lists. If 2 patches change the same fields and the latter one will override the former one. If you don't want that happen, you need to run func MergingMapsHaveConflicts before merging these patches. Applying the resulting merged merge patch to a JSONMap yields the same as merging each strategic merge patch to the JSONMap in succession.

func StrategicMergeMapPatch Uses

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

StrategicMergeMapPatch 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.

func StrategicMergeMapPatchUsingLookupPatchMeta Uses

func StrategicMergeMapPatchUsingLookupPatchMeta(original, patch JSONMap, schema LookupPatchMeta) (JSONMap, error)

type LookupPatchItem Uses

type LookupPatchItem interface {

    Error() error
    Path() *openapi.Path

type LookupPatchMeta Uses

type LookupPatchMeta interface {
    // LookupPatchMetadataForStruct gets subschema and the patch metadata (e.g. patch strategy and merge key) for map.
    LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)
    // LookupPatchMetadataForSlice get subschema and the patch metadata for slice.
    LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)
    // Get the type name of the field
    Name() string

type LookupPatchMetaError Uses

type LookupPatchMetaError struct {
    Path string
    Err  error

func (LookupPatchMetaError) Error Uses

func (e LookupPatchMetaError) Error() string

type MergeOptions Uses

type MergeOptions struct {
    // MergeParallelList indicates if we are merging the parallel list.
    // We don't merge parallel list when calling mergeMap() in CreateThreeWayMergePatch()
    // which is called client-side.
    // We merge parallel list iff when calling mergeMap() in StrategicMergeMapPatch()
    // which is called server-side
    MergeParallelList bool
    // IgnoreUnmatchedNulls indicates if we should process the unmatched nulls.
    IgnoreUnmatchedNulls bool

type PatchMeta Uses

type PatchMeta struct {
    // contains filtered or unexported fields

func (PatchMeta) GetPatchMergeKey Uses

func (pm PatchMeta) GetPatchMergeKey() string

func (PatchMeta) GetPatchStrategies Uses

func (pm PatchMeta) GetPatchStrategies() []string

func (PatchMeta) SetPatchMergeKey Uses

func (pm PatchMeta) SetPatchMergeKey(pmk string)

func (PatchMeta) SetPatchStrategies Uses

func (pm PatchMeta) SetPatchStrategies(ps []string)

type PatchMetaFromOpenAPI Uses

type PatchMetaFromOpenAPI struct {
    Schema openapi.Schema

func NewPatchMetaFromOpenAPI Uses

func NewPatchMetaFromOpenAPI(s openapi.Schema) PatchMetaFromOpenAPI

func (PatchMetaFromOpenAPI) LookupPatchMetadataForSlice Uses

func (s PatchMetaFromOpenAPI) LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromOpenAPI) LookupPatchMetadataForStruct Uses

func (s PatchMetaFromOpenAPI) LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromOpenAPI) Name Uses

func (s PatchMetaFromOpenAPI) Name() string

type PatchMetaFromStruct Uses

type PatchMetaFromStruct struct {
    T reflect.Type

func NewPatchMetaFromStruct Uses

func NewPatchMetaFromStruct(dataStruct interface{}) (PatchMetaFromStruct, error)

func (PatchMetaFromStruct) LookupPatchMetadataForSlice Uses

func (s PatchMetaFromStruct) LookupPatchMetadataForSlice(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromStruct) LookupPatchMetadataForStruct Uses

func (s PatchMetaFromStruct) LookupPatchMetadataForStruct(key string) (LookupPatchMeta, PatchMeta, error)

func (PatchMetaFromStruct) Name Uses

func (s PatchMetaFromStruct) Name() string

type SortableSliceOfMaps Uses

type SortableSliceOfMaps struct {
    // contains filtered or unexported fields

func (SortableSliceOfMaps) Len Uses

func (ss SortableSliceOfMaps) Len() int

func (SortableSliceOfMaps) Less Uses

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

func (SortableSliceOfMaps) Swap Uses

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

type SortableSliceOfScalars Uses

type SortableSliceOfScalars struct {
    // contains filtered or unexported fields

func (SortableSliceOfScalars) Len Uses

func (ss SortableSliceOfScalars) Len() int

func (SortableSliceOfScalars) Less Uses

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

func (SortableSliceOfScalars) Swap Uses

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



Package strategicpatch imports 10 packages (graph) and is imported by 398 packages. Updated 2019-02-12. Refresh now. Tools for package owners.