declcfg

Documentation

Index

• func ConvertToModel(cfg DeclarativeConfig) (model.Model, error)
• func Diff(oldModel, newModel model.Model) (model.Model, error)
• func WalkFS(root fs.FS, walkFn WalkFunc) error
• func WriteJSON(cfg DeclarativeConfig, w io.Writer) error
• func WriteYAML(cfg DeclarativeConfig, w io.Writer) error
• type Bundle
• type DeclarativeConfig
  • func ConvertFromModel(mpkgs model.Model) DeclarativeConfig
  • func LoadFS(root fs.FS) (*DeclarativeConfig, error)
• type Icon
• type Meta
  • func (m Meta) MarshalJSON() ([]byte, error)
  • func (m *Meta) UnmarshalJSON(blob []byte) error
• type Package
• type RelatedImage
• type WalkFunc

Functions

func ConvertToModel

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

func Diff

func Diff(oldModel, newModel model.Model) (model.Model, error)

Diff returns a Model containing everything in newModel not in oldModel, and all bundles that exist in oldModel but are different in newModel. If oldModel is empty, only channel heads in newModel's packages are added to the output Model. All dependencies not in oldModel are also added.

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 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 DeclarativeConfig

type DeclarativeConfig struct {
	Packages []Package
	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.

type Icon

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

type Meta

type Meta struct {
	Schema  string
	Package 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"`
}

type RelatedImage

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

type WalkFunc

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