provisioner

Documentation

Index

• Constants
• func New(client efsiface.EFSAPI, params Params) (controller.Provisioner, error)
• type LifeCycleState
• type Params
• type Provisioner
  • func (p *Provisioner) Delete(volume *corev1.PersistentVolume) error
  • func (p *Provisioner) Provision(options controller.ProvisionOptions) (*corev1.PersistentVolume, error)

Constants

const MountOptionAnnotation = "volume.beta.kubernetes.io/mount-options"

MountOptionAnnotation is the annotation on a PV object that specifies a comma separated list of mount options

Functions

func New

func New(client efsiface.EFSAPI, params Params) (controller.Provisioner, error)

New provisioner for creating and deleting EFS volumes.

Types

type LifeCycleState

type LifeCycleState string

LifeCycleState contains all the states which an EFS can be.

const (
	// LifeCycleStateReady shows when the Elastic Filesystem is ready.
	LifeCycleStateReady LifeCycleState = "Ready"

	// LifeCycleStateNotReady shows when the Elastic Filesystem is not ready.
	LifeCycleStateNotReady LifeCycleState = "Not Ready"

	// LifeCycleStateUnknown shows when we are not sure what the state is of the Elastic Filesystem.
	LifeCycleStateUnknown LifeCycleState = "Unknown"
)

type Params

type Params struct {
	Region        string   `envconfig:"AWS_REGION"         default:"ap-southeast-2"`
	Format        string   `envconfig:"EFS_NAME_FORMAT"    default:"{{ .PVC.ObjectMeta.Namespace }}-{{ .PVName }}"`
	Performance   string   `envconfig:"EFS_PERFORMANCE"    default:"generalPurpose"`
	SecurityGroup string   `envconfig:"AWS_SECURITY_GROUP" required:"true"`
	Subnets       []string `envconfig:"AWS_SUBNETS"        required:"true"`
}

Params required for provisioning volumes.

type Provisioner

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

Provisioner for creating volumes.

func (*Provisioner) Delete

func (p *Provisioner) Delete(volume *corev1.PersistentVolume) error

Delete removes the storage asset that was created by Provision represented by the given PV. @todo, Tag FileSystem as "ready for removal" @todo, Tag FileSystem with a date to show how old it is.

func (*Provisioner) Provision

func (p *Provisioner) Provision(options controller.ProvisionOptions) (*corev1.PersistentVolume, error)

Provision creates a storage asset and returns a PV object representing it.