declcfg

Documentation

Index

• func ConvertToModel(cfg DeclarativeConfig) (model.Model, 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

Functions

func ConvertToModel

func ConvertToModel(cfg DeclarativeConfig) (model.Model, 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"`
	RelatedImages []RelatedImage      `json:"relatedImages,omitempty"`

	// 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:"-"`
}

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 immedidately 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"`
}