existingvolumebroker

README

existingvolumebroker

A Cloud Foundry service broker library for brokers that consume existing NFS or SMB shares.

For an example of how to use this broker, please refer to the nfsbroker or the smbbroker.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/existingvolumebroker.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Volume Services area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• Constants
• type Broker
  • func New(brokerType BrokerType, logger lager.Logger, services Services, os osshim.Os, ...) *Broker
  • func (b *Broker) Bind(context context.Context, instanceID string, bindingID string, ...) (_ domain.Binding, e error)
  • func (b *Broker) Deprovision(context context.Context, instanceID string, details domain.DeprovisionDetails, ...) (_ domain.DeprovisionServiceSpec, e error)
  • func (b *Broker) GetBinding(ctx context.Context, instanceID, bindingID string, ...) (domain.GetBindingSpec, error)
  • func (b *Broker) GetInstance(ctx context.Context, instanceID string, details domain.FetchInstanceDetails) (domain.GetInstanceDetailsSpec, error)
  • func (b *Broker) LastBindingOperation(ctx context.Context, instanceID, bindingID string, details domain.PollDetails) (domain.LastOperation, error)
  • func (b *Broker) LastOperation(_ context.Context, instanceID string, _ domain.PollDetails) (domain.LastOperation, error)
  • func (b *Broker) Provision(context context.Context, instanceID string, details domain.ProvisionDetails, ...) (_ domain.ProvisionedServiceSpec, e error)
  • func (b *Broker) Services(_ context.Context) ([]domain.Service, error)
  • func (b *Broker) Unbind(context context.Context, instanceID string, bindingID string, ...) (_ domain.UnbindSpec, e error)
  • func (b *Broker) Update(context context.Context, instanceID string, details domain.UpdateDetails, ...) (domain.UpdateServiceSpec, error)
• type BrokerType
• type Services

Constants

const (
	DEFAULT_CONTAINER_PATH = "/var/vcap/data"
	SHARE_KEY              = "share"
	SOURCE_KEY             = "source"
	VERSION_KEY            = "version"
)

Types

type Broker

type Broker struct {
	DisallowedBindOverrides []string
	// contains filtered or unexported fields
}

func New

func New(
	brokerType BrokerType,
	logger lager.Logger,
	services Services,
	os osshim.Os,
	clock clock.Clock,
	store brokerstore.Store,
	configMask vmo.MountOptsMask,
) *Broker

func (*Broker) Bind

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

func (*Broker) Deprovision

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

func (*Broker) GetBinding

func (b *Broker) GetBinding(ctx context.Context, instanceID, bindingID string, details domain.FetchBindingDetails) (domain.GetBindingSpec, error)

func (*Broker) GetInstance

func (b *Broker) GetInstance(ctx context.Context, instanceID string, details domain.FetchInstanceDetails) (domain.GetInstanceDetailsSpec, error)

func (*Broker) LastBindingOperation

func (b *Broker) LastBindingOperation(ctx context.Context, instanceID, bindingID string, details domain.PollDetails) (domain.LastOperation, error)

func (*Broker) LastOperation

func (b *Broker) LastOperation(_ context.Context, instanceID string, _ domain.PollDetails) (domain.LastOperation, error)

func (*Broker) Provision

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

func (*Broker) Services

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

func (*Broker) Unbind

func (b *Broker) Unbind(context context.Context, instanceID string, bindingID string, details domain.UnbindDetails, _ bool) (_ domain.UnbindSpec, e error)

func (*Broker) Update

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

type BrokerType

type BrokerType int

const (
	BrokerTypeNFS BrokerType = iota
	BrokerTypeSMB
)

type Services

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