property

package
v1.29.0 Latest Latest
Warning

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

Go to latest
Published: Aug 15, 2023 License: Apache-2.0 Imports: 10 Imported by: 15

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

func AddToScheme

func AddToScheme(typ string, p interface{})

Types

type BundleObject

type BundleObject struct {
	File `json:",inline"`
}

type CSVMetadata added in v1.28.0

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 File

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

func (File) GetData

func (f File) GetData(root fs.FS, cwd string) ([]byte, error)

func (File) GetRef

func (f File) GetRef() string

func (File) IsRef

func (f File) IsRef() bool

func (File) MarshalJSON

func (f File) MarshalJSON() ([]byte, error)

func (*File) UnmarshalJSON

func (f *File) UnmarshalJSON(data []byte) error

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 MustBuildBundleObjectData

func MustBuildBundleObjectData(data []byte) Property

func MustBuildBundleObjectRef

func MustBuildBundleObjectRef(ref string) Property

func MustBuildCSVMetadata added in v1.28.0

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

Jump to

Keyboard shortcuts

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