service

Documentation

Index

• func CreateService(client *occlient.Client, serviceName string, serviceType string, ...) error
• func DeleteServiceAndUnlinkComponents(client *occlient.Client, serviceName string, applicationName string) error
• func GetServiceClassAndPlans(client *occlient.Client, serviceName string) (ServiceClass, []ServicePlan, error)
• func SvcExists(client *occlient.Client, serviceName, applicationName string) (bool, error)
• type InstanceCreateParameterSchema
• type Service
• type ServiceClass
• type ServiceList
  • func List(client *occlient.Client, applicationName string) (ServiceList, error)
  • func ListWithDetailedStatus(client *occlient.Client, applicationName string) (ServiceList, error)
• type ServicePlan
  • func NewServicePlan(result scv1beta1.ClusterServicePlan) (plan ServicePlan, err error)
• type ServicePlanParameter
  • func NewServicePlanParameter(name, typeName, defaultValue string, required bool) ServicePlanParameter
  • func (sp *ServicePlanParameter) UnmarshalJSON(data []byte) error
• type ServiceSpec
• type ServiceStatus

Functions

func CreateService

func CreateService(client *occlient.Client, serviceName string, serviceType string, servicePlan string, parameters map[string]string, applicationName string) error

CreateService creates new service from serviceCatalog

func DeleteServiceAndUnlinkComponents

func DeleteServiceAndUnlinkComponents(client *occlient.Client, serviceName string, applicationName string) error

DeleteServiceAndUnlinkComponents will delete the service with the provided `name` it also removes links to that service in components of the application

func GetServiceClassAndPlans

func GetServiceClassAndPlans(client *occlient.Client, serviceName string) (ServiceClass, []ServicePlan, error)

GetServiceClassAndPlans returns the service class details with the associated plans serviceName is the name of the service class the first parameter returned is the ServiceClass object the second parameter returned is the array of ServicePlan associated with the service class

func SvcExists

func SvcExists(client *occlient.Client, serviceName, applicationName string) (bool, error)

SvcExists Checks whether a service with the given name exists in the current application or not serviceName is the service name to perform check for The first returned parameter is a bool indicating if a service with the given name already exists or not The second returned parameter is the error that might occurs while execution

Types

type InstanceCreateParameterSchema

type InstanceCreateParameterSchema struct {
	Required   []string
	Properties map[string]ServicePlanParameter
}

type Service

type Service struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ServiceSpec   `json:"spec,omitempty"`
	Status            ServiceStatus `json:"status,omitempty"`
}

ServiceInfo holds all important information about one service

type ServiceClass

type ServiceClass struct {
	Name              string
	Bindable          bool
	ShortDescription  string
	LongDescription   string
	Tags              []string
	VersionsAvailable []string
	ServiceBrokerName string
}

ServiceClass holds the information regarding a service catalog service class

type ServiceList

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

func List

func List(client *occlient.Client, applicationName string) (ServiceList, error)

List lists all the deployed services

func ListWithDetailedStatus

func ListWithDetailedStatus(client *occlient.Client, applicationName string) (ServiceList, error)

ListWithDetailedStatus lists all the deployed services and additionally provides a "smart" status for each one of them The smart status takes into account how Services are used in odo. So when a secret has been created as a result of the created ServiceBinding, we set the appropriate status Same for when the secret has been "linked" into the deploymentconfig

type ServicePlan

type ServicePlan struct {
	Name        string
	DisplayName string
	Description string
	Parameters  servicePlanParameters
}

ServicePlan holds the information about service catalog plans associated to service classes

func NewServicePlan

func NewServicePlan(result scv1beta1.ClusterServicePlan) (plan ServicePlan, err error)

NewServicePlan creates a new ServicePlan based on the specified ClusterServicePlan

type ServicePlanParameter

type ServicePlanParameter struct {
	Name                   string `json:"name"`
	Title                  string `json:"title,omitempty"`
	Description            string `json:"description,omitempty"`
	Default                string `json:"default,omitempty"`
	validation.Validatable `json:",inline,omitempty"`
}

ServicePlanParameter holds the information regarding a service catalog plan parameter

func NewServicePlanParameter

func NewServicePlanParameter(name, typeName, defaultValue string, required bool) ServicePlanParameter

NewServicePlanParameter creates a new ServicePlanParameter instance with the specified state

func (*ServicePlanParameter) UnmarshalJSON

func (sp *ServicePlanParameter) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the JSON for ServicePlanParameter instead of using the built in json.Unmarshal

type ServiceSpec

type ServiceSpec struct {
	Type string `json:"type,omitempty"`
	Plan string `json:"plan,omitempty"`
}

ServiceSpec ...

type ServiceStatus

type ServiceStatus struct {
	Status string `json:"status,omitempty"`
}

ServiceStatus ...