component

Documentation

Index

• Variables
• func Generate(ctx context.Context, log klog.Logger, output, input, cachedir string, ...) error
• func WriteComponents(ctx context.Context, log klog.Logger, cache *Cache, fsys fs.FS, ...) error
• type Cache
  • func NewCache(repos *repofetcher.Cache, engines confengine.Map) *Cache
  • func (c *Cache) Get(ctx context.Context, kind string, spec repofetcher.Spec, dir string) (confengine.ConfEngine, error)
  • func (c *Cache) Parse(kind string, repobytes []byte) (repofetcher.Spec, error)
• type Component
  • func ParseComponents(ctx context.Context, cache *Cache, spec repofetcher.Spec, name string, ...) ([]Component, error)
• type Opts
• type RepoChecksumData
• type Template

Variables

var ErrImportCycle errImportCycle

ErrImportCycle is returned when component dependencies form a cycle

var ErrInvalidDir errInvalidDir

ErrInvalidDir is returned when the repo dir is invalid

Functions

func Generate

func Generate(ctx context.Context, log klog.Logger, output, input, cachedir string, opts Opts) error

Generate reads configs and writes components to the filesystem

func WriteComponents

func WriteComponents(ctx context.Context, log klog.Logger, cache *Cache, fsys fs.FS, components []Component, stderr io.Writer, dryrun bool) error

WriteComponents writes components to an fs

Types

type Cache

type Cache struct {
	// contains filtered or unexported fields
}

Cache is a config engine cache by path

func NewCache

func NewCache(repos *repofetcher.Cache, engines confengine.Map) *Cache

NewCache creates a new *Cache

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, kind string, spec repofetcher.Spec, dir string) (confengine.ConfEngine, error)

func (*Cache) Parse

func (c *Cache) Parse(kind string, repobytes []byte) (repofetcher.Spec, error)

type Component

type Component struct {
	Spec      repofetcher.Spec
	Dir       string
	Templates []Template
}

Component is a package of files to generate

func ParseComponents

func ParseComponents(ctx context.Context, cache *Cache, spec repofetcher.Spec, name string, stderr io.Writer) ([]Component, error)

ParseComponents parses component configs to Component

type Opts

type Opts struct {
	DryRun           bool
	NoNetwork        bool
	ForceFetch       bool
	RepoChecksumFile string
	GitDir           string
	GitBin           string
	GitBinQuiet      bool
	JsonnetLibName   string
}

Opts holds generation opts

type RepoChecksumData

type RepoChecksumData struct {
	Repos []repofetcher.RepoChecksum `json:"repos"`
}

RepoChecksumData is the shape of a repo checksum file

type Template

type Template struct {
	Kind   string         `json:"kind"`
	Path   string         `json:"path"`
	Args   map[string]any `json:"args"`
	Output string         `json:"output"`
}

Template is a file to generate