catalog

Documentation

Index

• Variables
• func ComponentExists(client *occlient.Client, componentType string, componentVersion string) (bool, error)
• func IsComponentTypeSupported(client *occlient.Client, componentType string) (bool, error)
• func IsDevfileComponentSupported(devfile Devfile) bool
• func SearchComponent(client *occlient.Client, name string) ([]string, error)
• func SliceSupportedTags(component ComponentType) ([]string, []string)
• type ComponentSpec
• type ComponentType
• type ComponentTypeList
  • func ListComponents(client *occlient.Client) (ComponentTypeList, error)
• type Devfile
  • func GetDevfile(devfileLink string) (Devfile, error)
• type DevfileComponentType
• type DevfileComponentTypeList
  • func ListDevfileComponents() (DevfileComponentTypeList, error)
• type DevfileIndexEntry
  • func GetDevfileIndex(devfileIndexLink string) ([]DevfileIndexEntry, error)
• type ServiceSpec
• type ServiceType
• type ServiceTypeList
  • func ListServices(client *occlient.Client) (ServiceTypeList, error)
  • func SearchService(client *occlient.Client, name string) (ServiceTypeList, error)

Variables

var DevfileRegistries = []string{
	"https://raw.githubusercontent.com/elsony/devfile-registry/master",
	"https://che-devfile-registry.openshift.io/",
}

DevfileRegistries contains the links of all devfile registries

Functions

func ComponentExists

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 IsComponentTypeSupported

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 IsDevfileComponentSupported

func IsDevfileComponentSupported(devfile Devfile) bool

IsDevfileComponentSupported checks if the devfile is supported The supported devfile should satisfy the following conditions: 1. Devfile has dockerimage as component type 2. Devfile has alias 3. Devfile has run command 4. Devfile has build command

func SearchComponent

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

SearchComponent searches for the component

func SliceSupportedTags

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

SliceSupportedTags splits the tags in to fully supported and unsupported tags

Types

type ComponentSpec

type ComponentSpec struct {
	AllTags        []string            `json:"allTags"`
	NonHiddenTags  []string            `json:"nonHiddenTags"`
	SupportedTags  []string            `json:"supportedTags"`
	ImageStreamRef imagev1.ImageStream `json:"-"`
}

ComponentSpec is the spec for ComponentType

type ComponentType

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

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

ComponentTypeList lists all the ComponentType's

func ListComponents

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

ListComponents lists all the available component types

type Devfile

type Devfile struct {
	APIVersion string `yaml:"apiVersion"`
	MetaData   struct {
		GenerateName string `yaml:"generateName"`
	} `yaml:"metadata"`
	Components []struct {
		Type  string `yaml:"type"`
		Alias string `yaml:"alias"`
	} `yaml:"components"`
	Commands []struct {
		Name string `yaml:"name"`
	} `yaml:"commands"`
}

Devfile is the main structure of devfile from devfile registry

func GetDevfile

func GetDevfile(devfileLink string) (Devfile, error)

GetDevfile loads the devfile

type DevfileComponentType

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

DevfileComponentType is the main struct for devfile catalog components

type DevfileComponentTypeList

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

DevfileComponentTypeList lists all the DevfileComponentType's

func ListDevfileComponents

func ListDevfileComponents() (DevfileComponentTypeList, error)

ListDevfileComponents lists all the available devfile components

type DevfileIndexEntry

type DevfileIndexEntry struct {
	DisplayName       string   `json:"displayName"`
	Description       string   `json:"description"`
	Tags              []string `json:"tags"`
	Icon              string   `json:"icon"`
	GlobalMemoryLimit string   `json:"globalMemoryLimit"`
	Links             struct {
		Link string `json:"self"`
	} `json:"links"`
}

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

func GetDevfileIndex

func GetDevfileIndex(devfileIndexLink string) ([]DevfileIndexEntry, error)

GetDevfileIndex loads the devfile registry index.json

type ServiceSpec

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

ServiceSpec is the spec for ServiceType

type ServiceType

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

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

ServiceTypeList lists all the ServiceType's

func ListServices

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

ListServices lists all the available service types

func SearchService

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

SearchService searches for the services