catalog

Documentation

Index

• Constants
• Variables
• func NewUpdaterStore() *updaterStore
• type ALMExamplesUpdate
  • func (u *ALMExamplesUpdate) Apply(csv *olmapiv1alpha1.ClusterServiceVersion) error
• type CSV
  • func (s *CSV) CustomRender() ([]byte, error)
  • func (s *CSV) GetInput() (input.Input, error)
  • func (s *CSV) SetFS(fs afero.Fs)
• type CSVConfig
  • func GetCSVConfig(cfgFile string) (*CSVConfig, error)
• type CSVUpdater
• type CustomResourceDefinitionsUpdate
  • func (u *CustomResourceDefinitionsUpdate) Apply(csv *olmapiv1alpha1.ClusterServiceVersion) error
• type InstallStrategyUpdate
  • func (u *InstallStrategyUpdate) Apply(csv *olmapiv1alpha1.ClusterServiceVersion) (err error)

Constants

const (
	CSVYamlFileExt    = ".clusterserviceversion.yaml"
	CSVConfigYamlFile = "csv-config.yaml"
)

Variables

var ErrNoCSVVersion = errors.New("no CSV version supplied")

Functions

func NewUpdaterStore

func NewUpdaterStore() *updaterStore

Types

type ALMExamplesUpdate

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

func (*ALMExamplesUpdate) Apply

func (u *ALMExamplesUpdate) Apply(csv *olmapiv1alpha1.ClusterServiceVersion) error

type CSV

type CSV struct {
	input.Input

	// ConfigFilePath is the location of a configuration file path for this
	// projects' CSV file.
	ConfigFilePath string
	// CSVVersion is the CSV current version.
	CSVVersion string
	// FromVersion is the CSV version from which to build a new CSV. A CSV
	// manifest with this version should exist at:
	// deploy/olm-catalog/{from_version}/operator-name.v{from_version}.{CSVYamlFileExt}
	FromVersion string
	// contains filtered or unexported fields
}

func (*CSV) CustomRender

func (s *CSV) CustomRender() ([]byte, error)

CustomRender allows a CSV to be written by marshalling olmapiv1alpha1.ClusterServiceVersion instead of writing to a template.

func (*CSV) GetInput

func (s *CSV) GetInput() (input.Input, error)

func (*CSV) SetFS

func (s *CSV) SetFS(fs afero.Fs)

type CSVConfig

type CSVConfig struct {
	// The operator manifest file path. Defaults to deploy/operator.yaml.
	OperatorPath string `json:"operator-path,omitempty"`
	// The RBAC role manifest file path. Defaults to deploy/role.yaml.
	RolePath string `json:"role-path,omitempty"`
	// A list of CRD and CR manifest file paths. Defaults to deploy/crds.
	CRDCRPaths []string `json:"crd-cr-paths,omitempty"`
}

CSVConfig is a configuration file for CSV composition. Its fields contain file path information.

func GetCSVConfig

func GetCSVConfig(cfgFile string) (*CSVConfig, error)

TODO: discuss case of no config file at default path: write new file or not.

type CSVUpdater

type CSVUpdater interface {
	// Apply applies a data update to a CSV argument.
	Apply(*olmapiv1alpha1.ClusterServiceVersion) error
}

CSVUpdater is an interface for any data that can be in a CSV, which will be set to the corresponding field on Apply().

type CustomResourceDefinitionsUpdate

type CustomResourceDefinitionsUpdate struct {
	*olmapiv1alpha1.CustomResourceDefinitions
	// contains filtered or unexported fields
}

func (*CustomResourceDefinitionsUpdate) Apply

func (u *CustomResourceDefinitionsUpdate) Apply(csv *olmapiv1alpha1.ClusterServiceVersion) error

Apply updates csv's "owned" CRDDescriptions. "required" CRDDescriptions are left as-is, since they are user-defined values.

type InstallStrategyUpdate

type InstallStrategyUpdate struct {
	*olminstall.StrategyDetailsDeployment
}

func (*InstallStrategyUpdate) Apply

func (u *InstallStrategyUpdate) Apply(csv *olmapiv1alpha1.ClusterServiceVersion) (err error)