plan

Documentation

Index

• Constants
• func MergeServices(s1 map[string][]PlanArtifact, s2 map[string][]PlanArtifact) map[string][]PlanArtifact
• func MergeServicesT(s1 map[string][]transformertypes.Artifact, ...) map[string][]transformertypes.Artifact
• func WritePlan(path string, plan Plan) error
• type Plan
  • func NewPlan() Plan
  • func ReadPlan(path string, sourceDir string) (Plan, error)
• type PlanArtifact
• type Spec

Constants

const PlanKind types.Kind = "Plan"

PlanKind is kind of plan file

Functions

func MergeServices

func MergeServices(s1 map[string][]PlanArtifact, s2 map[string][]PlanArtifact) map[string][]PlanArtifact

MergeServices merges two service maps

func MergeServicesT

func MergeServicesT(s1 map[string][]transformertypes.Artifact, s2 map[string][]transformertypes.Artifact) map[string][]transformertypes.Artifact

MergeServicesT merges two service maps

func WritePlan

func WritePlan(path string, plan Plan) error

WritePlan encodes the plan to yaml converting absolute paths to relative.

Types

type Plan

type Plan struct {
	types.TypeMeta   `yaml:",inline"`
	types.ObjectMeta `yaml:"metadata,omitempty"`
	Spec             Spec `yaml:"spec,omitempty"`
}

Plan defines the format of plan

func NewPlan

func NewPlan() Plan

NewPlan creates a new plan Sets the version and optionally fills in some default values

func ReadPlan

func ReadPlan(path string, sourceDir string) (Plan, error)

ReadPlan decodes the plan from yaml converting relative paths to absolute.

type PlanArtifact

type PlanArtifact struct {
	TransformerName           string `yaml:"transformerName"`
	transformertypes.Artifact `yaml:",inline"`
}

PlanArtifact stores the artifact with the transformerName

type Spec

type Spec struct {
	SourceDir         string `yaml:"sourceDir"`
	CustomizationsDir string `yaml:"customizationsDir,omitempty"`

	Services map[string][]PlanArtifact `yaml:"services"` //[servicename]

	TransformerSelector metav1.LabelSelector `yaml:"transformerSelector,omitempty"`
	Transformers        map[string]string    `yaml:"transformers,omitempty" m2kpath:"normal"` //[name]filepath
}

Spec stores the data about the plan