broker

Documentation

Index

• type Broker
  • func NewBroker(mb MinibrokerClient, defaultNamespace string, ...) *Broker
  • func NewBrokerFromOptions(o Options) (*Broker, error)
  • func (b *Broker) Bind(request *osb.BindRequest, _ *broker.RequestContext) (*broker.BindResponse, error)
  • func (b *Broker) BindingLastOperation(request *osb.BindingLastOperationRequest, _ *broker.RequestContext) (*broker.LastOperationResponse, error)
  • func (b *Broker) Deprovision(request *osb.DeprovisionRequest, _ *broker.RequestContext) (*broker.DeprovisionResponse, error)
  • func (b *Broker) GetBinding(request *osb.GetBindingRequest, _ *broker.RequestContext) (*broker.GetBindingResponse, error)
  • func (b *Broker) GetCatalog(c *broker.RequestContext) (*broker.CatalogResponse, error)
  • func (b *Broker) LastOperation(request *osb.LastOperationRequest, _ *broker.RequestContext) (*broker.LastOperationResponse, error)
  • func (b *Broker) Provision(request *osb.ProvisionRequest, _ *broker.RequestContext) (*broker.ProvisionResponse, error)
  • func (b *Broker) Unbind(request *osb.UnbindRequest, c *broker.RequestContext) (*broker.UnbindResponse, error)
  • func (b *Broker) Update(request *osb.UpdateInstanceRequest, _ *broker.RequestContext) (*broker.UpdateInstanceResponse, error)
  • func (b *Broker) ValidateBrokerAPIVersion(version string) error
• type MinibrokerClient
• type Options
• type ProvisioningSettings
  • func (d *ProvisioningSettings) ForService(service string) (*ServiceProvisioningSettings, bool)
  • func (d *ProvisioningSettings) LoadYaml(data []byte) error
• type ServiceProvisioningSettings

Types

type Broker

type Broker struct {

	// Synchronize go routines.
	sync.RWMutex
	// contains filtered or unexported fields
}

Broker provides an implementation of broker.Interface

func NewBroker

func NewBroker(mb MinibrokerClient, defaultNamespace string, provisioningSettings *ProvisioningSettings) *Broker

NewBroker creates a Broker instance with the given dependencies.

func NewBrokerFromOptions

func NewBrokerFromOptions(o Options) (*Broker, error)

NewBrokerFromOptions is a hook that is called with the Options the program is run with. NewBroker is the place where you will initialize your Broker the parameters passed in.

func (*Broker) Bind

func (b *Broker) Bind(request *osb.BindRequest, _ *broker.RequestContext) (*broker.BindResponse, error)

func (*Broker) BindingLastOperation

func (b *Broker) BindingLastOperation(request *osb.BindingLastOperationRequest, _ *broker.RequestContext) (*broker.LastOperationResponse, error)

func (*Broker) Deprovision

func (b *Broker) Deprovision(request *osb.DeprovisionRequest, _ *broker.RequestContext) (*broker.DeprovisionResponse, error)

func (*Broker) GetBinding

func (b *Broker) GetBinding(request *osb.GetBindingRequest, _ *broker.RequestContext) (*broker.GetBindingResponse, error)

func (*Broker) GetCatalog

func (b *Broker) GetCatalog(c *broker.RequestContext) (*broker.CatalogResponse, error)

func (*Broker) LastOperation

func (b *Broker) LastOperation(request *osb.LastOperationRequest, _ *broker.RequestContext) (*broker.LastOperationResponse, error)

LastOperation provides information on the state of the last asynchronous operation

func (*Broker) Provision

func (b *Broker) Provision(request *osb.ProvisionRequest, _ *broker.RequestContext) (*broker.ProvisionResponse, error)

func (*Broker) Unbind

func (b *Broker) Unbind(request *osb.UnbindRequest, c *broker.RequestContext) (*broker.UnbindResponse, error)

func (*Broker) Update

func (b *Broker) Update(request *osb.UpdateInstanceRequest, _ *broker.RequestContext) (*broker.UpdateInstanceResponse, error)

func (*Broker) ValidateBrokerAPIVersion

func (b *Broker) ValidateBrokerAPIVersion(version string) error

type MinibrokerClient

type MinibrokerClient interface {
	Init(repoURL string) error
	ListServices() ([]osb.Service, error)
	Provision(instanceID, serviceID, planID, namespace string, acceptsIncomplete bool, provisionParams *minibroker.ProvisionParams) (string, error)
	Bind(instanceID, serviceID, bindingID string, acceptsIncomplete bool, bindParams *minibroker.BindParams) (string, error)
	Unbind(instanceID, bindingID string) error
	GetBinding(instanceID, bindingID string) (*osb.GetBindingResponse, error)
	Deprovision(instanceID string, acceptsIncomplete bool) (string, error)
	LastOperationState(instanceID string, operationKey *osb.OperationKey) (*osb.LastOperationResponse, error)
	LastBindingOperationState(instanceID, bindingID string) (*osb.LastOperationResponse, error)
}

MinibrokerClient defines the interface of the client the broker operates on.

type Options

type Options struct {
	HelmRepoURL string
	CatalogPath string
	// The namespace where Minibroker stores configmaps.
	ConfigNamespace string
	// The default namespace wheer Minibroker deploys service instances.
	DefaultNamespace          string
	ServiceCatalogEnabledOnly bool
	// The YAML file where the optional default chart values are stored.
	ProvisioningSettingsPath string
	// The k8s cluster domain. If not set via the CLI flags, Minibroker tries to
	// infer from the /etc/resolv.conf.
	ClusterDomain string
}

type ProvisioningSettings

type ProvisioningSettings struct {
	Mariadb    *ServiceProvisioningSettings `yaml:"mariadb"`
	Mongodb    *ServiceProvisioningSettings `yaml:"mongodb"`
	Mysql      *ServiceProvisioningSettings `yaml:"mysql"`
	Postgresql *ServiceProvisioningSettings `yaml:"postgresql"`
	Rabbitmq   *ServiceProvisioningSettings `yaml:"rabbitmq"`
	Redis      *ServiceProvisioningSettings `yaml:"redis"`
}

ProvisioningSettings represents the configuration regarding the provisioning of services.

func (*ProvisioningSettings) ForService

func (d *ProvisioningSettings) ForService(service string) (*ServiceProvisioningSettings, bool)

ForService returns the parameters for the given service.

func (*ProvisioningSettings) LoadYaml

func (d *ProvisioningSettings) LoadYaml(data []byte) error

LoadYaml parses param definitions from raw yaml.

type ServiceProvisioningSettings

type ServiceProvisioningSettings struct {
	OverrideParams map[string]interface{} `yaml:"overrideParams"`
}

ServiceProvisioningSettings represents provisioning settings for a specific service.