property

Documentation

Index

• Constants
• func AddToScheme(typ string, p interface{})
• type BundleObject
• type CSVMetadata
• type Channel
• type GVK
• type GVKRequired
• type MatchMissingError
  • func (e MatchMissingError) Error() string
• type Package
• type PackageRequired
• type ParseError
  • func (e ParseError) Error() string
• type Properties
  • func Parse(in []Property) (*Properties, error)
• type Property
  • func Build(p interface{}) (*Property, error)
  • func Deduplicate(in []Property) []Property
  • func MustBuild(p interface{}) Property
  • func MustBuildBundleObject(data []byte) Property
  • func MustBuildCSVMetadata(csv v1alpha1.ClusterServiceVersion) Property
  • func MustBuildChannelPriority(name string, priority int) Property
  • func MustBuildGVK(group, version, kind string) Property
  • func MustBuildGVKRequired(group, version, kind string) Property
  • func MustBuildPackage(name, version string) Property
  • func MustBuildPackageRequired(name, versionRange string) Property
  • func (p Property) String() string
  • func (p Property) Validate() error

Constants

const (
	TypePackage         = "olm.package"
	TypePackageRequired = "olm.package.required"
	TypeGVK             = "olm.gvk"
	TypeGVKRequired     = "olm.gvk.required"
	TypeBundleObject    = "olm.bundle.object"
	TypeCSVMetadata     = "olm.csv.metadata"
	TypeConstraint      = "olm.constraint"
	TypeChannel         = "olm.channel"
)

Functions

func AddToScheme

func AddToScheme(typ string, p interface{})

Types

type BundleObject

type BundleObject struct {
	Data []byte `json:"data"`
}

type CSVMetadata

type CSVMetadata struct {
	Annotations               map[string]string                  `json:"annotations,omitempty"`
	APIServiceDefinitions     v1alpha1.APIServiceDefinitions     `json:"apiServiceDefinitions,omitempty"`
	CustomResourceDefinitions v1alpha1.CustomResourceDefinitions `json:"crdDescriptions,omitempty"`
	Description               string                             `json:"description,omitempty"`
	DisplayName               string                             `json:"displayName,omitempty"`
	InstallModes              []v1alpha1.InstallMode             `json:"installModes,omitempty"`
	Keywords                  []string                           `json:"keywords,omitempty"`
	Labels                    map[string]string                  `json:"labels,omitempty"`
	Links                     []v1alpha1.AppLink                 `json:"links,omitempty"`
	Maintainers               []v1alpha1.Maintainer              `json:"maintainers,omitempty"`
	Maturity                  string                             `json:"maturity,omitempty"`
	MinKubeVersion            string                             `json:"minKubeVersion,omitempty"`
	NativeAPIs                []metav1.GroupVersionKind          `json:"nativeAPIs,omitempty"`
	Provider                  v1alpha1.AppLink                   `json:"provider,omitempty"`
}

type Channel

type Channel struct {
	ChannelName string `json:"channelName"`
	//Priority    string `json:"priority"`
	Priority int `json:"priority"`
}

NOTICE: The Channel properties are for internal use only.

DO NOT use it for any public-facing functionalities.
This API is in alpha stage and it is subject to change.

type GVK

type GVK struct {
	Group   string `json:"group"`
	Kind    string `json:"kind"`
	Version string `json:"version"`
}

type GVKRequired

type GVKRequired struct {
	Group   string `json:"group"`
	Kind    string `json:"kind"`
	Version string `json:"version"`
}

type MatchMissingError

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

func (MatchMissingError) Error

func (e MatchMissingError) Error() string

type Package

type Package struct {
	PackageName string `json:"packageName"`
	Version     string `json:"version"`
}

type PackageRequired

type PackageRequired struct {
	PackageName  string `json:"packageName"`
	VersionRange string `json:"versionRange"`
}

type ParseError

type ParseError struct {
	Idx int
	Typ string
	Err error
}

func (ParseError) Error

func (e ParseError) Error() string

type Properties

type Properties struct {
	Packages         []Package         `hash:"set"`
	PackagesRequired []PackageRequired `hash:"set"`
	GVKs             []GVK             `hash:"set"`
	GVKsRequired     []GVKRequired     `hash:"set"`
	BundleObjects    []BundleObject    `hash:"set"`
	Channels         []Channel         `hash:"set"`
	CSVMetadatas     []CSVMetadata     `hash:"set"`

	Others []Property `hash:"set"`
}

func Parse

func Parse(in []Property) (*Properties, error)

type Property

type Property struct {
	Type  string          `json:"type"`
	Value json.RawMessage `json:"value"`
}

func Build

func Build(p interface{}) (*Property, error)

func Deduplicate

func Deduplicate(in []Property) []Property

func MustBuild

func MustBuild(p interface{}) Property

func MustBuildBundleObject

func MustBuildBundleObject(data []byte) Property

func MustBuildCSVMetadata

func MustBuildCSVMetadata(csv v1alpha1.ClusterServiceVersion) Property

func MustBuildChannelPriority

func MustBuildChannelPriority(name string, priority int) Property

NOTICE: The Channel properties are for internal use only.

DO NOT use it for any public-facing functionalities.
This API is in alpha stage and it is subject to change.

func MustBuildGVK

func MustBuildGVK(group, version, kind string) Property

func MustBuildGVKRequired

func MustBuildGVKRequired(group, version, kind string) Property

func MustBuildPackage

func MustBuildPackage(name, version string) Property

func MustBuildPackageRequired

func MustBuildPackageRequired(name, versionRange string) Property

func (Property) String

func (p Property) String() string

func (Property) Validate

func (p Property) Validate() error