declcfg

Documentation

Index

• Constants
• func ConvertToModel(cfg DeclarativeConfig) (model.Model, error)
• func WalkFS(root fs.FS, walkFn WalkFunc) error
• func WalkMetasFS(root fs.FS, walkFn WalkMetasFSFunc) error
• func WalkMetasReader(r io.Reader, walkFn WalkMetasReaderFunc) error
• func WriteJSON(cfg DeclarativeConfig, w io.Writer) error
• func WriteYAML(cfg DeclarativeConfig, w io.Writer) error
• type Bundle
• type Channel
• type ChannelEntry
• type DeclarativeConfig
  • func ConvertFromModel(mpkgs model.Model) DeclarativeConfig
  • func LoadFS(root fs.FS) (*DeclarativeConfig, error)
  • func LoadFile(root fs.FS, path string) (*DeclarativeConfig, error)
  • func LoadReader(r io.Reader) (*DeclarativeConfig, error)
• type Icon
• type MermaidOption
  • func WithMinEdgeName(minEdgeName string) MermaidOption
  • func WithSpecifiedPackageName(specifiedPackageName string) MermaidOption
• type MermaidWriter
  • func NewMermaidWriter(opts ...MermaidOption) *MermaidWriter
  • func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer) error
• type Meta
  • func (m Meta) MarshalJSON() ([]byte, error)
  • func (m *Meta) UnmarshalJSON(blob []byte) error
• type Package
• type RelatedImage
  • func ModelRelatedImagesToRelatedImages(relatedImages []model.RelatedImage) []RelatedImage
• type WalkFunc
• type WalkMetasFSFunc
• type WalkMetasReaderFunc

Constants

const (
	SchemaPackage = "olm.package"
	SchemaChannel = "olm.channel"
	SchemaBundle  = "olm.bundle"
)

Functions

func ConvertToModel

func ConvertToModel(cfg DeclarativeConfig) (model.Model, error)

func WalkFS

func WalkFS(root fs.FS, walkFn WalkFunc) error

WalkFS walks root using a gitignore-style filename matcher to skip files that match patterns found in .indexignore files found throughout the filesystem. It calls walkFn for each declarative config file it finds. If WalkFS encounters an error loading or parsing any file, the error will be immediately returned.

func WalkMetasFS

func WalkMetasFS(root fs.FS, walkFn WalkMetasFSFunc) error

func WalkMetasReader

func WalkMetasReader(r io.Reader, walkFn WalkMetasReaderFunc) error

func WriteJSON

func WriteJSON(cfg DeclarativeConfig, w io.Writer) error

func WriteYAML

func WriteYAML(cfg DeclarativeConfig, w io.Writer) error

Types

type Bundle

type Bundle struct {
	Schema        string              `json:"schema"`
	Name          string              `json:"name"`
	Package       string              `json:"package"`
	Image         string              `json:"image"`
	Properties    []property.Property `json:"properties,omitempty" hash:"set"`
	RelatedImages []RelatedImage      `json:"relatedImages,omitempty" hash:"set"`

	// These fields are present so that we can continue serving
	// the GRPC API the way packageserver expects us to in a
	// backwards-compatible way. These are populated from
	// any `olm.bundle.object` properties.
	//
	// These fields will never be persisted in the bundle blob as
	// first class fields.
	CsvJSON string   `json:"-"`
	Objects []string `json:"-"`
}

Bundle specifies all metadata and data of a bundle object. Top-level fields are the source of truth, i.e. not CSV values.

Notes:

• Any field slice type field or type containing a slice somewhere where two types/fields are equal if their contents are equal regardless of order must have a `hash:"set"` field tag for bundle comparison.
• Any fields that have a `json:"-"` tag must be included in the equality evaluation in bundlesEqual().

type Channel

type Channel struct {
	Schema     string              `json:"schema"`
	Name       string              `json:"name"`
	Package    string              `json:"package"`
	Entries    []ChannelEntry      `json:"entries"`
	Properties []property.Property `json:"properties,omitempty" hash:"set"`
}

type ChannelEntry

type ChannelEntry struct {
	Name      string   `json:"name"`
	Replaces  string   `json:"replaces,omitempty"`
	Skips     []string `json:"skips,omitempty"`
	SkipRange string   `json:"skipRange,omitempty"`
}

type DeclarativeConfig

type DeclarativeConfig struct {
	Packages []Package
	Channels []Channel
	Bundles  []Bundle
	Others   []Meta
}

func ConvertFromModel

func ConvertFromModel(mpkgs model.Model) DeclarativeConfig

func LoadFS

func LoadFS(root fs.FS) (*DeclarativeConfig, error)

LoadFS loads a declarative config from the provided root FS. LoadFS walks the filesystem from root and uses a gitignore-style filename matcher to skip files that match patterns found in .indexignore files found throughout the filesystem. If LoadFS encounters an error loading or parsing any file, the error will be immediately returned.

func LoadFile

func LoadFile(root fs.FS, path string) (*DeclarativeConfig, error)

LoadFile will unmarshall declarative config components from a single filename provided in 'path' located at a filesystem hierarchy 'root'

func LoadReader

func LoadReader(r io.Reader) (*DeclarativeConfig, error)

LoadReader reads yaml or json from the passed in io.Reader and unmarshals it into a DeclarativeConfig struct. Path references will not be de-referenced so callers are responsible for de-referencing if necessary.

type Icon

type Icon struct {
	Data      []byte `json:"base64data"`
	MediaType string `json:"mediatype"`
}

type MermaidOption

type MermaidOption func(*MermaidWriter)

func WithMinEdgeName

func WithMinEdgeName(minEdgeName string) MermaidOption

func WithSpecifiedPackageName

func WithSpecifiedPackageName(specifiedPackageName string) MermaidOption

type MermaidWriter

type MermaidWriter struct {
	MinEdgeName          string
	SpecifiedPackageName string
}

func NewMermaidWriter

func NewMermaidWriter(opts ...MermaidOption) *MermaidWriter

func (*MermaidWriter) WriteChannels

func (writer *MermaidWriter) WriteChannels(cfg DeclarativeConfig, out io.Writer) error

writes out the channel edges of the declarative config graph in a mermaid format capable of being pasted into mermaid renderers like github, mermaid.live, etc. output is sorted lexicographically by package name, and then by channel name if provided, minEdgeName will be used as the lower bound for edges in the output graph

Example output: graph LR

  %% package "neuvector-certified-operator-rhmp"
  subgraph "neuvector-certified-operator-rhmp"
     %% channel "beta"
     subgraph neuvector-certified-operator-rhmp-beta["beta"]
	      neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.2.8["neuvector-operator.v1.2.8"]
	      neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.2.9["neuvector-operator.v1.2.9"]
	      neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.3.0["neuvector-operator.v1.3.0"]
	      neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.3.0["neuvector-operator.v1.3.0"]-- replaces --> neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.2.8["neuvector-operator.v1.2.8"]
	      neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.3.0["neuvector-operator.v1.3.0"]-- skips --> neuvector-certified-operator-rhmp-beta-neuvector-operator.v1.2.9["neuvector-operator.v1.2.9"]
    end
  end

end

type Meta

type Meta struct {
	Schema  string
	Package string
	Name    string

	Blob json.RawMessage
}

func (Meta) MarshalJSON

func (m Meta) MarshalJSON() ([]byte, error)

func (*Meta) UnmarshalJSON

func (m *Meta) UnmarshalJSON(blob []byte) error

type Package

type Package struct {
	Schema         string              `json:"schema"`
	Name           string              `json:"name"`
	DefaultChannel string              `json:"defaultChannel"`
	Icon           *Icon               `json:"icon,omitempty"`
	Description    string              `json:"description,omitempty"`
	Properties     []property.Property `json:"properties,omitempty" hash:"set"`
}

type RelatedImage

type RelatedImage struct {
	Name  string `json:"name"`
	Image string `json:"image"`
}

func ModelRelatedImagesToRelatedImages

func ModelRelatedImagesToRelatedImages(relatedImages []model.RelatedImage) []RelatedImage

type WalkFunc

type WalkFunc func(path string, cfg *DeclarativeConfig, err error) error

type WalkMetasFSFunc

type WalkMetasFSFunc func(path string, meta *Meta, err error) error

type WalkMetasReaderFunc

type WalkMetasReaderFunc func(meta *Meta, err error) error