services

Documentation

Overview

Package services incapsulates all the functionality around Epinio services

Index

• func CatalogServiceList(kubeClient *kubernetes.Cluster, org string) (interfaces.ServiceList, error)
• func CatalogServiceLookup(kubeClient *kubernetes.Cluster, org, service string) (interfaces.Service, error)
• func CreateCatalogService(kubeClient *kubernetes.Cluster, name, org, class, plan string, ...) (interfaces.Service, error)
• func CreateCustomService(kubeClient *kubernetes.Cluster, name, org string, data map[string]string) (interfaces.Service, error)
• func CustomServiceList(kubeClient *kubernetes.Cluster, org string) (interfaces.ServiceList, error)
• func CustomServiceLookup(kubeClient *kubernetes.Cluster, org, service string) (interfaces.Service, error)
• func List(kubeClient *kubernetes.Cluster, org string) (interfaces.ServiceList, error)
• func Lookup(kubeClient *kubernetes.Cluster, org, service string) (interfaces.Service, error)
• type CatalogService
  • func (s *CatalogService) CreateBinding(bindingName, org, serviceName, appName string) (interface{}, error)
  • func (s *CatalogService) Delete() error
  • func (s *CatalogService) DeleteBinding(appName, org string) error
  • func (s *CatalogService) Details() (map[string]string, error)
  • func (s *CatalogService) GetBinding(appName string) (*corev1.Secret, error)
  • func (s *CatalogService) GetBindingSecret(bindingName, org string) (*corev1.Secret, error)
  • func (s *CatalogService) LookupBinding(bindingName, org string) (interface{}, error)
  • func (s *CatalogService) Name() string
  • func (s *CatalogService) Org() string
  • func (s *CatalogService) Status() (string, error)
  • func (s *CatalogService) WaitForProvision() error
• type CustomService
  • func (s *CustomService) Delete() error
  • func (s *CustomService) DeleteBinding(appName, org string) error
  • func (s *CustomService) Details() (map[string]string, error)
  • func (s *CustomService) GetBinding(appName string) (*corev1.Secret, error)
  • func (s *CustomService) Name() string
  • func (s *CustomService) Org() string
  • func (s *CustomService) Status() (string, error)
  • func (s *CustomService) WaitForProvision() error
• type ServiceClass
  • func ClassLookup(kubeClient *kubernetes.Cluster, serviceClassName string) (*ServiceClass, error)
  • func (sc *ServiceClass) ListPlans() (ServicePlanList, error)
  • func (sc *ServiceClass) LookupPlan(plan string) (*ServicePlan, error)
• type ServiceClassList
  • func ListClasses(kubeClient *kubernetes.Cluster) (ServiceClassList, error)
• type ServicePlan
• type ServicePlanList

Functions

func CatalogServiceList

func CatalogServiceList(kubeClient *kubernetes.Cluster, org string) (interfaces.ServiceList, error)

CatalogServiceList returns a ServiceList of all available catalog Services

func CatalogServiceLookup

func CatalogServiceLookup(kubeClient *kubernetes.Cluster, org, service string) (interfaces.Service, error)

func CreateCatalogService

func CreateCatalogService(kubeClient *kubernetes.Cluster, name, org, class, plan string, parameters map[string]string) (interfaces.Service, error)

func CreateCustomService

func CreateCustomService(kubeClient *kubernetes.Cluster, name, org string,
	data map[string]string) (interfaces.Service, error)

CreateCustomService creates a new custom service from org, name and the binding data.

func CustomServiceList

func CustomServiceList(kubeClient *kubernetes.Cluster, org string) (interfaces.ServiceList, error)

CustomServiceList returns a ServiceList of all available custom Services

func CustomServiceLookup

func CustomServiceLookup(kubeClient *kubernetes.Cluster, org, service string) (interfaces.Service, error)

CustomServiceLookup finds a Custom Service by looking for the relevant Secret.

func List

func List(kubeClient *kubernetes.Cluster, org string) (interfaces.ServiceList, error)

List returns a ServiceList of all available Services

func Lookup

func Lookup(kubeClient *kubernetes.Cluster, org, service string) (interfaces.Service, error)

Lookup locates a Service by org and name

Types

type CatalogService

type CatalogService struct {
	InstanceName string
	OrgName      string
	Service      string
	Class        string
	Plan         string
	// contains filtered or unexported fields
}

CatalogService is a Service created using Service Catalog. Implements the Service interface.

func (*CatalogService) CreateBinding

func (s *CatalogService) CreateBinding(bindingName, org, serviceName, appName string) (interface{}, error)

CreateBinding creates a ServiceBinding for the application with name appName.

func (*CatalogService) Delete

func (s *CatalogService) Delete() error

func (*CatalogService) DeleteBinding

func (s *CatalogService) DeleteBinding(appName, org string) error

DeleteBinding deletes the ServiceBinding resource. The relevant secret will also be deleted automatically.

func (*CatalogService) Details

func (s *CatalogService) Details() (map[string]string, error)

func (*CatalogService) GetBinding

func (s *CatalogService) GetBinding(appName string) (*corev1.Secret, error)

GetBinding returns an application-specific secret for the service to be bound to that application.

func (*CatalogService) GetBindingSecret

func (s *CatalogService) GetBindingSecret(bindingName, org string) (*corev1.Secret, error)

GetBindingSecret returns the Secret that represents the binding of a Service to an Application.

func (*CatalogService) LookupBinding

func (s *CatalogService) LookupBinding(bindingName, org string) (interface{}, error)

LookupBinding finds a ServiceBinding object for the application with Name appName if there is one.

func (*CatalogService) Name

func (s *CatalogService) Name() string

func (*CatalogService) Org

func (s *CatalogService) Org() string

func (*CatalogService) Status

func (s *CatalogService) Status() (string, error)

func (*CatalogService) WaitForProvision

func (s *CatalogService) WaitForProvision() error

type CustomService

type CustomService struct {
	SecretName string
	OrgName    string
	Service    string
	// contains filtered or unexported fields
}

CustomService is a user defined service. Implements the Service interface.

func (*CustomService) Delete

func (s *CustomService) Delete() error

func (*CustomService) DeleteBinding

func (s *CustomService) DeleteBinding(appName, org string) error

DeleteBinding does nothing in the case of custom services because the custom service is just a secret which may be re-used later.

func (*CustomService) Details

func (s *CustomService) Details() (map[string]string, error)

func (*CustomService) GetBinding

func (s *CustomService) GetBinding(appName string) (*corev1.Secret, error)

func (*CustomService) Name

func (s *CustomService) Name() string

func (*CustomService) Org

func (s *CustomService) Org() string

func (*CustomService) Status

func (s *CustomService) Status() (string, error)

func (*CustomService) WaitForProvision

func (s *CustomService) WaitForProvision() error

type ServiceClass

type ServiceClass struct {
	Hash        string
	Name        string
	Broker      string
	Description string
	// contains filtered or unexported fields
}

ServiceClass is a service class managed by Service catalog

func ClassLookup

func ClassLookup(kubeClient *kubernetes.Cluster, serviceClassName string) (*ServiceClass, error)

func (*ServiceClass) ListPlans

func (sc *ServiceClass) ListPlans() (ServicePlanList, error)

ListPlans returns a ServicePlanList of all available catalog service plans, for the named class

func (*ServiceClass) LookupPlan

func (sc *ServiceClass) LookupPlan(plan string) (*ServicePlan, error)

LookupPlan returns the named ServicePlan, for the specified class

type ServiceClassList

type ServiceClassList []ServiceClass

func ListClasses

func ListClasses(kubeClient *kubernetes.Cluster) (ServiceClassList, error)

ListClasses returns a ServiceClassList of all available catalog service classes

type ServicePlan

type ServicePlan struct {
	Name        string
	Description string
	Free        bool
}

ServicePlan is a service plan managed by Service catalog

type ServicePlanList

type ServicePlanList []ServicePlan