parameters

Documentation

Index

• Constants
• type Origin
• type Persistency
• type Usage
• type Volume
  • func Parse(origin Origin, stringmap map[string]string) (Volume, error)
  • func (v Volume) GetDeviceMode() api.DeviceMode
  • func (v Volume) GetEraseAfter() bool
  • func (v Volume) GetKataContainers() bool
  • func (v Volume) GetName() string
  • func (v Volume) GetPersistency() Persistency
  • func (v Volume) GetSize() int64
  • func (v Volume) GetUsage() Usage
  • func (v Volume) ToContext() VolumeContext
• type VolumeContext

Constants

const (
	EraseAfter       = "eraseafter"
	KataContainers   = "kataContainers"
	Name             = "name"
	PersistencyModel = "persistencyModel"
	Size             = "size"
	DeviceMode       = "deviceMode"

	// Added in PMEM-CSI 1.1.0.
	UsageModel           = "usage"
	UsageAppDirect Usage = "AppDirect"
	UsageFileIO    Usage = "FileIO"

	// Kubernetes v1.16+ adds this key to NodePublishRequest.VolumeContext
	// while provisioning ephemeral volume.
	Ephemeral = "csi.storage.k8s.io/ephemeral"

	// Additional, unknown parameters that are okay.
	PodInfoPrefix = "csi.storage.k8s.io/"

	// Added by https://github.com/kubernetes-csi/external-provisioner/blob/feb67766f5e6af7db5c03ac0f0b16255f696c350/pkg/controller/controller.go#L584
	ProvisionerID = "storage.kubernetes.io/csiProvisionerIdentity"

	PersistencyNormal    Persistency = "normal"    // In releases <= 0.6.x this was called "none", but not documented.
	PersistencyEphemeral Persistency = "ephemeral" // only used internally

	//CreateVolumeOrigin is for parameters from the storage class in controller CreateVolume.
	CreateVolumeOrigin Origin = iota
	// CreateVolumeInternalOrigin is for the node CreateVolume parameters.
	CreateVolumeInternalOrigin
	// EphemeralVolumeOrigin represents parameters for an ephemeral volume in NodePublishVolume.
	EphemeralVolumeOrigin
	// PersistentVolumeOrigin represents parameters for a persistent volume in NodePublishVolume.
	PersistentVolumeOrigin
	// NodeVolumeOrigin is for the parameters stored in node volume list.
	NodeVolumeOrigin
)

Beware of API and backwards-compatibility breaking when changing these string constants!

Types

type Origin

type Origin int

type Persistency

type Persistency string

type Usage

type Usage string

type Volume

type Volume struct {
	EraseAfter     *bool
	KataContainers *bool
	Name           *string
	Persistency    *Persistency
	Size           *int64
	DeviceMode     *api.DeviceMode
	Usage          *Usage
}

Volume represents all settings for a volume. Values can be unset or set explicitly to some value. The accessor functions always return a value, if unset the default.

func Parse

func Parse(origin Origin, stringmap map[string]string) (Volume, error)

Parse converts the string map that PMEM-CSI is given in CreateVolume (master and node) and NodePublishVolume. Depending on the origin of the string map, different keys are valid. An error is returned for invalid keys and values and invalid combinations of parameters.

func (Volume) GetDeviceMode

func (v Volume) GetDeviceMode() api.DeviceMode

func (Volume) GetEraseAfter

func (v Volume) GetEraseAfter() bool

func (Volume) GetKataContainers

func (v Volume) GetKataContainers() bool

func (Volume) GetName

func (v Volume) GetName() string

func (Volume) GetPersistency

func (v Volume) GetPersistency() Persistency

func (Volume) GetSize

func (v Volume) GetSize() int64

func (Volume) GetUsage

func (v Volume) GetUsage() Usage

func (Volume) ToContext

func (v Volume) ToContext() VolumeContext

ToContext converts back to a string map for use in CreateVolumeResponse.Volume.VolumeContext and for storing in the node's volume list.

Both the volume context and the volume list are persisted outside of PMEM-CSI (one in etcd, the other on disk), so beware when making backwards incompatible changes!

type VolumeContext

type VolumeContext map[string]string

VolumeContext represents the same settings as a string map.