osb

Documentation

Index

• type Catalog
  • func (c *Catalog) AddService(service *Service)
• type CreateServiceBindingResponse
• type CreateServiceInstanceResponse
• type Credential
• type LastOperation
• type Service
  • func NewService(sp *brokerconfig.ServiceClass) *Service
  • func (s *Service) AddPlan(plan *ServicePlan)
• type ServiceBinding
• type ServiceInstance
• type ServicePlan
  • func NewServicePlan(sp *brokerconfig.ServicePlan) *ServicePlan

Types

type Catalog

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

Catalog defines OSB catalog request data structure.

func (*Catalog) AddService

func (c *Catalog) AddService(service *Service)

AddService adds a service into the catalog services.

type CreateServiceBindingResponse

type CreateServiceBindingResponse struct {
	// SyslogDrainUrl string      `json:"syslog_drain_url, omitempty"`
	Credentials interface{} `json:"credentials"`
}

CreateServiceBindingResponse defines OSB service binding response data structure.

type CreateServiceInstanceResponse

type CreateServiceInstanceResponse struct {
	DashboardURL  string         `json:"dashboard_url"`
	LastOperation *LastOperation `json:"last_operation, omitempty"`
}

CreateServiceInstanceResponse defines OSB service instance response data structure.

type Credential

type Credential struct {
	PublicIP   string `json:"public_ip"`
	UserName   string `json:"username"`
	PrivateKey string `json:"private_key"`
}

Credential defines OSB credential data structure.

type LastOperation

type LastOperation struct {
	State                    string `json:"state"`
	Description              string `json:"description"`
	AsyncPollIntervalSeconds int    `json:"async_poll_interval_seconds, omitempty"`
}

LastOperation defines OSB last operation data structure.

type Service

type Service struct {
	Name           string   `json:"name"`
	ID             string   `json:"id"`
	Description    string   `json:"description"`
	Bindable       bool     `json:"bindable"`
	PlanUpdateable bool     `json:"plan_updateable, omitempty"`
	Tags           []string `json:"tags, omitempty"`
	Requires       []string `json:"requires, omitempty"`

	Metadata        interface{}   `json:"metadata, omitempty"`
	Plans           []ServicePlan `json:"plans"`
	DashboardClient interface{}   `json:"dashboard_client"`
}

Service defines OSB service data structure.

func NewService

func NewService(sp *brokerconfig.ServiceClass) *Service

NewService creates a service from service class config proto.

func (*Service) AddPlan

func (s *Service) AddPlan(plan *ServicePlan)

AddPlan adds a service plan into the service's plans.

type ServiceBinding

type ServiceBinding struct {
	ID                string `json:"id"`
	ServiceID         string `json:"service_id"`
	AppID             string `json:"app_id"`
	ServicePlanID     string `json:"service_plan_id"`
	PrivateKey        string `json:"private_key"`
	ServiceInstanceID string `json:"service_instance_id"`
}

ServiceBinding defines OSB service binding data structure.

type ServiceInstance

type ServiceInstance struct {
	ID               string `json:"id"`
	DashboardURL     string `json:"dashboard_url"`
	InternalID       string `json:"internalId, omitempty"`
	ServiceID        string `json:"service_id"`
	PlanID           string `json:"plan_id"`
	OrganizationGUID string `json:"organization_guid"`
	SpaceGUID        string `json:"space_guid"`

	LastOperation *LastOperation `json:"last_operation, omitempty"`

	Parameters interface{} `json:"parameters, omitempty"`
}

ServiceInstance defines OSB service instance data structure.

type ServicePlan

type ServicePlan struct {
	Name        string      `json:"name"`
	ID          string      `json:"id"`
	Description string      `json:"description"`
	Metadata    interface{} `json:"metadata, omitempty"`
	Free        bool        `json:"free, omitempty"`
}

ServicePlan defines the OSB service plan data structure.

func NewServicePlan

func NewServicePlan(sp *brokerconfig.ServicePlan) *ServicePlan

NewServicePlan creates a service plan from service plan config proto.