pipelinecomposition

Documentation

Overview

Package pipelinecomposition is a package for converting patch-and-transform Compositions to a function pipeline.

Index

• type Cmd
  • func (c *Cmd) AfterApply() error
  • func (c *Cmd) Help() string
  • func (c *Cmd) Run() error
• type ComposedTemplate
  • func MigratePatchPolicyInResources(resources []v1.ComposedTemplate) []ComposedTemplate
• type Environment
  • func MigratePatchPolicyInEnvironment(ec *v1.EnvironmentConfiguration) *Environment
• type EnvironmentPatch
• type Input
• type Patch
• type PatchPolicy
• type PatchSet
  • func MigratePatchPolicyInPatchSets(patchset []v1.PatchSet) []PatchSet
• type ToFieldPathPolicy

Types

type Cmd

type Cmd struct {
	// Arguments.
	InputFile string `` /* 132-byte string literal not displayed */

	// Flags.
	OutputFile   string `` /* 136-byte string literal not displayed */
	FunctionName string `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

Cmd arguments and flags for converting a patch-and-transform to a function pipeline composition.

func (*Cmd) AfterApply

func (c *Cmd) AfterApply() error

AfterApply implements kong.AfterApply.

func (*Cmd) Help

func (c *Cmd) Help() string

Help returns help message for the migrate pipeline-composition command.

func (*Cmd) Run

func (c *Cmd) Run() error

Run converts a classic Composition to a function pipeline Composition.

type ComposedTemplate

type ComposedTemplate struct {
	v1.ComposedTemplate

	Patches []Patch `json:"patches,omitempty"`
}

ComposedTemplate wrapper around v1.ComposedTemplate with custom Patch.

func MigratePatchPolicyInResources

func MigratePatchPolicyInResources(resources []v1.ComposedTemplate) []ComposedTemplate

MigratePatchPolicyInResources processes all the patches in the given resources to migrate their patch policies.

type Environment

type Environment struct {
	Patches []EnvironmentPatch `json:"patches,omitempty"`
}

Environment represents the Composition environment.

func MigratePatchPolicyInEnvironment

func MigratePatchPolicyInEnvironment(ec *v1.EnvironmentConfiguration) *Environment

MigratePatchPolicyInEnvironment processes all the patches in the given environment configuration to migrate their patch policies.

type EnvironmentPatch

type EnvironmentPatch struct {
	v1.EnvironmentPatch

	Policy *PatchPolicy `json:"policy,omitempty"`
}

EnvironmentPatch wrapper around v1.EnvironmentPatch with custom PatchPolicy.

type Input

type Input struct {
	// PatchSets define a named set of patches that may be included by any
	// resource in this Composition. PatchSets cannot themselves refer to other
	// PatchSets.
	//
	// PatchSets are only used by the "Resources" mode of Composition. They
	// are ignored by other modes.
	// +optional
	PatchSets []v1.PatchSet `json:"patchSets,omitempty"`

	// Environment configures the environment in which resources are rendered.
	//
	// THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored
	// unless the relevant Crossplane feature flag is enabled, and may be
	// changed or removed without notice.
	// +optional
	Environment *v1.EnvironmentConfiguration `json:"environment,omitempty"`

	// Resources is a list of resource templates that will be used when a
	// composite resource referring to this composition is created.
	//
	// Resources are only used by the "Resources" mode of Composition. They are
	// ignored by other modes.
	// +optional
	Resources []v1.ComposedTemplate `json:"resources,omitempty"`
}

Input represents the input to the patch-and-transform function. This struct originates from function patch and transform, as we can't import it directly https://github.com/crossplane-contrib/function-patch-and-transform/blob/main/input/v1beta1/resources.go Note that it does not exactly match the target type with full fidelity. This type is used during the processing and conversion of the given input, but the final converted output is written in an unstructured manner without a static type definition for more flexibility.

type Patch

type Patch struct {
	v1.Patch

	Policy *PatchPolicy `json:"policy,omitempty"`
}

Patch wrapper around v1.Patch with custom PatchPolicy.

type PatchPolicy

type PatchPolicy struct {
	FromFieldPath *v1.FromFieldPathPolicy `json:"fromFieldPath,omitempty"`
	ToFieldPath   *ToFieldPathPolicy      `json:"toFieldPath,omitempty"`
}

PatchPolicy defines the policy for a patch.

type PatchSet

type PatchSet struct {
	// Name of this PatchSet.
	Name string `json:"name"`

	Patches []Patch `json:"patches"`
}

PatchSet wrapper around v1.PatchSet with custom Patch.

func MigratePatchPolicyInPatchSets

func MigratePatchPolicyInPatchSets(patchset []v1.PatchSet) []PatchSet

MigratePatchPolicyInPatchSets processes all the patches in the given patch set to migrate their patch policies.

type ToFieldPathPolicy

type ToFieldPathPolicy string

A ToFieldPathPolicy determines how to patch to a field path.

const (
	ToFieldPathPolicyReplace                       ToFieldPathPolicy = "Replace"
	ToFieldPathPolicyMergeObjects                  ToFieldPathPolicy = "MergeObjects"
	ToFieldPathPolicyMergeObjectsAppendArrays      ToFieldPathPolicy = "MergeObjectsAppendArrays"
	ToFieldPathPolicyForceMergeObjects             ToFieldPathPolicy = "ForceMergeObjects"
	ToFieldPathPolicyForceMergeObjectsAppendArrays ToFieldPathPolicy = "ForceMergeObjectsAppendArrays"
)

ToFieldPathPatchPolicy defines the policy for the ToFieldPath in a Patch.