builtins

package
v0.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2020 License: Apache-2.0 Imports: 23 Imported by: 7

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

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 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)

func (*AnnotationsTransformerPlugin) Transform 

func (p *AnnotationsTransformerPlugin) Transform(m resmap.ResMap) 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)

func (*ConfigMapGeneratorPlugin) Generate 

func (p *ConfigMapGeneratorPlugin) Generate() (resmap.ResMap, error)

type HashTransformerPlugin 

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

func (*HashTransformerPlugin) Config 

func (p *HashTransformerPlugin) Config(
	h *resmap.PluginHelpers, _ []byte) (err error)

func (*HashTransformerPlugin) Transform 

func (p *HashTransformerPlugin) Transform(m resmap.ResMap) error

Transform appends hash to generated resources.

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)

func (*ImageTagTransformerPlugin) Transform 

func (p *ImageTagTransformerPlugin) Transform(m resmap.ResMap) 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)

func (*LabelTransformerPlugin) Transform 

func (p *LabelTransformerPlugin) Transform(m resmap.ResMap) 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.

func (*LegacyOrderTransformerPlugin) Transform 

func (p *LegacyOrderTransformerPlugin) Transform(m resmap.ResMap) (err error)

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"`

	// YAMLSupport can be set to true to use the kyaml filter instead of the
	// kunstruct transformer.
	// TODO: change the default to use kyaml when it is stable
	YAMLSupport bool `json:"yamlSupport,omitempty" yaml:"yamlSupport,omitempty"`
}

Change or set the namespace of non-cluster level resources.

func (*NamespaceTransformerPlugin) Config 

func (p *NamespaceTransformerPlugin) Config(
	_ *resmap.PluginHelpers, c []byte) (err error)

func (*NamespaceTransformerPlugin) Transform 

func (p *NamespaceTransformerPlugin) Transform(m resmap.ResMap) error

type PatchJson6902TransformerPlugin 

type PatchJson6902TransformerPlugin struct {
	Target types.PatchTarget `json:"target,omitempty" yaml:"target,omitempty"`
	Path   string            `json:"path,omitempty" yaml:"path,omitempty"`
	JsonOp string            `json:"jsonOp,omitempty" yaml:"jsonOp,omitempty"`

	YAMLSupport bool `json:"yamlSupport,omitempty" yaml:"yamlSupport,omitempty"`
	// contains filtered or unexported fields
}

func (*PatchJson6902TransformerPlugin) Config 

func (p *PatchJson6902TransformerPlugin) Config(
	h *resmap.PluginHelpers, c []byte) (err error)

func (*PatchJson6902TransformerPlugin) Transform 

func (p *PatchJson6902TransformerPlugin) Transform(m resmap.ResMap) error

type PatchStrategicMergeTransformerPlugin 

type PatchStrategicMergeTransformerPlugin struct {
	Paths   []types.PatchStrategicMerge `json:"paths,omitempty" yaml:"paths,omitempty"`
	Patches string                      `json:"patches,omitempty" yaml:"patches,omitempty"`

	YAMLSupport bool `json:"yamlSupport,omitempty" yaml:"yamlSupport,omitempty"`
	// contains filtered or unexported fields
}

func (*PatchStrategicMergeTransformerPlugin) Config 

func (p *PatchStrategicMergeTransformerPlugin) Config(
	h *resmap.PluginHelpers, c []byte) (err error)

func (*PatchStrategicMergeTransformerPlugin) Transform 

func (p *PatchStrategicMergeTransformerPlugin) Transform(m resmap.ResMap) 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"`

	YAMLSupport bool `json:"yamlSupport,omitempty" yaml:"yamlSupport,omitempty"`
	// contains filtered or unexported fields
}

func (*PatchTransformerPlugin) Config 

func (p *PatchTransformerPlugin) Config(
	h *resmap.PluginHelpers, c []byte) error

func (*PatchTransformerPlugin) Transform 

func (p *PatchTransformerPlugin) Transform(m resmap.ResMap) error

type PrefixSuffixTransformerPlugin 

type PrefixSuffixTransformerPlugin struct {
	Prefix     string            `json:"prefix,omitempty" yaml:"prefix,omitempty"`
	Suffix     string            `json:"suffix,omitempty" yaml:"suffix,omitempty"`
	FieldSpecs []types.FieldSpec `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)

func (*PrefixSuffixTransformerPlugin) Transform 

func (p *PrefixSuffixTransformerPlugin) Transform(m resmap.ResMap) 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)

func (*ReplicaCountTransformerPlugin) Transform 

func (p *ReplicaCountTransformerPlugin) Transform(m resmap.ResMap) 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)

func (*SecretGeneratorPlugin) Generate 

func (p *SecretGeneratorPlugin) Generate() (resmap.ResMap, 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

func (*ValueAddTransformerPlugin) Transform added in v0.3.3 

func (p *ValueAddTransformerPlugin) Transform(m resmap.ResMap) (err error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.