k8sbroker

Documentation

Index

• Constants
• Variables
• type Broker
  • func New(logger lager.Logger, os osshim.Os, clock clock.Clock, store brokerstore.Store, ...) (*Broker, error)
  • func (b *Broker) Bind(context context.Context, instanceID string, bindingID string, ...) (_ brokerapi.Binding, e error)
  • func (b *Broker) Deprovision(context context.Context, instanceID string, ...) (_ brokerapi.DeprovisionServiceSpec, e error)
  • func (b *Broker) LastOperation(_ context.Context, instanceID string, operationData string) (brokerapi.LastOperation, error)
  • func (b *Broker) Provision(context context.Context, instanceID string, details brokerapi.ProvisionDetails, ...) (_ brokerapi.ProvisionedServiceSpec, e error)
  • func (b *Broker) Services(_ context.Context) ([]brokerapi.Service, error)
  • func (b *Broker) Unbind(context context.Context, instanceID string, bindingID string, ...) (e error)
  • func (b *Broker) Update(context context.Context, instanceID string, details brokerapi.UpdateDetails, ...) (brokerapi.UpdateServiceSpec, error)
• type ErrInvalidService
  • func (e ErrInvalidService) Error() string
• type ErrInvalidSpecFile
  • func (e ErrInvalidSpecFile) Error() string
• type K8sClient
• type K8sCoreV1
• type K8sPersistentVolumeClaims
• type K8sPersistentVolumes
• type NfsConfig
• type Service
• type ServiceFingerPrint
• type Services
  • func NewServicesFromConfig(pathToServicesConfig string) (Services, error)

Constants

const (
	PermissionVolumeMount = brokerapi.RequiredPermission("volume_mount")
	DefaultContainerPath  = "/var/vcap/data"
)

Variables

var ErrEmptySpecFile = errors.New("At least one service must be provided in specfile")

Types

type Broker

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

func New

func New(
	logger lager.Logger,
	os osshim.Os,
	clock clock.Clock,
	store brokerstore.Store,
	client kubernetes.Interface,
	namespace string,
	servicesRegistry Services,
) (*Broker, error)

func (*Broker) Bind

func (b *Broker) Bind(context context.Context, instanceID string, bindingID string, bindDetails brokerapi.BindDetails) (_ brokerapi.Binding, e error)

func (*Broker) Deprovision

func (b *Broker) Deprovision(context context.Context, instanceID string, details brokerapi.DeprovisionDetails, asyncAllowed bool) (_ brokerapi.DeprovisionServiceSpec, e error)

func (*Broker) LastOperation

func (b *Broker) LastOperation(_ context.Context, instanceID string, operationData string) (brokerapi.LastOperation, error)

func (*Broker) Provision

func (b *Broker) Provision(context context.Context, instanceID string, details brokerapi.ProvisionDetails, asyncAllowed bool) (_ brokerapi.ProvisionedServiceSpec, e error)

func (*Broker) Services

func (b *Broker) Services(_ context.Context) ([]brokerapi.Service, error)

func (*Broker) Unbind

func (b *Broker) Unbind(context context.Context, instanceID string, bindingID string, details brokerapi.UnbindDetails) (e error)

func (*Broker) Update

func (b *Broker) Update(context context.Context, instanceID string, details brokerapi.UpdateDetails, asyncAllowed bool) (brokerapi.UpdateServiceSpec, error)

type ErrInvalidService

type ErrInvalidService struct {
	Index int
}

func (ErrInvalidService) Error

func (e ErrInvalidService) Error() string

type ErrInvalidSpecFile

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

func (ErrInvalidSpecFile) Error

func (e ErrInvalidSpecFile) Error() string

type K8sClient

type K8sClient interface {
	kubernetes.Interface
}

type K8sCoreV1

type K8sCoreV1 interface {
	corev1.CoreV1Interface
}

type K8sPersistentVolumeClaims

type K8sPersistentVolumeClaims interface {
	corev1.PersistentVolumeClaimInterface
}

type K8sPersistentVolumes

type K8sPersistentVolumes interface {
	corev1.PersistentVolumeInterface
}

type NfsConfig

type NfsConfig struct {
	Server string `json:"server"`
	Share  string `json:"share"`
}

type Service

type Service struct {
	DriverName string `json:"driver_name"`
	ConnAddr   string `json:"connection_address"`

	brokerapi.Service
}

type ServiceFingerPrint

type ServiceFingerPrint struct {
	Name   string
	Volume *v1.PersistentVolume
}

type Services

type Services interface {
	List() []brokerapi.Service
}

func NewServicesFromConfig

func NewServicesFromConfig(pathToServicesConfig string) (Services, error)