servicebroker

README

Provides the Cloud Foundry API scaffolding for service brokers written in go.

Install

go get github.com/pivotalservices/servicebroker
cd $GOPATH/src/github.com/pivotalservices/servicebroker && godep get

Documentation

Index

• Variables
• func BasicAuthCheck() http.HandlerFunc
• func NewAPI(serviceBroker ServiceBroker, logger lager.Logger) *martini.ClassicMartini
• type BindingResponse
• type CatalogResponse
• type DashboardClient
• type EmptyResponse
• type ErrorResponse
• type Plan
• type PlanMetadata
• type ProvisionRequest
• type ProvisionResponse
• type Service
• type ServiceBroker
• type ServiceMetadata
• type ServiceMetadataListing
• type ServiceMetadataProvider

Variables

var (
	// 409 HTTP status code should be returned if the requested service instance already exists.
	ErrServiceInstanceAlreadyExists = errors.New("Service instance already exists")
	// 500 HTTP status code should be returned if the instance limit for this service has been reached.
	ErrServiceInstanceLimitReached = errors.New("Maximum number of instances for this service has been reached")
	// 409 HTTP status code should be returned if the service instance does not exist when attempting to bind to it.
	ErrServiceInstanceDoesNotExists = errors.New("Service instance does not exists")
	// 409 HTTP status code should be returned if the requested binding already exists
	ErrServiceInstanceBindingAlreadyExists = errors.New("Binding already exists")
)

Service Broker API Errors

Functions

func BasicAuthCheck

func BasicAuthCheck() http.HandlerFunc

func NewAPI

func NewAPI(serviceBroker ServiceBroker, logger lager.Logger) *martini.ClassicMartini

Creates v2 service broker api for a given broker

Types

type BindingResponse

type BindingResponse struct {
	Credentials interface{} `json:"credentials"`
}

type CatalogResponse

type CatalogResponse struct {
	Services []Service `json:"services"`
}

type DashboardClient

type DashboardClient struct {
	Id          string `json:"id"`
	Secret      string `json:"secret"`
	RedirectUri string `json:"redirect_uri"`
}

type EmptyResponse

type EmptyResponse struct{}

type ErrorResponse

type ErrorResponse struct {
	Description string `json:"description"`
}

type Plan

type Plan struct {
	Id          string       `json:"id"`
	Name        string       `json:"name"`
	Description string       `json:"description"`
	Metadata    PlanMetadata `json:"metadata,omitempty"`
}

type PlanMetadata

type PlanMetadata struct {
	Bullets     []string `json:"bullets"`
	DisplayName string   `json:"displayName"`
}

type ProvisionRequest

type ProvisionRequest struct {
	ServiceId        string `json:"service_id"`
	PlanId           string `json:"plan_id"`
	OrganizationGuid string `json:"organization_guid"`
	SpaceGuid        string `json:"space_guid"`
}

type ProvisionResponse

type ProvisionResponse struct {
	DashboardUrl string `json:"dashboard_url,omitempty"`
}

type Service

type Service struct {
	Id              string          `json:"id"`
	Name            string          `json:"name"`
	Description     string          `json:"description"`
	Bindable        bool            `json:"bindable"`
	Plans           []Plan          `json:"plans"`
	Metadata        ServiceMetadata `json:"metadata,omitempty"`
	Tags            []string        `json:"tags,omitempty"`
	DashboardClient DashboardClient `json:"dashboard_client"`
}

type ServiceBroker

type ServiceBroker interface {
	// Fetches the service catalog for the developer to select from the marketplace
	// http://docs.cloudfoundry.org/services/api.html#catalog-mgmt
	GetCatalog() []Service

	// Creates a new service resource for the developer
	// http://docs.cloudfoundry.org/services/api.html#provisioning
	Provision(instanceId string, params map[string]string) (string, error)

	// Creates a binding to a provisioned service instance for an application to use for connecting to the instance
	// http://docs.cloudfoundry.org/services/api.html#binding
	Bind(instanceId string, bindingId string) (interface{}, error)

	// Removes a service instance binding so applications can no longer bind to that instance
	// http://docs.cloudfoundry.org/services/api.html#unbinding
	Unbind(instanceId string, bindingId string) error

	// Deletes a provisioned service instance completely so users can no longer use it
	// http://docs.cloudfoundry.org/services/api.html#deprovisioning
	Deprovision(instanceId string) error
}

Implements the Cloud Foundry Service Broker API http://docs.cloudfoundry.org/services/api.html#api-overview

type ServiceMetadata

type ServiceMetadata struct {
	DisplayName      string                  `json:"displayName"`
	LongDescription  string                  `json:"longDescription"`
	DocumentationUrl string                  `json:"documentationUrl"`
	SupportUrl       string                  `json:"supportUrl"`
	Listing          ServiceMetadataListing  `json:"listing"`
	Provider         ServiceMetadataProvider `json:"provider"`
}

type ServiceMetadataListing

type ServiceMetadataListing struct {
	Blurb    string `json:"blurb"`
	ImageUrl string `json:"imageUrl"`
}

type ServiceMetadataProvider

type ServiceMetadataProvider struct {
	Name string `json:"name"`
}