plan

Documentation

Index

• Constants
• func MergeServices(s1 map[string][]transformertypes.Artifact, ...) map[string][]transformertypes.Artifact
• func WritePlan(path string, plan Plan) error
• type Configuration
• type Plan
  • func NewPlan() Plan
  • func ReadPlan(path string, rootDir string) (Plan, error)
• type Spec
• type TargetClusterType

Constants

const PlanKind types.Kind = "Plan"

PlanKind is kind of plan file

Functions

func MergeServices

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

MergeServices 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 Configuration

type Configuration struct {
	Transformers   map[string]string `yaml:"transformers,omitempty" m2kpath:"normal"`   //[name]filepath
	TargetClusters map[string]string `yaml:"targetClusters,omitempty" m2kpath:"normal"` //[clustername]filepath
}

Configuration stores all configurations related to the plan

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, rootDir string) (Plan, error)

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

type Spec

type Spec struct {
	RootDir             string               `yaml:"rootDir"`
	CustomizationsDir   string               `yaml:"customizationsDir,omitempty"`
	TransformerSelector metav1.LabelSelector `yaml:"transformerSelector,omitempty"`

	Services map[string][]transformertypes.Artifact `yaml:"services"` //[servicename]

	TargetCluster TargetClusterType `yaml:"targetCluster,omitempty"`
	Configuration Configuration     `yaml:"configuration,omitempty"`
}

Spec stores the data about the plan

type TargetClusterType

type TargetClusterType struct {
	Type string `yaml:"type,omitempty"`
	Path string `yaml:"path,omitempty" m2kpath:"normal"`
}

TargetClusterType contains either the type of the target cluster or path to a file containing the target cluster metadata. Specify one or the other, not both.