catalog

Documentation

Index

• func ComponentExists(client *occlient.Client, componentType string, componentVersion string) (bool, error)
• func IsComponentTypeSupported(client *occlient.Client, componentType string) (bool, error)
• 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 ServiceSpec
• type ServiceType
• type ServiceTypeList
  • func ListServices(client *occlient.Client) (ServiceTypeList, error)
  • func SearchService(client *occlient.Client, name string) (ServiceTypeList, error)

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