osb

Documentation

Overview

Package osb contains logic for building the Service Manager OSB API

Index

• Constants
• func CatalogFetcher(doRequestWithClient util.DoRequestWithClientFunc, brokerAPIVersion string) func(ctx context.Context, broker *types.ServiceBroker) ([]byte, error)
• func DeleteSignatureField(rawContext json.RawMessage) ([]byte, error)
• func ExtractPlatformFromContext(ctx context.Context) (*types.Platform, error)
• func Get(doRequestWithClient util.DoRequestWithClientFunc, brokerAPIVersion string, ...) ([]byte, 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
• func NewInstanceSharingPlugin(repository storage.TransactionalRepository, tenantIdentifier string) *instanceSharingPlugin
• func NewPlatformTerminationPlugin(repository storage.Repository) *platformTerminationPlugin
• func NewStorePlugin(repository storage.TransactionalRepository) *storePlugin
• 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 ContextSignaturePlugin
  • func NewCtxSignaturePlugin(contextSigner *ContextSigner) *ContextSignaturePlugin
  • func (s *ContextSignaturePlugin) Bind(req *web.Request, next web.Handler) (*web.Response, error)
  • func (s *ContextSignaturePlugin) Name() string
  • func (s *ContextSignaturePlugin) Provision(req *web.Request, next web.Handler) (*web.Response, error)
  • func (s *ContextSignaturePlugin) UpdateService(req *web.Request, next web.Handler) (*web.Response, error)
• type ContextSigner
  • func (cs *ContextSigner) Sign(ctx context.Context, contextMap map[string]interface{}) error
• type Controller
  • func (c *Controller) Routes() []web.Route
• type OperationCategory

Constants

const (
	ContextSignaturePluginName = "ContextSignaturePlugin"
	ServiceInstanceIDFieldName = "service_instance_id"
)

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

const (
	// OSBStorePluginName is the plugin name
	OSBStorePluginName = "OSBStorePluginName"

	PreserveInstanceKey = "preserve_service_instance_key"
)

const (
	READY    entityOperation = "ready"
	ROLLBACK entityOperation = "rollback"
	DELETE   entityOperation = "delete"
	NONE     entityOperation = "none"
)

const CatalogFilterByVisibilityPluginName = "CatalogFilterByVisibilityPlugin"

const CheckInstanceOwnerhipPluginName = "CheckInstanceOwnershipPlugin"

const CheckPlatformIDPluginName = "CheckPlatformIDPlugin"

const CheckVisibilityPluginName = "CheckVisibilityPlugin"

const InstanceSharingPluginName = "ReferenceInstancePlugin"

const PlatformTerminationPluginName = "PlatformTerminationPlugin"

Functions

func CatalogFetcher

func CatalogFetcher(doRequestWithClient util.DoRequestWithClientFunc, 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 DeleteSignatureField

func DeleteSignatureField(rawContext json.RawMessage) ([]byte, error)

func ExtractPlatformFromContext

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

func Get

func Get(doRequestWithClient util.DoRequestWithClientFunc, brokerAPIVersion string, ctx context.Context, broker *types.ServiceBroker, url string, resourceType string) ([]byte, 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

func NewInstanceSharingPlugin

func NewInstanceSharingPlugin(repository storage.TransactionalRepository, tenantIdentifier string) *instanceSharingPlugin

NewInstanceSharingPlugin creates new plugin that handles the instance sharing flows on osb

func NewPlatformTerminationPlugin

func NewPlatformTerminationPlugin(repository storage.Repository) *platformTerminationPlugin

NewPlatformTerminationPlugin creates new plugin that checks the platform deletion status

func NewStorePlugin

func NewStorePlugin(repository storage.TransactionalRepository) *storePlugin

NewStorePlugin creates a plugin that stores service instances on OSB requests

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 ContextSignaturePlugin

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

func NewCtxSignaturePlugin

func NewCtxSignaturePlugin(contextSigner *ContextSigner) *ContextSignaturePlugin

func (*ContextSignaturePlugin) Bind

func (s *ContextSignaturePlugin) Bind(req *web.Request, next web.Handler) (*web.Response, error)

func (*ContextSignaturePlugin) Name

func (s *ContextSignaturePlugin) Name() string

func (*ContextSignaturePlugin) Provision

func (s *ContextSignaturePlugin) Provision(req *web.Request, next web.Handler) (*web.Response, error)

func (*ContextSignaturePlugin) UpdateService

func (s *ContextSignaturePlugin) UpdateService(req *web.Request, next web.Handler) (*web.Response, error)

type ContextSigner

type ContextSigner struct {
	ContextPrivateKey string
	// contains filtered or unexported fields
}

func (*ContextSigner) Sign

func (cs *ContextSigner) Sign(ctx context.Context, contextMap map[string]interface{}) error

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 OperationCategory

type OperationCategory string