pmdmanager

Documentation

Index

• Constants
• type Capacity
  • func (c Capacity) GetCapacity() (Capacity, error)
• type CapacityCollector
  • func (cc CapacityCollector) Collect(ch chan<- prometheus.Metric)
  • func (cc CapacityCollector) Describe(ch chan<- *prometheus.Desc)
  • func (cc CapacityCollector) MustRegister(reg prometheus.Registerer, nodeName, driverName string)
• type PmemDeviceCapacity
• type PmemDeviceInfo
• type PmemDeviceManager
  • func New(mode api.DeviceMode, pmemPercentage uint) (PmemDeviceManager, error)

Constants

const (
	FakeDevicePathPrefix = "/dev/pmem-csi-fake"
)

const (
	GB uint64 = 1024 * 1024 * 1024
)

const NodeLabel = "node"

NodeLabel is a label used for Prometheus which identifies the node that the controller talks to.

Types

type Capacity

type Capacity struct {
	// MaxVolumeSize is the size of the largest volume that
	// currently can be created, considering alignment and
	// fragmentation.
	MaxVolumeSize uint64
	// Available is the sum of all PMEM that could be used for
	// volumes.
	Available uint64
	// Managed is all PMEM that is managed by the driver.
	Managed uint64
	// Total is all PMEM found by the driver.
	Total uint64
}

Capacity contains information about PMEM. All sizes count bytes.

func (Capacity) GetCapacity

func (c Capacity) GetCapacity() (Capacity, error)

type CapacityCollector

type CapacityCollector struct {
	PmemDeviceCapacity
}

CapacityCollector is a wrapper around a PMEM device manager which takes GetCapacity values and turns them into metrics data.

func (CapacityCollector) Collect

func (cc CapacityCollector) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.Collect.

func (CapacityCollector) Describe

func (cc CapacityCollector) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.Describe.

func (CapacityCollector) MustRegister

func (cc CapacityCollector) MustRegister(reg prometheus.Registerer, nodeName, driverName string)

MustRegister adds the collector to the registry, using labels to tag each sample with node and driver name.

type PmemDeviceCapacity

type PmemDeviceCapacity interface {
	// GetCapacity returns information about local capacity.
	GetCapacity() (Capacity, error)
}

PmemDeviceCapacity interface just returns capacity information.

type PmemDeviceInfo

type PmemDeviceInfo struct {
	// VolumeId is a unique identifier created by PMEM-CSI for the volume.
	// It is returned by CreateDevice and passed into NodeStageVolume
	// and NodePublishVolume.
	VolumeId string

	// Path is the actual device path (for example, /dev/pmem0.1).
	// As a special case, if the path starts with FakeDevicePathPrefix,
	// then the volume doesn't have a backing store.
	Path string

	// Size allocated for block device in bytes.
	Size uint64
}

PmemDeviceInfo represents a volume created by PMEM-CSI.

type PmemDeviceManager

type PmemDeviceManager interface {
	PmemDeviceCapacity

	// GetName returns current device manager's operation mode
	GetMode() api.DeviceMode

	// CreateDevice creates a new block device with give name, size and namespace mode
	// Possible errors: ErrNotEnoughSpace, ErrDeviceExists
	CreateDevice(name string, size uint64) error

	// GetDevice returns the block device information for given name
	// Possible errors: ErrDeviceNotFound
	GetDevice(name string) (*PmemDeviceInfo, error)

	// DeleteDevice deletes an existing block device with give name.
	// If 'flush' is 'true', then the device data is zeroed before deleting the device
	// Possible errors: ErrDeviceInUse
	DeleteDevice(name string, flush bool) error

	// ListDevices returns all the block devices information that was created by this device manager
	ListDevices() ([]*PmemDeviceInfo, error)
}

PmemDeviceManager interface to manage the PMEM block devices

func New

func New(mode api.DeviceMode, pmemPercentage uint) (PmemDeviceManager, error)

New creates a new device manager for the given mode and percentage.