provisioner

Documentation

Overview

Package provisioner implements main COSI driver functionality namely creating/deleting buckets and granting/revoking access to them.

Index

• Constants
• func NewVirtualDriver(config config.Configuration) (driver.Driver, error)
• type Driverset
  • func (ds *Driverset) Add(newDriver driver.Driver) error
  • func (ds *Driverset) Get(id string) (driver.Driver, error)
• type ErrDriverDuplicate
  • func (err ErrDriverDuplicate) Error() string
• type ErrNotConfigured
  • func (err ErrNotConfigured) Error() string
• type Server
  • func New(driverset *Driverset) *Server
  • func (s *Server) DriverCreateBucket(ctx context.Context, req *cosi.DriverCreateBucketRequest) (*cosi.DriverCreateBucketResponse, error)
  • func (s *Server) DriverDeleteBucket(ctx context.Context, req *cosi.DriverDeleteBucketRequest) (*cosi.DriverDeleteBucketResponse, error)
  • func (s *Server) DriverGrantBucketAccess(ctx context.Context, req *cosi.DriverGrantBucketAccessRequest) (*cosi.DriverGrantBucketAccessResponse, error)
  • func (s *Server) DriverRevokeBucketAccess(ctx context.Context, req *cosi.DriverRevokeBucketAccessRequest) (*cosi.DriverRevokeBucketAccessResponse, error)

Constants

const (
	ErrInvalidBackendID = "invalid backend ID"
)

Functions

func NewVirtualDriver

func NewVirtualDriver(config config.Configuration) (driver.Driver, error)

NewVirtualDriver is factory function, that takes configuration, validates if it is correct, and returns correct driver.

Types

type Driverset

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

Driverset is a structure holding list of Drivers, that can be added or extracted based on the ID.

func (*Driverset) Add

func (ds *Driverset) Add(newDriver driver.Driver) error

Add is used to add new driver to the Driverset.

func (*Driverset) Get

func (ds *Driverset) Get(id string) (driver.Driver, error)

Get is used to get driver from the Driverset.

type ErrDriverDuplicate

type ErrDriverDuplicate struct {
	ID string
}

ErrDriverDuplicate indicates that the Driver is already present in driverset.

func (ErrDriverDuplicate) Error

func (err ErrDriverDuplicate) Error() string

type ErrNotConfigured

type ErrNotConfigured struct {
	ID string
}

ErrNotConfigured indicates that the Driver is not present in the driverset.

func (ErrNotConfigured) Error

func (err ErrNotConfigured) Error() string

type Server

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

Server is an implementation of a provisioner server.

func New

func New(driverset *Driverset) *Server

New initializes Server based on the config file.

func (*Server) DriverCreateBucket

func (s *Server) DriverCreateBucket(ctx context.Context,
	req *cosi.DriverCreateBucketRequest,
) (*cosi.DriverCreateBucketResponse, error)

DriverCreateBucket creates Bucket on specific Object Storage Platform.

func (*Server) DriverDeleteBucket

func (s *Server) DriverDeleteBucket(ctx context.Context,
	req *cosi.DriverDeleteBucketRequest,
) (*cosi.DriverDeleteBucketResponse, error)

DriverDeleteBucket deletes Bucket on specific Object Storage Platform.

func (*Server) DriverGrantBucketAccess

func (s *Server) DriverGrantBucketAccess(ctx context.Context,
	req *cosi.DriverGrantBucketAccessRequest,
) (*cosi.DriverGrantBucketAccessResponse, error)

DriverGrantBucketAccess provides access to Bucket on specific Object Storage Platform.

func (*Server) DriverRevokeBucketAccess

func (s *Server) DriverRevokeBucketAccess(ctx context.Context,
	req *cosi.DriverRevokeBucketAccessRequest,
) (*cosi.DriverRevokeBucketAccessResponse, error)

DriverRevokeBucketAccess revokes access from Bucket on specific Object Storage Platform.