lvmd

Documentation

Index

• Constants
• Variables
• func NewEmbeddedServiceClients(ctx context.Context, dcmapper *DeviceClassManager, ...) (proto.LVServiceClient, proto.VGServiceClient)
• func NewHealthService() grpc_health_v1.HealthServer
• func NewLVService(dcmapper *DeviceClassManager, ocmapper *LvcreateOptionClassManager, ...) proto.LVServiceServer
• func NewVGService(manager *DeviceClassManager) (proto.VGServiceServer, func())
• func ValidateDeviceClasses(deviceClasses []*DeviceClass) error
• type DeviceClass
  • func (c DeviceClass) GetSpare() uint64
• type DeviceClassManager
  • func NewDeviceClassManager(deviceClasses []*DeviceClass) *DeviceClassManager
  • func (m DeviceClassManager) DeviceClass(dcName string) (*DeviceClass, error)
  • func (m DeviceClassManager) FindDeviceClassByThinPoolName(vgName string, poolName string) (*DeviceClass, error)
  • func (m DeviceClassManager) FindDeviceClassByVGName(vgName string) (*DeviceClass, error)
• type DeviceType
• type LvcreateOptionClass
• type LvcreateOptionClassManager
  • func NewLvcreateOptionClassManager(LvcreateOptionClasses []*LvcreateOptionClass) *LvcreateOptionClassManager
  • func (m LvcreateOptionClassManager) LvcreateOptionClass(name string) *LvcreateOptionClass
• type ThinPoolConfig

Constants

const (
	TypeThin  = DeviceType("thin")
	TypeThick = DeviceType("thick")
)

Variables

var ErrNotFound = errors.New("device-class not found")

ErrNotFound is returned when a VG or LV is not found.

Functions

func NewEmbeddedServiceClients

func NewEmbeddedServiceClients(ctx context.Context, dcmapper *DeviceClassManager, ocmapper *LvcreateOptionClassManager) (
	proto.LVServiceClient,
	proto.VGServiceClient,
)

NewEmbeddedServiceClients creates clients locally calling instead of using gRPC.

func NewHealthService

func NewHealthService() grpc_health_v1.HealthServer

func NewLVService

func NewLVService(dcmapper *DeviceClassManager, ocmapper *LvcreateOptionClassManager, notifyFunc func()) proto.LVServiceServer

NewLVService creates a new LVServiceServer

func NewVGService

func NewVGService(manager *DeviceClassManager) (proto.VGServiceServer, func())

NewVGService creates a VGServiceServer

func ValidateDeviceClasses

func ValidateDeviceClasses(deviceClasses []*DeviceClass) error

ValidateDeviceClasses validates device-classes

Types

type DeviceClass

type DeviceClass struct {
	// Name for the device-class name
	Name string `json:"name"`
	// Volume group name for the device-class
	VolumeGroup string `json:"volume-group"`
	// Default is a flag to indicate whether the device-class is the default
	Default bool `json:"default"`
	// SpareGB is storage capacity in GiB to be spared
	SpareGB *uint64 `json:"spare-gb"`
	// Stripe is the number of stripes in the logical volume
	Stripe *uint `json:"stripe"`
	// StripeSize is the amount of data that is written to one device before moving to the next device
	StripeSize string `json:"stripe-size"`
	// LVCreateOptions are extra arguments to pass to lvcreate
	LVCreateOptions []string `json:"lvcreate-options"`
	// Type is the name of logical volume target, supports 'thick' (default) or 'thin' currently
	Type DeviceType `json:"type"`
	// ThinPoolConfig holds the configuration for thinpool in this volume group corresponding to the device-class
	ThinPoolConfig *ThinPoolConfig `json:"thin-pool"`
}

DeviceClass maps between device-classes and target for logical volume creation current targets are VolumeGroup for thick-lv and ThinPool for thin-lv

func (DeviceClass) GetSpare

func (c DeviceClass) GetSpare() uint64

GetSpare returns spare in bytes for the device-class

type DeviceClassManager

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

DeviceClassManager maps between device-classes and volume groups.

func NewDeviceClassManager

func NewDeviceClassManager(deviceClasses []*DeviceClass) *DeviceClassManager

NewDeviceClassManager creates a new DeviceClassManager

func (DeviceClassManager) DeviceClass

func (m DeviceClassManager) DeviceClass(dcName string) (*DeviceClass, error)

DeviceClass returns the device-class by its name

func (DeviceClassManager) FindDeviceClassByThinPoolName

func (m DeviceClassManager) FindDeviceClassByThinPoolName(vgName string, poolName string) (*DeviceClass, error)

FindDeviceClassByThinPoolName returns the device-class with volume group and pool combination

func (DeviceClassManager) FindDeviceClassByVGName

func (m DeviceClassManager) FindDeviceClassByVGName(vgName string) (*DeviceClass, error)

FindDeviceClassByVGName returns the device-class with the volume group name

type DeviceType

type DeviceType string

type LvcreateOptionClass

type LvcreateOptionClass struct {
	// Name for the lvcreate-option-class name
	Name string `json:"name"`
	// Options are extra arguments to pass to lvcreate
	Options []string `json:"options"`
}

type LvcreateOptionClassManager

type LvcreateOptionClassManager struct {
	LvcreateOptionClassByName map[string]*LvcreateOptionClass
}

func NewLvcreateOptionClassManager

func NewLvcreateOptionClassManager(LvcreateOptionClasses []*LvcreateOptionClass) *LvcreateOptionClassManager

NewLvcreateOptionClassManager creates a new LvcreateOptionClassManager

func (LvcreateOptionClassManager) LvcreateOptionClass

func (m LvcreateOptionClassManager) LvcreateOptionClass(name string) *LvcreateOptionClass

LvcreateOptionClassClass returns the lvcreate-option-class by its name

type ThinPoolConfig

type ThinPoolConfig struct {
	// Name of thinpool
	Name string `json:"name"`
	// OverprovisionRatio signifies the upper bound multiplier for allowing logical volume creation in this pool
	OverprovisionRatio float64 `json:"overprovision-ratio"`
}

ThinPoolConfig holds the configuration of thin pool in a volume group