patches

Documentation

Overview

Package patches implement the patch engine.

Index

• type Engine
  • func NewEngine() Engine
• type PatchOption
• type PatchOptions
  • func (o *PatchOptions) ApplyOptions(opts []PatchOption)
• type PreserveFields
  • func (i PreserveFields) ApplyToHelper(opts *PatchOptions)

Types

type Engine

type Engine interface {
	Apply(ctx context.Context, blueprint *scope.ClusterBlueprint, desired *scope.ClusterState) error
}

Engine is a patch engine which applies patches defined in a ClusterBlueprint to a ClusterState.

func NewEngine

func NewEngine() Engine

NewEngine creates a new patch engine.

type PatchOption

type PatchOption interface {
	// ApplyToHelper applies configuration to the given options.
	ApplyToHelper(*PatchOptions)
}

PatchOption represents an option for the patchObject and patchTemplate funcs.

type PatchOptions

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

PatchOptions contains options for patchObject and patchTemplate.

func (*PatchOptions) ApplyOptions

func (o *PatchOptions) ApplyOptions(opts []PatchOption)

ApplyOptions applies the given patch options.

type PreserveFields

type PreserveFields []contract.Path

PreserveFields instructs the patch func to preserve fields.

func (PreserveFields) ApplyToHelper

func (i PreserveFields) ApplyToHelper(opts *PatchOptions)

ApplyToHelper applies this configuration to the given patch options.