template

Documentation

Index

• Constants
• type BasicOptions
  • func (t BasicOptions) Expand(ctx context.Context) (*declcfg.DeclarativeConfig, error)
• type BasicTemplate
  • func FromReader(r io.Reader) (*BasicTemplate, error)
• type SemverOptions
  • func (t SemverOptions) Expand(ctx context.Context) (*declcfg.DeclarativeConfig, error)
• type SemverTemplate
• type Template
• type TemplateExpanderInterface
  • func NewExpander(to TemplateOptions) (TemplateExpanderInterface, error)
• type TemplateOptions
  • func (t TemplateOptions) Expand(ctx context.Context) (*declcfg.DeclarativeConfig, error)

Constants

const BasicSchema string = "olm.template.basic"

const SemverSchema string = "olm.semver"

Types

type BasicOptions

type BasicOptions struct {
	TemplateOptions
}

func (BasicOptions) Expand

func (t BasicOptions) Expand(ctx context.Context) (*declcfg.DeclarativeConfig, error)

type BasicTemplate

type BasicTemplate struct {
	Template
	Entries []*declcfg.Meta `json:"entries"`
}

func FromReader

func FromReader(r io.Reader) (*BasicTemplate, error)

FromReader reads FBC from a reader and generates a BasicTemplate from it

type SemverOptions

type SemverOptions struct {
	TemplateOptions
}

func (SemverOptions) Expand

func (t SemverOptions) Expand(ctx context.Context) (*declcfg.DeclarativeConfig, error)

type SemverTemplate

type SemverTemplate struct {
	Template
	GenerateMajorChannels        bool                         `json:"generateMajorChannels,omitempty"`
	GenerateMinorChannels        bool                         `json:"generateMinorChannels,omitempty"`
	DefaultChannelTypePreference streamType                   `json:"defaultChannelTypePreference,omitempty"`
	Candidate                    semverTemplateChannelBundles `json:"candidate,omitempty"`
	Fast                         semverTemplateChannelBundles `json:"fast,omitempty"`
	Stable                       semverTemplateChannelBundles `json:"stable,omitempty"`
	// contains filtered or unexported fields
}

type Template

type Template struct {
	Schema string `json:"schema"`
}

type TemplateExpanderInterface

type TemplateExpanderInterface interface {
	Expand(context.Context) (*declcfg.DeclarativeConfig, error)
}

func NewExpander

func NewExpander(to TemplateOptions) (TemplateExpanderInterface, error)

type TemplateOptions

type TemplateOptions struct {
	Input        io.Reader
	RenderBundle func(context.Context, string) (*declcfg.DeclarativeConfig, error)
}

func (TemplateOptions) Expand

func (t TemplateOptions) Expand(ctx context.Context) (*declcfg.DeclarativeConfig, error)