Documentation ¶
Index ¶
- Variables
- func Activate(registry *ProcessorTypes)
- func ActivateAdd(registry *ProcessorTypes)
- func ActivateCleanup(registry *ProcessorTypes)
- func ActivateConfigHash(registry *ProcessorTypes)
- func ActivateDaemonToStateful(registry *ProcessorTypes)
- func ActivateEnv(registry *ProcessorTypes)
- func ActivateImageSet(registry *ProcessorTypes)
- func ActivateInit(registry *ProcessorTypes)
- func ActivateK8sWriter(registry *ProcessorTypes)
- func ActivateKustomize(registry *ProcessorTypes)
- func ActivateMerge(registry *ProcessorTypes)
- func ActivateMount(registry *ProcessorTypes)
- func ActivateNameFilter(registry *ProcessorTypes)
- func ActivateNamespace(registry *ProcessorTypes)
- func ActivatePatch(registry *ProcessorTypes)
- func ActivatePipe(registry *ProcessorTypes)
- func ActivatePrefix(registry *ProcessorTypes)
- func ActivatePublishService(registry *ProcessorTypes)
- func ActivatePublishStatefulset(registry *ProcessorTypes)
- func ActivateRemove(registry *ProcessorTypes)
- func ActivateReplace(registry *ProcessorTypes)
- func ActivateRun(registry *ProcessorTypes)
- func ActivateSubstitute(registry *ProcessorTypes)
- func CreateOutputFileName(name string, kind string) string
- func DeepCopy(src *data.MapNode) *data.MapNode
- func LocateImportedDir(basedir string, dir string, sources []data.Source, ...) (data.Source, error)
- func ToSimpleYaml(resource *data.Resource) interface{}
- type Add
- type Change
- type Cleanup
- type Compat
- type Composite
- func (c *Composite) After(ctx *RenderContext, node *ResourceNode) error
- func (c *Composite) AfterList(node *data.ListNode)
- func (c *Composite) AfterListItem(node *data.ListNode, item data.Node, index int)
- func (c *Composite) AfterMap(node *data.MapNode)
- func (c *Composite) AfterMapItem(node *data.MapNode, key string, index int)
- func (c *Composite) AfterResource(resource *data.Resource) error
- func (c *Composite) Before(ctx *RenderContext, node *ResourceNode) error
- func (c *Composite) BeforeList(node *data.ListNode)
- func (c *Composite) BeforeListItem(node *data.ListNode, item data.Node, index int)
- func (c *Composite) BeforeMap(node *data.MapNode)
- func (c *Composite) BeforeMapItem(node *data.MapNode, key string, index int)
- func (c *Composite) BeforeResource(resource *data.Resource) error
- func (c *Composite) OnKey(node *data.KeyNode)
- func (c *Composite) RegisterResources(ctx *RenderContext, node *ResourceNode) error
- func (processor *Composite) ToString() string
- type ConfigHash
- type DaemonToStatefulSet
- type DefaultProcessor
- func (processor *DefaultProcessor) After(ctx *RenderContext, node *ResourceNode) error
- func (p *DefaultProcessor) AfterResource(*data.Resource) error
- func (processor *DefaultProcessor) Before(ctx *RenderContext, node *ResourceNode) error
- func (p *DefaultProcessor) BeforeResource(resource *data.Resource) error
- func (processor *DefaultProcessor) GetScope() string
- func (processor *DefaultProcessor) GetType() string
- func (processor *DefaultProcessor) RegisterResources(ctx *RenderContext, node *ResourceNode) error
- func (processor *DefaultProcessor) SetScope(scope string)
- func (processor *DefaultProcessor) ToString() string
- type Env
- type Image
- type K8sWriter
- type Kustomize
- type Merge
- type Mount
- type NameFilter
- type Namespace
- type Patch
- type Pipe
- type Prefix
- type Processor
- type ProcessorDefinition
- type ProcessorFactory
- type ProcessorMetadata
- type ProcessorParameter
- type ProcessorTypes
- func (pt *ProcessorTypes) Add(definition ProcessorDefinition)
- func (pt *ProcessorTypes) Create(name string, parameters map[string]string) (Processor, error)
- func (registry *ProcessorTypes) CreateTransformation(processorTypeName string) (Processor, error)
- func (registry *ProcessorTypes) CreateTransformationWithConfig(processorTypeName string, config *yaml.MapSlice) (Processor, error)
- func (registry *ProcessorTypes) ParseTransformations(inputDir string) ([]Processor, error)
- func (registry *ProcessorTypes) ReadProcessorDefinition(data []byte) ([]Processor, error)
- func (registry *ProcessorTypes) ReadProcessorDefinitionFile(filename string) ([]Processor, error)
- type PublishService
- type Remove
- type RenderContext
- func CreateRenderContext(mode string, inputDir string, outputDir string) *RenderContext
- func CreateRenderContextFromDir(inputDir string) *RenderContext
- func TestDirAndCompare(t *testing.T, inputDir string, outputDir string, expectedDir string) *RenderContext
- func TestExample(t *testing.T, name string) *RenderContext
- func TestFromDir(t *testing.T, dir string) *RenderContext
- func (context *RenderContext) AddAdHocTransformations(transformations []string) error
- func (context *RenderContext) AddResources(resources ...*data.Resource)
- func (context *RenderContext) AppendCustomProcessor(name string, parameters map[string]string) error
- func (context *RenderContext) AppendProcessor(processor Processor)
- func (context *RenderContext) Init() error
- func (context *RenderContext) InitializeTransformations() error
- func (context *RenderContext) ListResourceNodes() []*ResourceNode
- func (ctx *RenderContext) LoadDefinitions() error
- func (context *RenderContext) LoadResourceTree() error
- func (ctx *RenderContext) Render() error
- func (context *RenderContext) Resources() []*data.Resource
- type Replace
- type ResourceLocation
- type ResourceNode
- func (node *ResourceNode) AllResources() []*data.Resource
- func (node *ResourceNode) Execute(context *RenderContext, functionCall execute) error
- func (context *ResourceNode) FindChildResource(path string) (*ResourceNode, error)
- func (node *ResourceNode) InitFromConfig(conf data.Configuration, sourceCache *data.SourceCacheManager, ...) error
- func (node *ResourceNode) InitFromDir(sourceCache *data.SourceCacheManager, outputDir string) error
- func (node *ResourceNode) InitializeTransformations(context *RenderContext) error
- func (node *ResourceNode) LoadDefinitions(registry *ProcessorTypes) error
- type Run
- type Substitute
- type ToStringBuilder
- type TransformationRepository
- type Trigger
Constants ¶
This section is empty.
Variables ¶
View Source
var PathDoc = `` /* 1395-byte string literal not displayed */
View Source
var PathParameter = ProcessorParameter{
Name: "path",
Description: "A string array to define the path of the transformation in the kubernetes yaml.",
}
View Source
var TriggerDoc = `` /* 509-byte string literal not displayed */
View Source
var TriggerParameter = ProcessorParameter{
Name: "trigger",
Description: "A yaml struct to define the condition when the rule, should be applied.",
}
Functions ¶
func Activate ¶
func Activate(registry *ProcessorTypes)
func ActivateAdd ¶
func ActivateAdd(registry *ProcessorTypes)
func ActivateCleanup ¶
func ActivateCleanup(registry *ProcessorTypes)
func ActivateConfigHash ¶
func ActivateConfigHash(registry *ProcessorTypes)
func ActivateDaemonToStateful ¶
func ActivateDaemonToStateful(registry *ProcessorTypes)
func ActivateEnv ¶
func ActivateEnv(registry *ProcessorTypes)
func ActivateImageSet ¶
func ActivateImageSet(registry *ProcessorTypes)
func ActivateInit ¶
func ActivateInit(registry *ProcessorTypes)
func ActivateK8sWriter ¶
func ActivateK8sWriter(registry *ProcessorTypes)
func ActivateKustomize ¶
func ActivateKustomize(registry *ProcessorTypes)
func ActivateMerge ¶
func ActivateMerge(registry *ProcessorTypes)
func ActivateMount ¶
func ActivateMount(registry *ProcessorTypes)
func ActivateNameFilter ¶
func ActivateNameFilter(registry *ProcessorTypes)
func ActivateNamespace ¶
func ActivateNamespace(registry *ProcessorTypes)
func ActivatePatch ¶
func ActivatePatch(registry *ProcessorTypes)
func ActivatePipe ¶
func ActivatePipe(registry *ProcessorTypes)
func ActivatePrefix ¶
func ActivatePrefix(registry *ProcessorTypes)
func ActivatePublishService ¶
func ActivatePublishService(registry *ProcessorTypes)
func ActivatePublishStatefulset ¶
func ActivatePublishStatefulset(registry *ProcessorTypes)
func ActivateRemove ¶
func ActivateRemove(registry *ProcessorTypes)
func ActivateReplace ¶
func ActivateReplace(registry *ProcessorTypes)
func ActivateRun ¶
func ActivateRun(registry *ProcessorTypes)
func ActivateSubstitute ¶
func ActivateSubstitute(registry *ProcessorTypes)
func CreateOutputFileName ¶
func LocateImportedDir ¶
func LocateImportedDir(basedir string, dir string, sources []data.Source, cacheManager *data.SourceCacheManager, excludedDirs []string) (data.Source, error)
try to find the first Source which contains the dir
func ToSimpleYaml ¶
Types ¶
type Add ¶
type Add struct { DefaultProcessor Path data.Path Trigger Trigger Value interface{} Yamlize bool }
type Change ¶
type Cleanup ¶
type Cleanup struct { DefaultProcessor ResourceOutputDir string All bool // contains filtered or unexported fields }
func (*Cleanup) After ¶
func (processor *Cleanup) After(ctx *RenderContext, node *ResourceNode) error
func (*Cleanup) AfterResource ¶
func (*Cleanup) Before ¶
func (cleanup *Cleanup) Before(ctx *RenderContext, node *ResourceNode) error
type Compat ¶
type Compat struct { DefaultProcessor Version string }
type Composite ¶
type Composite struct { DefaultProcessor ProcessorMetadata AdditionalResourcesDir string Processors []Processor File string Template string Parameters map[string]string Trigger Trigger }
func (*Composite) After ¶
func (c *Composite) After(ctx *RenderContext, node *ResourceNode) error
func (*Composite) AfterListItem ¶
func (*Composite) AfterMapItem ¶
func (*Composite) Before ¶
func (c *Composite) Before(ctx *RenderContext, node *ResourceNode) error
func (*Composite) BeforeList ¶
func (*Composite) BeforeListItem ¶
func (*Composite) BeforeMapItem ¶
func (*Composite) BeforeResource ¶
func (*Composite) RegisterResources ¶
func (c *Composite) RegisterResources(ctx *RenderContext, node *ResourceNode) error
type ConfigHash ¶
type ConfigHash struct { DefaultProcessor Trigger Trigger // contains filtered or unexported fields }
func (*ConfigHash) Before ¶
func (processor *ConfigHash) Before(ctx *RenderContext, node *ResourceNode) error
func (*ConfigHash) BeforeResource ¶
func (p *ConfigHash) BeforeResource(resource *data.Resource) error
type DaemonToStatefulSet ¶
type DaemonToStatefulSet struct { DefaultProcessor Trigger Trigger }
func (*DaemonToStatefulSet) Before ¶
func (processor *DaemonToStatefulSet) Before(ctx *RenderContext, node *ResourceNode) error
func (*DaemonToStatefulSet) BeforeResource ¶
func (processor *DaemonToStatefulSet) BeforeResource(resource *data.Resource) error
type DefaultProcessor ¶
type DefaultProcessor struct { data.DefaultVisitor Type string Scope string File string CurrentResource *data.Resource }
func (*DefaultProcessor) After ¶
func (processor *DefaultProcessor) After(ctx *RenderContext, node *ResourceNode) error
func (*DefaultProcessor) AfterResource ¶
func (p *DefaultProcessor) AfterResource(*data.Resource) error
func (*DefaultProcessor) Before ¶
func (processor *DefaultProcessor) Before(ctx *RenderContext, node *ResourceNode) error
func (*DefaultProcessor) BeforeResource ¶
func (p *DefaultProcessor) BeforeResource(resource *data.Resource) error
func (*DefaultProcessor) GetScope ¶
func (processor *DefaultProcessor) GetScope() string
func (*DefaultProcessor) GetType ¶
func (processor *DefaultProcessor) GetType() string
func (*DefaultProcessor) RegisterResources ¶
func (processor *DefaultProcessor) RegisterResources(ctx *RenderContext, node *ResourceNode) error
func (*DefaultProcessor) SetScope ¶
func (processor *DefaultProcessor) SetScope(scope string)
func (*DefaultProcessor) ToString ¶
func (processor *DefaultProcessor) ToString() string
type Image ¶
type Image struct { DefaultProcessor Image string Trigger Trigger }
type K8sWriter ¶
type K8sWriter struct { DefaultProcessor // contains filtered or unexported fields }
func CreateStdK8sWriter ¶
func CreateStdK8sWriter() *K8sWriter
func (*K8sWriter) Before ¶
func (writer *K8sWriter) Before(ctx *RenderContext, node *ResourceNode) error
func (*K8sWriter) BeforeResource ¶
type Kustomize ¶
type Kustomize struct {
DefaultProcessor
}
func (*Kustomize) Before ¶
func (writer *Kustomize) Before(ctx *RenderContext, node *ResourceNode) error
type Merge ¶
type Merge struct { DefaultProcessor Trigger Trigger // contains filtered or unexported fields }
type Mount ¶
type Mount struct { DefaultProcessor Trigger Trigger HostPath string `yaml:"hostPath"` Path string Name string }
type NameFilter ¶
type NameFilter struct { DefaultProcessor Include []string Exclude []string }
func (*NameFilter) BeforeResource ¶
func (nf *NameFilter) BeforeResource(resource *data.Resource) error
func (*NameFilter) ToString ¶
func (nf *NameFilter) ToString() string
type Namespace ¶
type Namespace struct { DefaultProcessor Namespace string Force bool ClusterRoleSupport bool }
func (*Namespace) BeforeResource ¶
type Patch ¶
type Patch struct { DefaultProcessor Op string Value interface{} Path string Trigger Trigger }
type Prefix ¶
type Prefix struct { DefaultProcessor Prefix string HostNames []string }
func (*Prefix) Before ¶
func (p *Prefix) Before(ctx *RenderContext, node *ResourceNode) error
type Processor ¶
type Processor interface { data.Visitor RegisterResources(ctx *RenderContext, node *ResourceNode) error Before(ctx *RenderContext, node *ResourceNode) error After(ctx *RenderContext, node *ResourceNode) error GetType() string BeforeResource(*data.Resource) error AfterResource(*data.Resource) error GetScope() string SetScope(scope string) ToString() string }
func CreateCleanup ¶
type ProcessorDefinition ¶
type ProcessorDefinition struct { Metadata ProcessorMetadata //metadata to define the name and available parameters Factory ProcessorFactory //the factory the create the struct }
type ProcessorMetadata ¶
type ProcessorMetadata struct { Name string Description string Parameters []ProcessorParameter `yaml:"parameters"` Doc string Resources string //directory point to additional resources }
func ParseDefinition ¶
func ParseDefinition(date []byte) (ProcessorMetadata, string, error)
func (*ProcessorMetadata) FindParam ¶
func (metadata *ProcessorMetadata) FindParam(name string) *ProcessorParameter
type ProcessorParameter ¶
type ProcessorTypes ¶
type ProcessorTypes struct {
TypeMap map[string]ProcessorDefinition
}
The main processor registry
func NewRegistry ¶
func NewRegistry() *ProcessorTypes
func (*ProcessorTypes) Add ¶
func (pt *ProcessorTypes) Add(definition ProcessorDefinition)
func (*ProcessorTypes) CreateTransformation ¶
func (registry *ProcessorTypes) CreateTransformation(processorTypeName string) (Processor, error)
func (*ProcessorTypes) CreateTransformationWithConfig ¶
func (*ProcessorTypes) ParseTransformations ¶
func (registry *ProcessorTypes) ParseTransformations(inputDir string) ([]Processor, error)
read transformations from ./transformations/... files
func (*ProcessorTypes) ReadProcessorDefinition ¶
func (registry *ProcessorTypes) ReadProcessorDefinition(data []byte) ([]Processor, error)
ReadProcessorDefinition reads processor definitions from raw yaml file.
func (*ProcessorTypes) ReadProcessorDefinitionFile ¶
func (registry *ProcessorTypes) ReadProcessorDefinitionFile(filename string) ([]Processor, error)
read processor definitions from a file (./definitions/xxx)
type PublishService ¶
type PublishService struct { DefaultProcessor Trigger Trigger ServiceType string `yaml:"serviceType"` NodePorts map[string]int `yaml:"nodePorts"` }
func (*PublishService) Before ¶
func (processor *PublishService) Before(ctx *RenderContext, node *ResourceNode) error
func (*PublishService) ToString ¶
func (processor *PublishService) ToString() string
type RenderContext ¶
type RenderContext struct { OutputDir string Conf data.Configuration Mode string ImageOverride string Namespace string Registry *ProcessorTypes RootResource *ResourceNode }
func CreateRenderContext ¶
func CreateRenderContext(mode string, inputDir string, outputDir string) *RenderContext
func CreateRenderContextFromDir ¶
func CreateRenderContextFromDir(inputDir string) *RenderContext
func TestDirAndCompare ¶
func TestExample ¶
func TestExample(t *testing.T, name string) *RenderContext
func TestFromDir ¶
func TestFromDir(t *testing.T, dir string) *RenderContext
func (*RenderContext) AddAdHocTransformations ¶
func (context *RenderContext) AddAdHocTransformations(transformations []string) error
func (*RenderContext) AddResources ¶
func (context *RenderContext) AddResources(resources ...*data.Resource)
func (*RenderContext) AppendCustomProcessor ¶
func (context *RenderContext) AppendCustomProcessor(name string, parameters map[string]string) error
func (*RenderContext) AppendProcessor ¶
func (context *RenderContext) AppendProcessor(processor Processor)
func (*RenderContext) Init ¶
func (context *RenderContext) Init() error
func (*RenderContext) InitializeTransformations ¶
func (context *RenderContext) InitializeTransformations() error
func (*RenderContext) ListResourceNodes ¶
func (context *RenderContext) ListResourceNodes() []*ResourceNode
func (*RenderContext) LoadDefinitions ¶
func (ctx *RenderContext) LoadDefinitions() error
LoadDefinitions load. transformation definitions from ./definitions dir (all dir).
func (*RenderContext) LoadResourceTree ¶
func (context *RenderContext) LoadResourceTree() error
func (*RenderContext) Render ¶
func (ctx *RenderContext) Render() error
execute all the transformations in the rendercontext.
func (*RenderContext) Resources ¶
func (context *RenderContext) Resources() []*data.Resource
List all the resources from the resource tree.
type Replace ¶
type Replace struct { DefaultProcessor Path data.Path Trigger Trigger Value interface{} }
func (*Replace) BeforeResource ¶
type ResourceLocation ¶
type ResourceNode ¶
type ResourceNode struct { Name string //the original import name used in FLekszible files Dir string //absolut path of the current dir Origin data.Source //source used to load the resource Destination string Resources []*data.Resource Children []*ResourceNode PreImportTransformations []byte Source []data.Source ProcessorRepository *TransformationRepository ResourcesDir string Definitions []string //definitions loaded from this dir }
func CreateResourceNode ¶
func (*ResourceNode) AllResources ¶
func (node *ResourceNode) AllResources() []*data.Resource
func (*ResourceNode) Execute ¶
func (node *ResourceNode) Execute(context *RenderContext, functionCall execute) error
func (*ResourceNode) FindChildResource ¶
func (context *ResourceNode) FindChildResource(path string) (*ResourceNode, error)
func (*ResourceNode) InitFromConfig ¶
func (node *ResourceNode) InitFromConfig(conf data.Configuration, sourceCache *data.SourceCacheManager, outputDir string) error
InitFromConfig initializes and reads all dependencies based on parsed config.
func (*ResourceNode) InitFromDir ¶
func (node *ResourceNode) InitFromDir(sourceCache *data.SourceCacheManager, outputDir string) error
InitFromDir parses the directory structure and the flekszible configs from the dirs.
func (*ResourceNode) InitializeTransformations ¶
func (node *ResourceNode) InitializeTransformations(context *RenderContext) error
func (*ResourceNode) LoadDefinitions ¶
func (node *ResourceNode) LoadDefinitions(registry *ProcessorTypes) error
type Run ¶
type Run struct { DefaultProcessor Args string Trigger Trigger }
type Substitute ¶
type Substitute struct { DefaultProcessor Trigger Trigger From string To string }
func (*Substitute) BeforeResource ¶
func (st *Substitute) BeforeResource(resource *data.Resource) error
func (*Substitute) ToString ¶
func (st *Substitute) ToString() string
type ToStringBuilder ¶
type ToStringBuilder struct {
// contains filtered or unexported fields
}
func CreateToString ¶
func CreateToString(name string) *ToStringBuilder
func (*ToStringBuilder) Add ¶
func (builder *ToStringBuilder) Add(key string, value string) *ToStringBuilder
func (*ToStringBuilder) AddBool ¶
func (builder *ToStringBuilder) AddBool(key string, value bool) *ToStringBuilder
func (*ToStringBuilder) AddValue ¶
func (builder *ToStringBuilder) AddValue(key string, value interface{}) *ToStringBuilder
func (*ToStringBuilder) Build ¶
func (builder *ToStringBuilder) Build() string
type TransformationRepository ¶
type TransformationRepository struct {
Processors []Processor
}
the instatiated transformations for a specific run
func CreateProcessorRepository ¶
func CreateProcessorRepository() *TransformationRepository
func (*TransformationRepository) Append ¶
func (repository *TransformationRepository) Append(processor Processor)
func (*TransformationRepository) AppendAll ¶
func (repository *TransformationRepository) AppendAll(processors []Processor)
func (*TransformationRepository) InsertToBeginning ¶
func (repository *TransformationRepository) InsertToBeginning(processor Processor)
Source Files ¶
- add.go
- change.go
- cleanup.go
- compat.go
- composite.go
- confighash.go
- context.go
- daemontostateful.go
- default_parameter.go
- definition.go
- env.go
- imageset.go
- k8swriter.go
- kustomize.go
- merge.go
- mount.go
- namefilter.go
- namespace.go
- patch.go
- pipe.go
- prefix.go
- processor.go
- processor_registry.go
- publishservice.go
- publishstatefulset.go
- remove.go
- replace.go
- run.go
- substitute.go
- testutil.go
- transformation_repo.go
- trigger.go
Click to show internal directories.
Click to hide internal directories.