composite

Documentation

Index

• Constants
• func FetchCatalogConfig(path string, httpGetter HttpGetter) (io.ReadCloser, error)
• type BasicBuilder
  • func NewBasicBuilder(builderCfg BuilderConfig) *BasicBuilder
  • func (bb *BasicBuilder) Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error
  • func (bb *BasicBuilder) Validate(ctx context.Context, dir string) error
• type BasicConfig
• type BuildStrategy
• type Builder
• type BuilderConfig
• type BuilderMap
• type Catalog
• type CatalogBuilderMap
• type CatalogConfig
• type CatalogDestination
• type Component
• type ComponentDestination
• type CompositeConfig
• type CustomBuilder
  • func NewCustomBuilder(builderCfg BuilderConfig) *CustomBuilder
  • func (cb *CustomBuilder) Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error
  • func (cb *CustomBuilder) Validate(ctx context.Context, dir string) error
• type CustomConfig
• type HttpGetter
• type RawBuilder
  • func NewRawBuilder(builderCfg BuilderConfig) *RawBuilder
  • func (rb *RawBuilder) Build(ctx context.Context, _ image.Registry, dir string, td TemplateDefinition) error
  • func (rb *RawBuilder) Validate(ctx context.Context, dir string) error
• type RawConfig
• type SemverBuilder
  • func NewSemverBuilder(builderCfg BuilderConfig) *SemverBuilder
  • func (sb *SemverBuilder) Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error
  • func (sb *SemverBuilder) Validate(ctx context.Context, dir string) error
• type SemverConfig
• type Specs
• type Template
  • func NewTemplate(opts ...TemplateOption) *Template
  • func (t *Template) Parse() (*Specs, error)
  • func (t *Template) Render(ctx context.Context, validate bool) error
• type TemplateDefinition
• type TemplateOption
  • func WithCatalogFile(catalogFile io.Reader) TemplateOption
  • func WithContributionFile(contribFile io.Reader) TemplateOption
  • func WithOutputType(outputType string) TemplateOption
  • func WithRegistry(reg image.Registry) TemplateOption
  • func WithValidate(validate bool) TemplateOption

Constants

const (
	BasicBuilderSchema  = "olm.builder.basic"
	SemverBuilderSchema = "olm.builder.semver"
	RawBuilderSchema    = "olm.builder.raw"
	CustomBuilderSchema = "olm.builder.custom"
)

const (
	CompositeSchema = "olm.composite"
	CatalogSchema   = "olm.composite.catalogs"
)

Functions

func FetchCatalogConfig

func FetchCatalogConfig(path string, httpGetter HttpGetter) (io.ReadCloser, error)

FetchCatalogConfig will fetch the catalog configuration file from the given path. The path can be a local file path OR a URL that returns the raw contents of the catalog configuration file. The filepath can be structured relative or as an absolute path

Types

type BasicBuilder

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

func NewBasicBuilder

func NewBasicBuilder(builderCfg BuilderConfig) *BasicBuilder

func (*BasicBuilder) Build

func (bb *BasicBuilder) Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error

func (*BasicBuilder) Validate

func (bb *BasicBuilder) Validate(ctx context.Context, dir string) error

type BasicConfig

type BasicConfig struct {
	Input  string
	Output string
}

type BuildStrategy

type BuildStrategy struct {
	Name     string
	Template TemplateDefinition
}

type Builder

type Builder interface {
	Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error
	Validate(ctx context.Context, dir string) error
}

type BuilderConfig

type BuilderConfig struct {
	WorkingDir string
	OutputType string
}

type BuilderMap

type BuilderMap map[string]Builder

type Catalog

type Catalog struct {
	Name        string
	Destination CatalogDestination
	Builders    []string
}

type CatalogBuilderMap

type CatalogBuilderMap map[string]BuilderMap

type CatalogConfig

type CatalogConfig struct {
	Schema   string
	Catalogs []Catalog
}

type CatalogDestination

type CatalogDestination struct {
	// BaseImage  string
	WorkingDir string
}

type Component

type Component struct {
	Name        string
	Destination ComponentDestination
	Strategy    BuildStrategy
}

type ComponentDestination

type ComponentDestination struct {
	Path string
}

type CompositeConfig

type CompositeConfig struct {
	Schema     string
	Components []Component
}

type CustomBuilder

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

func NewCustomBuilder

func NewCustomBuilder(builderCfg BuilderConfig) *CustomBuilder

func (*CustomBuilder) Build

func (cb *CustomBuilder) Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error

func (*CustomBuilder) Validate

func (cb *CustomBuilder) Validate(ctx context.Context, dir string) error

type CustomConfig

type CustomConfig struct {
	Command string
	Args    []string
	Output  string
}

type HttpGetter

type HttpGetter interface {
	Get(url string) (*http.Response, error)
}

type RawBuilder

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

func NewRawBuilder

func NewRawBuilder(builderCfg BuilderConfig) *RawBuilder

func (*RawBuilder) Build

func (rb *RawBuilder) Build(ctx context.Context, _ image.Registry, dir string, td TemplateDefinition) error

func (*RawBuilder) Validate

func (rb *RawBuilder) Validate(ctx context.Context, dir string) error

type RawConfig

type RawConfig struct {
	Input  string
	Output string
}

type SemverBuilder

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

func NewSemverBuilder

func NewSemverBuilder(builderCfg BuilderConfig) *SemverBuilder

func (*SemverBuilder) Build

func (sb *SemverBuilder) Build(ctx context.Context, reg image.Registry, dir string, td TemplateDefinition) error

func (*SemverBuilder) Validate

func (sb *SemverBuilder) Validate(ctx context.Context, dir string) error

type SemverConfig

type SemverConfig struct {
	Input  string
	Output string
}

type Specs

type Specs struct {
	CatalogSpec      *CatalogConfig
	ContributionSpec *CompositeConfig
}

type Template

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

func NewTemplate

func NewTemplate(opts ...TemplateOption) *Template

func (*Template) Parse

func (t *Template) Parse() (*Specs, error)

func (*Template) Render

func (t *Template) Render(ctx context.Context, validate bool) error

type TemplateDefinition

type TemplateDefinition struct {
	Schema string
	Config json.RawMessage
}

type TemplateOption

type TemplateOption func(t *Template)

func WithCatalogFile

func WithCatalogFile(catalogFile io.Reader) TemplateOption

func WithContributionFile

func WithContributionFile(contribFile io.Reader) TemplateOption

func WithOutputType

func WithOutputType(outputType string) TemplateOption

func WithRegistry

func WithRegistry(reg image.Registry) TemplateOption

func WithValidate

func WithValidate(validate bool) TemplateOption