config

Documentation

Index

• Constants
• func Validate(cfg Config) error
• type Config
  • func Default() Config
  • func Load(repoRoot string) (*Config, error)
  • func LoadPath(configPath string) (*Config, error)
• type ContextsConfig
• type LayoutConfig
  • func (layout LayoutConfig) MirroredGroupByName(name string) (MirroredGroup, error)
  • func (layout LayoutConfig) MirroredGroupForRelPath(relPath string) (MirroredGroup, error)
  • func (layout LayoutConfig) ResolvedMirroredGroups() ([]MirroredGroup, error)
• type MirroredGroup
  • func (group MirroredGroup) ChartDir(repoRoot string, relPath string) (string, error)
  • func (group MirroredGroup) PathRoot() string
  • func (group MirroredGroup) RelativeSuffix(relPath string) (string, error)
  • func (group MirroredGroup) ValuesDir(repoRoot string, relPath string) (string, error)
• type NamingConfig
• type ValidationConfig

Constants

const (
	StructureService       = "service"
	StructureDomainService = "domain-service"
)

const FileName = "platformctl.yaml"

Functions

func Validate

func Validate(cfg Config) error

Types

type Config

type Config struct {
	APIVersion string           `yaml:"apiVersion"`
	Kind       string           `yaml:"kind"`
	Layout     LayoutConfig     `yaml:"layout"`
	Validation ValidationConfig `yaml:"validation"`
	Naming     NamingConfig     `yaml:"naming"`
	Contexts   ContextsConfig   `yaml:"contexts"`
}

func Default

func Default() Config

func Load

func Load(repoRoot string) (*Config, error)

func LoadPath

func LoadPath(configPath string) (*Config, error)

type ContextsConfig

type ContextsConfig struct {
	Default string                    `yaml:"default"`
	Items   map[string]map[string]any `yaml:"items"`
}

type LayoutConfig

type LayoutConfig struct {
	MirroredGroups       []MirroredGroup `yaml:"mirroredGroups"`
	OutputRoot           string          `yaml:"outputRoot"`
	RequireMirroredPaths bool            `yaml:"requireMirroredPaths"`
}

func (LayoutConfig) MirroredGroupByName

func (layout LayoutConfig) MirroredGroupByName(name string) (MirroredGroup, error)

func (LayoutConfig) MirroredGroupForRelPath

func (layout LayoutConfig) MirroredGroupForRelPath(relPath string) (MirroredGroup, error)

func (LayoutConfig) ResolvedMirroredGroups

func (layout LayoutConfig) ResolvedMirroredGroups() ([]MirroredGroup, error)

type MirroredGroup

type MirroredGroup struct {
	Name       string `yaml:"name"`
	ChartRoot  string `yaml:"chartRoot"`
	ValuesRoot string `yaml:"valuesRoot"`
	Structure  string `yaml:"structure"`
}

func (MirroredGroup) ChartDir

func (group MirroredGroup) ChartDir(repoRoot string, relPath string) (string, error)

func (MirroredGroup) PathRoot

func (group MirroredGroup) PathRoot() string

func (MirroredGroup) RelativeSuffix

func (group MirroredGroup) RelativeSuffix(relPath string) (string, error)

func (MirroredGroup) ValuesDir

func (group MirroredGroup) ValuesDir(repoRoot string, relPath string) (string, error)

type NamingConfig

type NamingConfig struct {
	WrapperPrefix string `yaml:"wrapperPrefix"`
}

type ValidationConfig

type ValidationConfig struct {
	RequiredCommonValues string   `yaml:"requiredCommonValues"`
	OverlayPattern       string   `yaml:"overlayPattern"`
	TestOverlayName      string   `yaml:"testOverlayName"`
	TestOverlayWarnings  []string `yaml:"testOverlayWarnings"`
}