provisioners

Documentation

Overview

Package provisioners provides library routines for implementing the open service broker api.

Index

• Variables
• func IsConditionUnreadyError(e error) bool
• func Ready(t ResourceType, entry *registry.Entry, serviceID, planID string) error
• type Creator
  • func NewCreator(resourceType ResourceType) (*Creator, error)
  • func (p *Creator) Prepare(entry *registry.Entry) error
  • func (p *Creator) Run(entry *registry.Entry)
• type Deleter
  • func NewDeleter() *Deleter
  • func (d *Deleter) Run(entry *registry.Entry)
• type ResourceType
• type Updater
  • func NewUpdater(resourceType ResourceType, request *api.UpdateServiceInstanceRequest) (*Updater, error)
  • func (u *Updater) Prepare(entry *registry.Entry) error
  • func (u *Updater) Run(entry *registry.Entry)

Variables

var ErrRegistryEntryMissing = errors.New("registry entry missing")

ErrRegistryEntryMissing is raised when a required registry key is missing.

var ErrResourceAttributeMissing = errors.New("resource attibute missing")

ErrResourceAttributeMissing is raised when a resource is missing a required attribute.

var ErrResourceReferenceMissing = errors.New("resource reference missing")

ErrResourceReferenceMissing is raised when a resource reference to another resource/attribute is missing.

var ErrUndefinedType = errors.New("undefined type")

ErrUndefinedType is raised when an bad enumeration or similar is provided.

Functions

func IsConditionUnreadyError

func IsConditionUnreadyError(e error) bool

IsConditionUnreadyError checks if the error is due to a condition being unready.

func Ready

func Ready(t ResourceType, entry *registry.Entry, serviceID, planID string) error

Ready processes any readiness checks and returns nil on success. For now this is intended to be called from the service instance polling code. In the future we may allow waits within the template rendering path. Returns nil on success and an error otherwise.

Types

type Creator

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

Creator caches various data associated with provisioning.

func NewCreator

func NewCreator(resourceType ResourceType) (*Creator, error)

NewCreator initializes all the data required for provisioning a service instance.

func (*Creator) Prepare

func (p *Creator) Prepare(entry *registry.Entry) error

Prepare does provisional synchronous tasks before provisioning. This does basic template collection and rendering.

func (*Creator) Run

func (p *Creator) Run(entry *registry.Entry)

Run performs asynchronous creation tasks.

type Deleter

type Deleter struct{}

Deleter caches various data associated with deleting a service instance.

func NewDeleter

func NewDeleter() *Deleter

NewDeleter returns a new controller capable of deleting a service instance.

func (*Deleter) Run

func (d *Deleter) Run(entry *registry.Entry)

Run performs asynchronous update tasks.

type ResourceType

type ResourceType string

ResourceType defines the type of resource being operated on.

const (
	// ResourceTypeServiceInstance is used to configure service instances.
	ResourceTypeServiceInstance ResourceType = "service-instance"

	// ResourceTypeServiceBinding is used to confugure service bindings.
	ResourceTypeServiceBinding ResourceType = "service-binding"
)

type Updater

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

Updater caches various data associated with updating a service instance.

func NewUpdater

func NewUpdater(resourceType ResourceType, request *api.UpdateServiceInstanceRequest) (*Updater, error)

NewUpdater returns a new controler capable of updaing a service instance.

func (*Updater) Prepare

func (u *Updater) Prepare(entry *registry.Entry) error

Prepare pre-processes the registry and templates.

func (*Updater) Run

func (u *Updater) Run(entry *registry.Entry)

Run performs asynchronous update tasks.