catalog

Documentation

Index

• type Catalog
  • func Load(opts LoadOpts) (*Catalog, error)
  • func (c *Catalog) GetFilesByKind(kind string) []*yml.File
  • func (c *Catalog) ResolveRefs() error
• type LoadOpts
• type Release
• type ReleaseList

Types

type Catalog

type Catalog struct {
	Environments []*v1alpha1.Environment
	Releases     *ReleaseList
	Projects     []*v1alpha1.Project
	Files        []*yml.File
}

func Load

func Load(opts LoadOpts) (*Catalog, error)

func (*Catalog) GetFilesByKind

func (c *Catalog) GetFilesByKind(kind string) []*yml.File

GetFilesByKind returns all files of the given kind.

func (*Catalog) ResolveRefs

func (c *Catalog) ResolveRefs() error

type LoadOpts

type LoadOpts struct {
	// Dir is the directory to load catalog from.
	Dir string

	// EnvNames is the list of environment names to load.
	EnvNames []string

	// SortByOrder controls whether environments should be sorted by their spec.order property.
	SortEnvsByOrder bool

	// ReleaseFilter allows to specify which releases to load.
	// Optional, defaults to loading all releases.
	ReleaseFilter filtering.Filter
}

LoadOpts controls how to load catalog and what to load in it.

type Release

type Release = cross.Release

Export internal catalog types so that they can worked with from code that use the public joy packages.

type ReleaseList

type ReleaseList = cross.ReleaseList

Export internal catalog types so that they can worked with from code that use the public joy packages.