add replacement filter to support replacmenttransformer

api/types/replacement.go

@@ -1,27 +1,62 @@
-// Copyright 2019 The Kubernetes Authors.
+// Copyright 2021 The Kubernetes Authors.
 // SPDX-License-Identifier: Apache-2.0
 
 package types
 
+const DefaultReplacementFieldPath = "metadata.name"
+
 // Replacement defines how to perform a substitution
 // where it is from and where it is to.
 type Replacement struct {
-	Source *ReplSource `json:"source" yaml:"source"`
-	Target *ReplTarget `json:"target" yaml:"target"`
+	// The source of the value.
+	Source *SourceSelector `json:"source" yaml:"source"`
+
+	// The N fields to write the value to.
+	Targets []*TargetSelector `json:"targets" yaml:"targets"`
 }
 
-// ReplSource defines where a substitution is from
-// It can from two different kinds of sources
-//  - from a field of one resource
-//  - from a string
-type ReplSource struct {
-	ObjRef   *Target `json:"objref,omitempty" yaml:"objref,omitempty"`
-	FieldRef string  `json:"fieldref,omitempty" yaml:"fiedldref,omitempty"`
-	Value    string  `json:"value,omitempty" yaml:"value,omitempty"`
+// SourceSelector is the source of the replacement transformer.
+type SourceSelector struct {
+	// A specific object to read it from.
+	KrmId `json:",inline,omitempty" yaml:",inline,omitempty"`
+
+	// Structured field path expected in the allowed object.
+	FieldPath string `json:"fieldPath" yaml:"fieldPath"`
+
+	// Used to refine the interpretation of the field
+	Options *FieldOptions `json:"options" yaml:"options"`
 }
 
-// ReplTarget defines where a substitution is to.
-type ReplTarget struct {
-	ObjRef    *Selector `json:"objref,omitempty" yaml:"objref,omitempty"`
-	FieldRefs []string  `json:"fieldrefs,omitempty" yaml:"fieldrefs,omitempty"`
+// TargetSelector specifies fields in one or more objects.
+type TargetSelector struct {
+	// Include objects that match this.
+	Select *Selector `json:"select" yaml:"select"`
+
+	// From the allowed set, remove objects that match this.
+	// TODO (#3492): Remove matches listed in the exclude field
+	//  Currently this field is unused
+	Reject *Selector `json:"reject" yaml:"reject"`
+
+	// Structured field paths expected in each allowed object.
+	FieldPaths []string `json:"fieldPaths" yaml:"fieldPaths"`
+
+	// Used to refine the interpretation of the field
+	Options *FieldOptions `json:"options" yaml:"options"`
+}
+
+// FieldPath is a structured field path to the desired object
+// TODO (#3492): Implement use of these options, they are
+//  currently used
+type FieldOptions struct {
+	// Used to split/join the field.
+	Delimiter string `json:"delimiter" yaml:"delimiter"`
+
+	// Which position in the split to consider.
+	Index int `json:"index" yaml:"index"`
+
+	// None, Base64, URL, Hex, etc
+	Encoding string `json:"encoding" yaml:"index"`
+
+	// If field missing, add it
+	Create bool `json:"create" yaml:"create"`
 }