Help us shape the future of Go! Take the 2026 Go Developer Survey

catalog

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 8, 2019 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CSVYamlFileExt    = ".csv.yaml"
	CSVConfigYamlFile = "csv-config.yaml"
)
View Source
const ConcatCRDYamlFile = "_generated.concat_crd.yaml"

Variables

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

Functions

func NewUpdaterStore

func NewUpdaterStore() *updaterStore

Types

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
	// 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)

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.

type CSVCustomResourceDefinitionsUpdate

type CSVCustomResourceDefinitionsUpdate struct {
	*olmapiv1alpha1.CustomResourceDefinitions
}

func (*CSVCustomResourceDefinitionsUpdate) Apply

Apply updates all CRDDescriptions with any user-defined data in csv's CRDDescriptions.

type CSVInstallStrategyUpdate

type CSVInstallStrategyUpdate struct {
	*olminstall.StrategyDetailsDeployment
}

func (*CSVInstallStrategyUpdate) Apply

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 ConcatCRD

type ConcatCRD struct {
	input.Input

	// ConfigFilePath is the location of a configuration file path for this
	// projects' CSV file.
	ConfigFilePath string
}

ConcatCRD scaffolds a file of all concatenated CRD's found using config file fields. This file is used by the OLM to create CR's in conjunction with the operators' CSV.

func (*ConcatCRD) CustomRender

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

CustomRender returns the bytes of all CRD manifests concatenated into one file.

func (*ConcatCRD) GetInput

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL