image

Documentation

Index

• type FuncTagGenerator
  • func (f FuncTagGenerator) Generate(spec *Volume) (string, error)
• type Phase
• type Stager
  • func (stager *Stager) RollBackStageIn(vol *Volume) error
  • func (stager *Stager) StageIn(vol *Volume) error
  • func (stager *Stager) StageOut(vol *Volume) error
  • func (stager *Stager) StartGarbageCollection(stop chan struct{})
• type Volume
  • func NewVolume(req *csi.NodePublishVolumeRequest, clock clock.Clock, ...) (*Volume, error)

Types

type FuncTagGenerator

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

func (FuncTagGenerator) Generate

func (f FuncTagGenerator) Generate(spec *Volume) (string, error)

type Phase

type Phase string

const (
	DockerConfigJsonKey = ".dockerconfigjson"

	// publish states
	PhaseInitState         Phase = "InitState"
	PhaseContainerCreated  Phase = "ContainerCreated"
	PhaseContainerMounted  Phase = "ContainerMounted"
	PhaseTargetPathMounted Phase = "TargetPathMounted"
	PhasePublished         Phase = "Published"

	// unpublish states
	PhaseTargetPathUnMounted  Phase = "TargetPathUnMounted"
	PhaseContainerCommitted   Phase = "ContainerCommitted"
	PhaseContainerUnMounted   Phase = "ContainerUnMounted"
	PhaseContainerImagePushed Phase = "ContainerImagePushed"
	PhaseContainerDeleted     Phase = "ContainerDeleted"
	PhaseUnPublished          Phase = "UnPublished"
)

type Stager

type Stager struct {
	Buildah  *buildah.Client
	GcPeriod time.Duration
	Recorder record.EventRecorder
}

func (*Stager) RollBackStageIn

func (stager *Stager) RollBackStageIn(vol *Volume) error

func (*Stager) StageIn

func (stager *Stager) StageIn(vol *Volume) error

func (*Stager) StageOut

func (stager *Stager) StageOut(vol *Volume) error

func (*Stager) StartGarbageCollection

func (stager *Stager) StartGarbageCollection(stop chan struct{})

type Volume

type Volume struct {
	Clock clock.Clock

	// User defined spec
	Spec         api.StagerSpec
	TagGenerator tagGenerator

	// values from PublishVolumeRequest
	ReadOnly         bool
	VolumeID         string
	TargetPath       string
	DockerConfigJson string
	PodInfo          util.PodInfo

	// Status
	Phase           Phase
	ProvisionedRoot string
	ImageToPush     string
	// contains filtered or unexported fields
}

func NewVolume

func NewVolume(req *csi.NodePublishVolumeRequest, clock clock.Clock, defaultStageInImage string) (*Volume, error)