broker

Documentation

Index

• func IsForbiddenError(err error) bool
• func IsNotFoundError(err error) bool
• func RunTLS(ctx context.Context, addr string, cert string, key string) error
• type BindParametersDTO
  • func (params *BindParametersDTO) Validate() error
• type BindSuccessResponseDTO
• type DeprovisionService
  • func NewDeprovisioner(instStorage instanceStorage, instanceStateGetter instanceStateGetter, ...) *DeprovisionService
  • func (svc *DeprovisionService) Deprovision(ctx context.Context, osbCtx osbContext, req *v2.DeprovisionRequest) (*v2.DeprovisionResponse, error)
• type DeprovisionSuccessResponseDTO
• type ForbiddenError
  • func (fe *ForbiddenError) Error() string
  • func (fe *ForbiddenError) Forbidden() bool
• type LastOperationSuccessResponseDTO
• type OSBContextMiddleware
  • func (OSBContextMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type ProvisionRequestDTO
• type ProvisionService
  • func NewProvisioner(instanceInserter instanceInserter, instanceStateGetter instanceStateGetter, ...) *ProvisionService
  • func (svc *ProvisionService) Provision(ctx context.Context, osbCtx osbContext, req *osb.ProvisionRequest) (*osb.ProvisionResponse, error)
• type ProvisionSuccessResponseDTO
• type RequireAsyncMiddleware
  • func (RequireAsyncMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type Server
  • func New(remoteEnvironmentFinder reFinder, instStorage instanceStorage, ...) *Server
  • func (srv *Server) Addr() string
  • func (srv *Server) Run(ctx context.Context, addr string) error
• type ServiceInstanceFacade
  • func NewServiceInstanceFacade(informer cache.SharedIndexInformer) *ServiceInstanceFacade
  • func (f *ServiceInstanceFacade) GetByNamespaceAndExternalID(namespace string, extID string) (*v1beta1.ServiceInstance, error)

Functions

func IsForbiddenError

func IsForbiddenError(err error) bool

IsForbiddenError checks if error represent Forbidden one.

func IsNotFoundError

func IsNotFoundError(err error) bool

IsNotFoundError check if error is NotFound one.

func RunTLS

func RunTLS(ctx context.Context, addr string, cert string, key string) error

RunTLS is starting TLS server

Types

type BindParametersDTO

type BindParametersDTO struct {
	ServiceID string `json:"service_id"`
	PlanID    string `json:"plan_id"`
}

BindParametersDTO contains parameters sent by Service Catalog in the body of bind request.

func (*BindParametersDTO) Validate

func (params *BindParametersDTO) Validate() error

Validate checks if bind parameters aren't empty

type BindSuccessResponseDTO

type BindSuccessResponseDTO struct {
	// Credentials is a free-form hash of credentials that can be used by
	// applications or users to access the service.
	Credentials map[string]interface{} `json:"credentials,omitempty"`
}

BindSuccessResponseDTO represents response with credentials for service instance after successful binding

type DeprovisionService

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

DeprovisionService performs deprovision action

func NewDeprovisioner

func NewDeprovisioner(instStorage instanceStorage, instanceStateGetter instanceStateGetter, operationInserter operationInserter, operationUpdater operationUpdater, opIDProvider func() (internal.OperationID, error), log logrus.FieldLogger) *DeprovisionService

NewDeprovisioner creates new Deprovisioner

func (*DeprovisionService) Deprovision

func (svc *DeprovisionService) Deprovision(ctx context.Context, osbCtx osbContext, req *v2.DeprovisionRequest) (*v2.DeprovisionResponse, error)

Deprovision action

type DeprovisionSuccessResponseDTO

type DeprovisionSuccessResponseDTO struct {
	Operation *internal.OperationID `json:"operation,omitempty"`
}

DeprovisionSuccessResponseDTO represents response after successful deprovisioning

type ForbiddenError

type ForbiddenError struct {
}

ForbiddenError represents situation when operation is forbidden

func (*ForbiddenError) Error

func (fe *ForbiddenError) Error() string

func (*ForbiddenError) Forbidden

func (fe *ForbiddenError) Forbidden() bool

Forbidden is a marker method, used in IsForbiddenError method

type LastOperationSuccessResponseDTO

type LastOperationSuccessResponseDTO struct {
	State       internal.OperationState `json:"state"`
	Description *string                 `json:"description,omitempty"`
}

LastOperationSuccessResponseDTO represents info response about last successful operation

type OSBContextMiddleware

type OSBContextMiddleware struct{}

OSBContextMiddleware implements Handler interface

func (OSBContextMiddleware) ServeHTTP

func (OSBContextMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

ServeHTTP adds content of Open Service Broker Api headers to the requests

type ProvisionRequestDTO

type ProvisionRequestDTO struct {
	ServiceID        internal.ServiceID     `json:"service_id"`
	PlanID           internal.ServicePlanID `json:"plan_id"`
	OrganizationGUID string                 `json:"organization_guid"`
	SpaceGUID        string                 `json:"space_guid"`
	Parameters       map[string]interface{} `json:"parameters,omitempty"`
	Context          contextDTO             `json:"context,omitempty"`
}

ProvisionRequestDTO represents provision request

type ProvisionService

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

ProvisionService performs provisioning action

func NewProvisioner

func NewProvisioner(instanceInserter instanceInserter, instanceStateGetter instanceStateGetter, operationInserter operationInserter, operationUpdater operationUpdater, accessChecker access.ProvisionChecker, reSvcFinder reSvcFinder, serviceInstanceGetter serviceInstanceGetter, reClient v1client.RemoteenvironmentV1alpha1Interface, iStateUpdater instanceStateUpdater,
	operationIDProvider func() (internal.OperationID, error), log logrus.FieldLogger) *ProvisionService

NewProvisioner creates provisioner

func (*ProvisionService) Provision

func (svc *ProvisionService) Provision(ctx context.Context, osbCtx osbContext, req *osb.ProvisionRequest) (*osb.ProvisionResponse, error)

Provision action

type ProvisionSuccessResponseDTO

type ProvisionSuccessResponseDTO struct {
	DashboardURL *string               `json:"dashboard_url"`
	Operation    *internal.OperationID `json:"operation,omitempty"`
}

ProvisionSuccessResponseDTO represents response after successful provisioning

type RequireAsyncMiddleware

type RequireAsyncMiddleware struct{}

RequireAsyncMiddleware asserts if request allows for asynchronous response

func (RequireAsyncMiddleware) ServeHTTP

func (RequireAsyncMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

ServeHTTP handling asynchronous HTTP requests in Open Service Broker Api

type Server

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

Server implements HTTP server used to serve OSB API for remote environment broker.

func New

func New(remoteEnvironmentFinder reFinder, instStorage instanceStorage, opStorage operationStorage, accessChecker access.ProvisionChecker, reClient v1alpha1.RemoteenvironmentV1alpha1Interface, serviceInstanceGetter serviceInstanceGetter, log *logrus.Entry) *Server

New creates instance of broker server.

func (*Server) Addr

func (srv *Server) Addr() string

Addr returns address server is listening on. Its use is targeted for cases when address is not known, e.g. tests.

func (*Server) Run

func (srv *Server) Run(ctx context.Context, addr string) error

Run is starting HTTP server

type ServiceInstanceFacade

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

ServiceInstanceFacade expose operations on ServiceInstance objects

func NewServiceInstanceFacade

func NewServiceInstanceFacade(informer cache.SharedIndexInformer) *ServiceInstanceFacade

NewServiceInstanceFacade creates ServiceInstanceFacade

func (*ServiceInstanceFacade) GetByNamespaceAndExternalID

func (f *ServiceInstanceFacade) GetByNamespaceAndExternalID(namespace string, extID string) (*v1beta1.ServiceInstance, error)

GetByNamespaceAndExternalID returns service instance