catalog

package
Version: v1.2.6 Latest Latest
Warning

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

Go to latest
Published: Aug 31, 2020 License: Apache-2.0 Imports: 16 Imported by: 38

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ComponentExists added in v1.0.0

func ComponentExists(client *occlient.Client, componentType string, componentVersion string) (bool, error)

ComponentExists returns true if the given component type and the version are valid, false if not

func GetDevfileRegistries added in v1.2.1

func GetDevfileRegistries(registryName string) (map[string]Registry, error)

GetDevfileRegistries gets devfile registries from preference file, if registry name is specified return the specific registry, otherwise return all registries

func IsComponentTypeSupported added in v1.0.0

func IsComponentTypeSupported(client *occlient.Client, componentType string) (bool, error)

IsComponentTypeSupported takes the componentType e.g. java:8 and return true if it is fully supported i.e. debug mode and more.

func SearchComponent added in v1.0.0

func SearchComponent(client *occlient.Client, name string) ([]string, error)

SearchComponent searches for the component

func SliceSupportedTags added in v1.0.0

func SliceSupportedTags(component ComponentType) ([]string, []string)

SliceSupportedTags splits the tags in to fully supported and unsupported tags

Types

type ComponentSpec added in v1.0.0

type ComponentSpec struct {
	AllTags         []string               `json:"allTags"`
	NonHiddenTags   []string               `json:"nonHiddenTags"`
	SupportedTags   []string               `json:"supportedTags"`
	ImageStreamTags []imagev1.TagReference `json:"imageStreamTags"`
}

ComponentSpec is the spec for ComponentType

type ComponentType added in v1.0.0

type ComponentType struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ComponentSpec `json:"spec,omitempty"`
}

ComponentType is the main struct for catalog components

type ComponentTypeList added in v1.0.0

type ComponentTypeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ComponentType `json:"items"`
}

ComponentTypeList lists all the ComponentType's

func ListComponents added in v1.0.0

func ListComponents(client *occlient.Client) (ComponentTypeList, error)

ListComponents lists all the available component types

type DevfileComponentType added in v1.1.1

type DevfileComponentType struct {
	Name        string
	DisplayName string
	Description string
	Link        string
	Registry    Registry
}

DevfileComponentType is the main struct for devfile catalog components

type DevfileComponentTypeList added in v1.1.1

type DevfileComponentTypeList struct {
	DevfileRegistries map[string]Registry
	Items             []DevfileComponentType
}

DevfileComponentTypeList lists all the DevfileComponentType's

func ListDevfileComponents added in v1.1.1

func ListDevfileComponents(registryName string) (DevfileComponentTypeList, error)

ListDevfileComponents lists all the available devfile components

type DevfileIndexEntry added in v1.1.1

type DevfileIndexEntry struct {
	Name              string   `json:"name"`
	DisplayName       string   `json:"displayName"`
	Description       string   `json:"description"`
	Supported         bool     `json:"supported"`
	Tags              []string `json:"tags"`
	Icon              string   `json:"icon"`
	GlobalMemoryLimit string   `json:"globalMemoryLimit"`
	Registry          Registry `json:"registry"`
	Links             struct {
		Link string `json:"self"`
	} `json:"links"`
}

DevfileIndexEntry is the main struct of index.json from devfile registry

type Registry added in v1.2.1

type Registry struct {
	Name string
	URL  string
}

Registry is the main struct of devfile registry

type ServiceSpec added in v1.0.0

type ServiceSpec struct {
	Hidden   bool     `json:"hidden"`
	PlanList []string `json:"planList"`
}

ServiceSpec is the spec for ServiceType

type ServiceType added in v1.0.0

type ServiceType struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ServiceSpec `json:"spec,omitempty"`
}

ServiceType is the main struct for catalog services

type ServiceTypeList added in v1.0.0

type ServiceTypeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ServiceType `json:"items"`
}

ServiceTypeList lists all the ServiceType's

func ListServices added in v1.0.0

func ListServices(client *occlient.Client) (ServiceTypeList, error)

ListServices lists all the available service types

func SearchService added in v1.0.0

func SearchService(client *occlient.Client, name string) (ServiceTypeList, error)

SearchService searches for the services

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL