servicebroker

Documentation

Index

• Variables
• type ALMBroker
  • func NewALMBroker(kubeconfigPath string, options Options) (*ALMBroker, error)
  • func (a *ALMBroker) Bind(request *osb.BindRequest, c *broker.RequestContext) (*broker.BindResponse, error)
  • func (a *ALMBroker) Deprovision(request *osb.DeprovisionRequest, c *broker.RequestContext) (*broker.DeprovisionResponse, error)
  • func (a *ALMBroker) GetCatalog(b *broker.RequestContext) (*broker.CatalogResponse, error)
  • func (a *ALMBroker) LastOperation(request *osb.LastOperationRequest, c *broker.RequestContext) (*broker.LastOperationResponse, error)
  • func (a *ALMBroker) Provision(request *osb.ProvisionRequest, c *broker.RequestContext) (*broker.ProvisionResponse, error)
  • func (a *ALMBroker) Unbind(request *osb.UnbindRequest, c *broker.RequestContext) (*broker.UnbindResponse, error)
  • func (a *ALMBroker) Update(request *osb.UpdateInstanceRequest, c *broker.RequestContext) (*broker.UpdateInstanceResponse, error)
  • func (a *ALMBroker) ValidateBrokerAPIVersion(version string) error
• type CustomResourceObject
• type Options
• type ParseDescription

Variables

var (
	NamespaceRequiredErrorMessage     = "NamespaceRequired"
	NamespaceRequiredErrorDescription = "Namespace must be specified via the `SpaceGUID` parameter"

	ValidServiceNameDescription = "MUST only contain alphanumeric characters, periods, and hyphens (no spaces)."

	NamespaceRequiredError = osb.HTTPStatusCodeError{
		StatusCode:   http.StatusBadRequest,
		ErrorMessage: &NamespaceRequiredErrorMessage,
		Description:  &NamespaceRequiredErrorDescription,
	}
)

var (
	AsyncOnlyError = osb.HTTPStatusCodeError{
		StatusCode:   http.StatusUnprocessableEntity,
		ErrorMessage: &asyncOnlyErrorMessage,
		Description:  &asyncOnlyErrorDescription,
	}
)

Types

type ALMBroker

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

ALMBroker contains the clients and logic for fetching the catalog and creating instances

func NewALMBroker

func NewALMBroker(kubeconfigPath string, options Options) (*ALMBroker, error)

NewBrokerSource creates a new BrokerSource client

func (*ALMBroker) Bind

func (a *ALMBroker) Bind(request *osb.BindRequest, c *broker.RequestContext) (*broker.BindResponse, error)

func (*ALMBroker) Deprovision

func (a *ALMBroker) Deprovision(request *osb.DeprovisionRequest, c *broker.RequestContext) (*broker.DeprovisionResponse, error)

func (*ALMBroker) GetCatalog

func (a *ALMBroker) GetCatalog(b *broker.RequestContext) (*broker.CatalogResponse, error)

GetCatalog returns the CSVs in the catalog

func (*ALMBroker) LastOperation

func (a *ALMBroker) LastOperation(request *osb.LastOperationRequest, c *broker.RequestContext) (*broker.LastOperationResponse, error)

func (*ALMBroker) Provision

func (a *ALMBroker) Provision(request *osb.ProvisionRequest, c *broker.RequestContext) (*broker.ProvisionResponse, error)

func (*ALMBroker) Unbind

func (a *ALMBroker) Unbind(request *osb.UnbindRequest, c *broker.RequestContext) (*broker.UnbindResponse, error)

func (*ALMBroker) Update

func (a *ALMBroker) Update(request *osb.UpdateInstanceRequest, c *broker.RequestContext) (*broker.UpdateInstanceResponse, error)

func (*ALMBroker) ValidateBrokerAPIVersion

func (a *ALMBroker) ValidateBrokerAPIVersion(version string) error

type CustomResourceObject

type CustomResourceObject struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec map[string]interface{}
}

type Options

type Options struct {
	Namespace string // restrict to resources within a namespace, default all namespaces
}

type ParseDescription

type ParseDescription func(desc string) string

ParseDescription accepts a description string and returns a parsed output