Documentation ¶
Overview ¶
Package builtins holds code generated from the builtin plugins. The "builtin" plugins are written as normal plugins and can be used as such, but they are also used to generate the code in this package so they can be statically linked to client code.
Index ¶
- func NewAnnotationsTransformerPlugin() resmap.TransformerPlugin
- func NewConfigMapGeneratorPlugin() resmap.GeneratorPlugin
- func NewHashTransformerPlugin() resmap.TransformerPlugin
- func NewHelmChartInflationGeneratorPlugin() resmap.GeneratorPlugin
- func NewImageTagTransformerPlugin() resmap.TransformerPlugin
- func NewLabelTransformerPlugin() resmap.TransformerPlugin
- func NewLegacyOrderTransformerPlugin() resmap.TransformerPlugin
- func NewNamespaceTransformerPlugin() resmap.TransformerPlugin
- func NewPatchJson6902TransformerPlugin() resmap.TransformerPlugin
- func NewPatchStrategicMergeTransformerPlugin() resmap.TransformerPlugin
- func NewPatchTransformerPlugin() resmap.TransformerPlugin
- func NewPrefixSuffixTransformerPlugin() resmap.TransformerPlugin
- func NewReplicaCountTransformerPlugin() resmap.TransformerPlugin
- func NewSecretGeneratorPlugin() resmap.GeneratorPlugin
- func NewValueAddTransformerPlugin() resmap.TransformerPlugin
- type AnnotationsTransformerPlugin
- type ConfigMapGeneratorPlugin
- type HashTransformerPlugin
- type HelmChartInflationGeneratorPlugin
- type ImageTagTransformerPlugin
- type LabelTransformerPlugin
- type LegacyOrderTransformerPlugin
- type NamespaceTransformerPlugin
- type PatchJson6902TransformerPlugin
- type PatchStrategicMergeTransformerPlugin
- type PatchTransformerPlugin
- type PrefixSuffixTransformerPlugin
- type ReplicaCountTransformerPlugin
- type SecretGeneratorPlugin
- type Target
- type ValueAddTransformerPlugin
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAnnotationsTransformerPlugin ¶
func NewAnnotationsTransformerPlugin() resmap.TransformerPlugin
func NewConfigMapGeneratorPlugin ¶
func NewConfigMapGeneratorPlugin() resmap.GeneratorPlugin
func NewHashTransformerPlugin ¶
func NewHashTransformerPlugin() resmap.TransformerPlugin
func NewHelmChartInflationGeneratorPlugin ¶ added in v0.6.5
func NewHelmChartInflationGeneratorPlugin() resmap.GeneratorPlugin
func NewImageTagTransformerPlugin ¶
func NewImageTagTransformerPlugin() resmap.TransformerPlugin
func NewLabelTransformerPlugin ¶
func NewLabelTransformerPlugin() resmap.TransformerPlugin
func NewLegacyOrderTransformerPlugin ¶
func NewLegacyOrderTransformerPlugin() resmap.TransformerPlugin
func NewNamespaceTransformerPlugin ¶
func NewNamespaceTransformerPlugin() resmap.TransformerPlugin
func NewPatchJson6902TransformerPlugin ¶
func NewPatchJson6902TransformerPlugin() resmap.TransformerPlugin
func NewPatchStrategicMergeTransformerPlugin ¶
func NewPatchStrategicMergeTransformerPlugin() resmap.TransformerPlugin
func NewPatchTransformerPlugin ¶
func NewPatchTransformerPlugin() resmap.TransformerPlugin
func NewPrefixSuffixTransformerPlugin ¶
func NewPrefixSuffixTransformerPlugin() resmap.TransformerPlugin
func NewReplicaCountTransformerPlugin ¶
func NewReplicaCountTransformerPlugin() resmap.TransformerPlugin
func NewSecretGeneratorPlugin ¶
func NewSecretGeneratorPlugin() resmap.GeneratorPlugin
func NewValueAddTransformerPlugin ¶ added in v0.3.3
func NewValueAddTransformerPlugin() resmap.TransformerPlugin
Types ¶
type AnnotationsTransformerPlugin ¶
type AnnotationsTransformerPlugin struct { Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"` FieldSpecs []types.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"` }
Add the given annotations to the given field specifications.
func (*AnnotationsTransformerPlugin) Config ¶
func (p *AnnotationsTransformerPlugin) Config( _ *resmap.PluginHelpers, c []byte) (err error)
type ConfigMapGeneratorPlugin ¶
type ConfigMapGeneratorPlugin struct { types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` types.ConfigMapArgs // contains filtered or unexported fields }
func (*ConfigMapGeneratorPlugin) Config ¶
func (p *ConfigMapGeneratorPlugin) Config(h *resmap.PluginHelpers, config []byte) (err error)
type HashTransformerPlugin ¶
type HashTransformerPlugin struct {
// contains filtered or unexported fields
}
func (*HashTransformerPlugin) Config ¶
func (p *HashTransformerPlugin) Config( h *resmap.PluginHelpers, _ []byte) (err error)
type HelmChartInflationGeneratorPlugin ¶ added in v0.6.5
type HelmChartInflationGeneratorPlugin struct { types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` types.HelmChartArgs // contains filtered or unexported fields }
HelmChartInflationGeneratorPlugin is a plugin to generate resources from a remote or local helm chart.
var KustomizePlugin HelmChartInflationGeneratorPlugin
func (*HelmChartInflationGeneratorPlugin) Config ¶ added in v0.6.5
func (p *HelmChartInflationGeneratorPlugin) Config(h *resmap.PluginHelpers, config []byte) error
Config uses the input plugin configurations `config` to setup the generator options
func (*HelmChartInflationGeneratorPlugin) EncodeValues ¶ added in v0.6.8
func (p *HelmChartInflationGeneratorPlugin) EncodeValues(w io.Writer) error
EncodeValues for writing
type ImageTagTransformerPlugin ¶
type ImageTagTransformerPlugin struct { ImageTag types.Image `json:"imageTag,omitempty" yaml:"imageTag,omitempty"` FieldSpecs []types.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"` }
Find matching image declarations and replace the name, tag and/or digest.
func (*ImageTagTransformerPlugin) Config ¶
func (p *ImageTagTransformerPlugin) Config( _ *resmap.PluginHelpers, c []byte) (err error)
type LabelTransformerPlugin ¶
type LabelTransformerPlugin struct { Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"` FieldSpecs []types.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"` }
Add the given labels to the given field specifications.
func (*LabelTransformerPlugin) Config ¶
func (p *LabelTransformerPlugin) Config( _ *resmap.PluginHelpers, c []byte) (err error)
type LegacyOrderTransformerPlugin ¶
type LegacyOrderTransformerPlugin struct{}
Sort the resources using an ordering defined in the Gvk class. This puts cluster-wide basic resources with no dependencies (like Namespace, StorageClass, etc.) first, and resources with a high number of dependencies (like ValidatingWebhookConfiguration) last.
func (*LegacyOrderTransformerPlugin) Config ¶
func (p *LegacyOrderTransformerPlugin) Config( _ *resmap.PluginHelpers, _ []byte) (err error)
Nothing needed for configuration.
type NamespaceTransformerPlugin ¶
type NamespaceTransformerPlugin struct { types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` FieldSpecs []types.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"` }
Change or set the namespace of non-cluster level resources.
func (*NamespaceTransformerPlugin) Config ¶
func (p *NamespaceTransformerPlugin) Config( _ *resmap.PluginHelpers, c []byte) (err error)
type PatchJson6902TransformerPlugin ¶
type PatchJson6902TransformerPlugin struct { Target *types.Selector `json:"target,omitempty" yaml:"target,omitempty"` Path string `json:"path,omitempty" yaml:"path,omitempty"` JsonOp string `json:"jsonOp,omitempty" yaml:"jsonOp,omitempty"` // contains filtered or unexported fields }
func (*PatchJson6902TransformerPlugin) Config ¶
func (p *PatchJson6902TransformerPlugin) Config( h *resmap.PluginHelpers, c []byte) (err error)
type PatchStrategicMergeTransformerPlugin ¶
type PatchStrategicMergeTransformerPlugin struct { Paths []types.PatchStrategicMerge `json:"paths,omitempty" yaml:"paths,omitempty"` Patches string `json:"patches,omitempty" yaml:"patches,omitempty"` // contains filtered or unexported fields }
func (*PatchStrategicMergeTransformerPlugin) Config ¶
func (p *PatchStrategicMergeTransformerPlugin) Config( h *resmap.PluginHelpers, c []byte) (err error)
type PatchTransformerPlugin ¶
type PatchTransformerPlugin struct { Path string `json:"path,omitempty" yaml:"path,omitempty"` Patch string `json:"patch,omitempty" yaml:"patch,omitempty"` Target *types.Selector `json:"target,omitempty" yaml:"target,omitempty"` // contains filtered or unexported fields }
func (*PatchTransformerPlugin) Config ¶
func (p *PatchTransformerPlugin) Config( h *resmap.PluginHelpers, c []byte) error
type PrefixSuffixTransformerPlugin ¶
type PrefixSuffixTransformerPlugin struct { Prefix string `json:"prefix,omitempty" yaml:"prefix,omitempty"` Suffix string `json:"suffix,omitempty" yaml:"suffix,omitempty"` FieldSpecs types.FsSlice `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"` }
Add the given prefix and suffix to the field.
func (*PrefixSuffixTransformerPlugin) Config ¶
func (p *PrefixSuffixTransformerPlugin) Config( _ *resmap.PluginHelpers, c []byte) (err error)
type ReplicaCountTransformerPlugin ¶
type ReplicaCountTransformerPlugin struct { Replica types.Replica `json:"replica,omitempty" yaml:"replica,omitempty"` FieldSpecs []types.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"` }
Find matching replicas declarations and replace the count. Eases the kustomization configuration of replica changes.
func (*ReplicaCountTransformerPlugin) Config ¶
func (p *ReplicaCountTransformerPlugin) Config( _ *resmap.PluginHelpers, c []byte) (err error)
type SecretGeneratorPlugin ¶
type SecretGeneratorPlugin struct { types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` types.SecretArgs // contains filtered or unexported fields }
func (*SecretGeneratorPlugin) Config ¶
func (p *SecretGeneratorPlugin) Config(h *resmap.PluginHelpers, config []byte) (err error)
type Target ¶ added in v0.3.3
type Target struct { // Selector selects the resources to modify. Selector *types.Selector `json:"selector,omitempty" yaml:"selector,omitempty"` // FieldPath is a JSON-style path to the field intended to hold the value. FieldPath string `json:"fieldPath,omitempty" yaml:"fieldPath,omitempty"` // FilePathPosition is passed to the filter directly. Look there for doc. FilePathPosition int `json:"filePathPosition,omitempty" yaml:"filePathPosition,omitempty"` }
Target describes where to put the value.
type ValueAddTransformerPlugin ¶ added in v0.3.3
type ValueAddTransformerPlugin struct { // Value is the value to add. // Defaults to base name of encompassing kustomization root. Value string `json:"value,omitempty" yaml:"value,omitempty"` // Targets is a slice of targets that should have the value added. Targets []Target `json:"targets,omitempty" yaml:"targets,omitempty"` // TargetFilePath is a file path. If specified, the file will be parsed into // a slice of Target, and appended to anything that was specified in the // Targets field. This is just a means to share common target specifications. TargetFilePath string `json:"targetFilePath,omitempty" yaml:"targetFilePath,omitempty"` }
An 'Add' transformer inspired by the IETF RFC 6902 JSON spec Add operation.
func (*ValueAddTransformerPlugin) Config ¶ added in v0.3.3
func (p *ValueAddTransformerPlugin) Config(h *resmap.PluginHelpers, c []byte) error
Source Files ¶
- AnnotationsTransformer.go
- ConfigMapGenerator.go
- HashTransformer.go
- HelmChartInflationGenerator.go
- ImageTagTransformer.go
- LabelTransformer.go
- LegacyOrderTransformer.go
- NamespaceTransformer.go
- PatchJson6902Transformer.go
- PatchStrategicMergeTransformer.go
- PatchTransformer.go
- PrefixSuffixTransformer.go
- ReplicaCountTransformer.go
- SecretGenerator.go
- ValueAddTransformer.go
- doc.go