pr

Documentation

Index

• Constants
• func Apply(template *PrTemplate) error
• type AutomationContract
• type CreateSpec
• type CreateTemplate
• type DeleteSpec
• type ListMerge
• type PrContracts
  • func BuildContracts(path string) (*PrContracts, error)
• type PrContractsSpec
• type PrTemplate
  • func Build(path string) (*PrTemplate, error)
  • func BuildCRD(path, contextFile string) (*PrTemplate, error)
• type PrTemplateSpec
• type RegexReplacement
• type TemplateCopy
• type UpdateSpec
• type YamlOverlay

Constants

const (
	ListMergeAppend    = "APPEND"
	ListMergeOverwrite = "OVERWRITE"
)

Functions

func Apply

func Apply(template *PrTemplate) error

Types

type AutomationContract

type AutomationContract struct {
	File        string `json:"file"`
	ExternalDir string `json:"externalDir,omitempty"`
	Context     string `json:"context"`
}

type CreateSpec

type CreateSpec struct {
	ExternalDir string
	Templates   []*CreateTemplate `json:"templates"`
}

type CreateTemplate

type CreateTemplate struct {
	Source      string                 `json:"source"`
	Destination string                 `json:"destination"`
	External    bool                   `json:"external"`
	Context     map[string]interface{} `json:"context,omitempty"`
	Condition   string                 `json:"condition"`
}

type DeleteSpec

type DeleteSpec struct {
	Files   []string `json:"files"`
	Folders []string `json:"folders"`
}

type ListMerge

type ListMerge string

type PrContracts

type PrContracts struct {
	ApiVersion string                 `json:"apiVersion"`
	Kind       string                 `json:"kind"`
	Metadata   map[string]interface{} `json:"metadata"`
	Context    map[string]interface{} `json:"context"`
	Spec       PrContractsSpec        `json:"spec"`
}

func BuildContracts

func BuildContracts(path string) (*PrContracts, error)

type PrContractsSpec

type PrContractsSpec struct {
	Templates   *TemplateCopy        `json:"templates"`
	Workdir     string               `json:"workdir,omitempty"`
	Automations []AutomationContract `json:"automations"`
}

type PrTemplate

type PrTemplate struct {
	ApiVersion string                 `json:"apiVersion"`
	Kind       string                 `json:"kind"`
	Metadata   map[string]interface{} `json:"metadata"`
	Context    map[string]interface{} `json:"context"`
	Spec       PrTemplateSpec         `json:"spec"`
}

func Build

func Build(path string) (*PrTemplate, error)

func BuildCRD

func BuildCRD(path, contextFile string) (*PrTemplate, error)

type PrTemplateSpec

type PrTemplateSpec struct {
	Updates *UpdateSpec `json:"updates"`
	Creates *CreateSpec `json:"creates"`
	Deletes *DeleteSpec `json:"deletes"`
}

type RegexReplacement

type RegexReplacement struct {
	Regex       string `json:"regex"`
	Replacement string `json:"replacement"`
	File        string `json:"file"`
	Templated   bool   `json:"templated"`
}

type TemplateCopy

type TemplateCopy struct {
	From string `json:"from"`
	To   string `json:"to"`
}

type UpdateSpec

type UpdateSpec struct {
	Regexes           []string           `json:"regexes"`
	Files             []string           `json:"files"`
	ReplaceTemplate   string             `json:"replace_template"`
	Yq                string             `json:"yq"`
	MatchStrategy     string             `json:"match_strategy"`
	RegexReplacements []RegexReplacement `json:"regex_replacements"`
	YamlOverlays      []YamlOverlay      `json:"yaml_overlays"`
}

type YamlOverlay

type YamlOverlay struct {
	File      string    `json:"file"`
	Yaml      string    `json:"yaml"`
	ListMerge ListMerge `json:"list_merge"`
	Templated bool      `json:"templated"`
}