types

Documentation

Overview

Package types defines types used only by volume components

Index

• Constants
• func IsOperationFinishedError(err error) bool
• func IsUncertainProgressError(err error) bool
• type GeneratedOperations
  • func (o *GeneratedOperations) Run() (eventErr, detailedErr error)
• type TransientOperationFailure
  • func NewTransientOperationFailure(msg string) *TransientOperationFailure
  • func (err *TransientOperationFailure) Error() string
• type UncertainProgressError
  • func NewUncertainProgressError(msg string) *UncertainProgressError
  • func (err *UncertainProgressError) Error() string
• type UniquePVCName
• type UniquePodName

Constants

const (
	// VolumeResizerKey is key that will be used to store resizer used
	// for resizing PVC. The generated key/value pair will be added
	// as a annotation to the PVC.
	VolumeResizerKey = "volume.kubernetes.io/storage-resizer"
)

Functions

func IsOperationFinishedError

func IsOperationFinishedError(err error) bool

IsOperationFinishedError checks if given error is of type that indicates operation is finished with a FINAL error.

func IsUncertainProgressError

func IsUncertainProgressError(err error) bool

IsUncertainProgressError checks if given error is of type that indicates operation might be in-progress in background.

Types

type GeneratedOperations

type GeneratedOperations struct {
	// Name of operation - could be used for resetting shared exponential backoff
	OperationName     string
	OperationFunc     func() (eventErr error, detailedErr error)
	EventRecorderFunc func(*error)
	CompleteFunc      func(*error)
}

GeneratedOperations contains the operation that is created as well as supporting functions required for the operation executor

func (*GeneratedOperations) Run

func (o *GeneratedOperations) Run() (eventErr, detailedErr error)

Run executes the operations and its supporting functions

type TransientOperationFailure

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

TransientOperationFailure indicates operation failed with a transient error and may fix itself when retried.

func NewTransientOperationFailure

func NewTransientOperationFailure(msg string) *TransientOperationFailure

NewTransientOperationFailure creates an instance of TransientOperationFailure error

func (*TransientOperationFailure) Error

func (err *TransientOperationFailure) Error() string

type UncertainProgressError

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

UncertainProgressError indicates operation failed with a non-final error and operation may be in-progress in background.

func NewUncertainProgressError

func NewUncertainProgressError(msg string) *UncertainProgressError

NewUncertainProgressError creates an instance of UncertainProgressError type

func (*UncertainProgressError) Error

func (err *UncertainProgressError) Error() string

type UniquePVCName

type UniquePVCName types.UID

UniquePVCName defines the type to key pvc off

type UniquePodName

type UniquePodName types.UID

UniquePodName defines the type to key pods off of