osb

Documentation

Overview

Package osb contains logic for building the Service Manager OSB API

Index

• Constants
• func CatalogFetcher(doRequestFunc util.DoRequestFunc, brokerAPIVersion string) func(ctx context.Context, broker *types.ServiceBroker) ([]byte, error)
• func ExtractPlatformFromContext(ctx context.Context) (*types.Platform, error)
• func NewBrokerClientProvider(skipSsl bool, timeout int) osbc.CreateFunc
• func NewCheckInstanceOwnershipPlugin(repository storage.Repository, tenantIdentifier string) *checkInstanceOwnershipPlugin
• func NewCheckPlatformIDPlugin(repository storage.Repository) *checkPlatformIDPlugin
• func NewCheckVisibilityPlugin(repository storage.Repository) *checkVisibilityPlugin
• type BrokerFetcherFunc
• type CatalogFilterByVisibilityPlugin
  • func NewCatalogFilterByVisibilityPlugin(repository storage.Repository) *CatalogFilterByVisibilityPlugin
  • func (c *CatalogFilterByVisibilityPlugin) FetchCatalog(req *web.Request, next web.Handler) (*web.Response, error)
  • func (c *CatalogFilterByVisibilityPlugin) Name() string
• type Controller
  • func (c *Controller) Routes() []web.Route
• type Response
• type StoreServiceInstancePlugin
  • func NewStoreServiceInstancesPlugin(repository storage.TransactionalRepository) *StoreServiceInstancePlugin
  • func (ssi *StoreServiceInstancePlugin) Deprovision(request *web.Request, next web.Handler) (*web.Response, error)
  • func (*StoreServiceInstancePlugin) Name() string
  • func (ssi *StoreServiceInstancePlugin) PollInstance(request *web.Request, next web.Handler) (*web.Response, error)
  • func (ssi *StoreServiceInstancePlugin) Provision(request *web.Request, next web.Handler) (*web.Response, error)
  • func (ssi *StoreServiceInstancePlugin) UpdateService(request *web.Request, next web.Handler) (*web.Response, error)

Constants

const (
	// BrokerIDPathParam is a service broker ID path parameter
	BrokerIDPathParam   = "brokerID"
	InstanceIDPathParam = "instance_id"
)

const CatalogFilterByVisibilityPluginName = "CatalogFilterByVisibilityPlugin"

const CheckInstanceOwnerhipPluginName = "CheckInstanceOwnershipPlugin"

const CheckPlatformIDPluginName = "CheckPlatformIDPlugin"

const CheckVisibilityPluginName = "CheckVisibilityPlugin"

const (
	// StoreServiceInstancePluginName is the plugin name
	StoreServiceInstancePluginName = "StoreServiceInstancePlugin"
)

Functions

func CatalogFetcher

func CatalogFetcher(doRequestFunc util.DoRequestFunc, brokerAPIVersion string) func(ctx context.Context, broker *types.ServiceBroker) ([]byte, error)

CatalogFetcher creates a broker catalog fetcher that uses the provided request function to call the specified broker's catalog endpoint

func ExtractPlatformFromContext

func ExtractPlatformFromContext(ctx context.Context) (*types.Platform, error)

func NewBrokerClientProvider

func NewBrokerClientProvider(skipSsl bool, timeout int) osbc.CreateFunc

NewBrokerClientProvider provides a function which constructs an OSB client based on a provided configuration

func NewCheckInstanceOwnershipPlugin

func NewCheckInstanceOwnershipPlugin(repository storage.Repository, tenantIdentifier string) *checkInstanceOwnershipPlugin

NewCheckInstanceOwnershipPlugin creates new plugin that checks the owner of the instance

func NewCheckPlatformIDPlugin

func NewCheckPlatformIDPlugin(repository storage.Repository) *checkPlatformIDPlugin

NewCheckPlatformIDPlugin creates new plugin that checks the platform_id of the instance

func NewCheckVisibilityPlugin

func NewCheckVisibilityPlugin(repository storage.Repository) *checkVisibilityPlugin

NewCheckVisibilityPlugin creates new plugin that checks if a plan is visible to the user on provision request

Types

type BrokerFetcherFunc

type BrokerFetcherFunc func(ctx context.Context, brokerID string) (*types.ServiceBroker, error)

BrokerFetcherFunc is implemented by OSB proxy providers

type CatalogFilterByVisibilityPlugin

type CatalogFilterByVisibilityPlugin struct {
	// contains filtered or unexported fields
}

func NewCatalogFilterByVisibilityPlugin

func NewCatalogFilterByVisibilityPlugin(repository storage.Repository) *CatalogFilterByVisibilityPlugin

func (*CatalogFilterByVisibilityPlugin) FetchCatalog

func (c *CatalogFilterByVisibilityPlugin) FetchCatalog(req *web.Request, next web.Handler) (*web.Response, error)

func (*CatalogFilterByVisibilityPlugin) Name

func (c *CatalogFilterByVisibilityPlugin) Name() string

type Controller

type Controller struct {
	BrokerFetcher BrokerFetcherFunc
}

Controller implements api.Controller by providing OSB API logic

func (*Controller) Routes

func (c *Controller) Routes() []web.Route

Routes implements api.Controller.Routes by providing the routes for the OSB API

type Response

type Response struct {
	DashboardURL   string `json:"dashboard_url"`
	OperationData  string `json:"operation"`
	Error          string `json:"error"`
	Description    string `json:"description"`
	InstanceUsable bool   `json:"instance_usable"`
}

type StoreServiceInstancePlugin

type StoreServiceInstancePlugin struct {
	Repository storage.TransactionalRepository
}

StoreServiceInstancePlugin represents a plugin that stores service instances on OSB requests

func NewStoreServiceInstancesPlugin

func NewStoreServiceInstancesPlugin(repository storage.TransactionalRepository) *StoreServiceInstancePlugin

NewStoreServiceInstancesPlugin creates a plugin that stores service instances on OSB requests

func (*StoreServiceInstancePlugin) Deprovision

func (ssi *StoreServiceInstancePlugin) Deprovision(request *web.Request, next web.Handler) (*web.Response, error)

func (*StoreServiceInstancePlugin) Name

func (*StoreServiceInstancePlugin) Name() string

func (*StoreServiceInstancePlugin) PollInstance

func (ssi *StoreServiceInstancePlugin) PollInstance(request *web.Request, next web.Handler) (*web.Response, error)

func (*StoreServiceInstancePlugin) Provision

func (ssi *StoreServiceInstancePlugin) Provision(request *web.Request, next web.Handler) (*web.Response, error)

func (*StoreServiceInstancePlugin) UpdateService

func (ssi *StoreServiceInstancePlugin) UpdateService(request *web.Request, next web.Handler) (*web.Response, error)