cicci

README

cicci - cloud config merging toolkit

Responsibilities of this package

1. Collect files (yaml + shell)
2. Expand templates (with the help of the environment and masterminds.github.io/sprig)
3. Validate shell scripts and cloud-config files
4. Generate a multi-part archive

Documentation

Index

• func CreateMultipartArchive(files []ExpandedFile) (string, error)
• func ExpandTemplate(name, tpl string, extraKeys map[string]string) (string, error)
• func ValidateCloudConfig(payload string) error
• func ValidateScript(filename, payload string) error
• type CCFile
  • func (f *CCFile) IsScript() bool
  • func (f *CCFile) IsTemplate() bool
  • func (f *CCFile) Load() (string, error)
  • func (f *CCFile) LoadAndExpand(extraKeys map[string]string) (ExpandedFile, error)
  • func (f *CCFile) NonTemplateName() string
• type CCFiles
  • func CollectFiles(inputs []string) (CCFiles, error)
  • func (files CCFiles) LoadAndExpand(extraKeys map[string]string) (result ExpandedFiles, err error)
• type ExpandedFile
  • func (e *ExpandedFile) Validate() error
• type ExpandedFiles
  • func (s ExpandedFiles) Validate() (result []error)

Functions

func CreateMultipartArchive

func CreateMultipartArchive(files []ExpandedFile) (string, error)

func ExpandTemplate

func ExpandTemplate(name, tpl string, extraKeys map[string]string) (string, error)

func ValidateCloudConfig

func ValidateCloudConfig(payload string) error

func ValidateScript

func ValidateScript(filename, payload string) error

Types

type CCFile

type CCFile string

func (*CCFile) IsScript

func (f *CCFile) IsScript() bool

func (*CCFile) IsTemplate

func (f *CCFile) IsTemplate() bool

func (*CCFile) Load

func (f *CCFile) Load() (string, error)

func (*CCFile) LoadAndExpand

func (f *CCFile) LoadAndExpand(extraKeys map[string]string) (ExpandedFile, error)

func (*CCFile) NonTemplateName

func (f *CCFile) NonTemplateName() string

type CCFiles

type CCFiles []CCFile

func CollectFiles

func CollectFiles(inputs []string) (CCFiles, error)

func (CCFiles) LoadAndExpand

func (files CCFiles) LoadAndExpand(extraKeys map[string]string) (result ExpandedFiles, err error)

type ExpandedFile

type ExpandedFile struct {
	OriginalFilename string
	Filename         string
	Content          string
	IsScript         bool
	IsTemplate       bool
}

func (*ExpandedFile) Validate

func (e *ExpandedFile) Validate() error

type ExpandedFiles

type ExpandedFiles []ExpandedFile

func (ExpandedFiles) Validate

func (s ExpandedFiles) Validate() (result []error)