util

Documentation

Index

• Constants
• Variables
• func EmitNormalEvent(recorder record.EventRecorder, object runtime.Object, resource EventResource)
• func EmitWarningEvent(recorder record.EventRecorder, object runtime.Object, resource EventResource)
• func EquateErrors() cmp.Option
• func LogErr(e error) error
• func ParseData(s *v1.Secret) ([]byte, error)
• func ParseValue(key string, volCtx map[string]string) (string, error)
• type EventResource

Constants

const (
	WrapErrorGetBARFailed = "get bucketAccessRequest failed"
	WrapErrorGetBAFailed  = "get bucketAccess failed"
	WrapErrorGetBRFailed  = "get bucketRequest failed"
	WrapErrorGetBFailed   = "get bucket failed"

	WrapErrorGetSecretFailed = "failed to get minted secret from bucketAccess"

	WrapErrorMarshalProtocolFailed = "failed to marshal bucket protocol"

	WrapErrorMkdirFailed              = "failed to mkdir for bucketPath on publish"
	WrapErrorFailedToCreateVolumeFile = "failed to create file in ephemeral volume"
	WrapErrorFailedToCreateBucketFile = "failed to create file in bucket mount folder"

	WrapErrorFailedRemoveDirectory    = "failed to remove directory after error"
	WrapErrorFailedToParseSecret      = "failed to parse secret"
	WrapErrorFailedToWriteProtocol    = "failed to write protocolConnection to mount volume"
	WrapErrorFailedToWriteCredentials = "failed to write credentials to mount volume"
	WrapErrorFailedToMountVolume      = "failed to mount ephemeral volume to pod"

	WrapErrorFailedToAddFinalizer    = "failed to add finalizer to bucketAccess"
	WrapErrorFailedToMarshalMetadata = "failed to marshal Metadata struct"
	WrapErrorFailedToWriteMetadata   = "failed to write metadata to disk"
	WrapErrorFailedToMkdirForMount   = "failed to mkdir when mounting bucket"

	WrapErrorFailedToReadMetadataFile  = "failed to read metadata file from volume"
	WrapErrorFailedToUnmarshalMetadata = "failed unable to unmarshal metadata from volume"
	WrapErrorFailedToRemoveFinalizer   = "failed to remove finalizer from bucketAccess"
	WrapErrorFailedToUnmountVolume     = "failed to unmount and clean volume"
	WrapErrorFailedToRemoveDir         = "failed to remove directory"

	WrapErrorCreatingFile  = "error when creating file"
	WrapErrorWritingToFile = "error when writing file"
)

const (
	BARNotReady = "BARNotReady"
	BANotReady  = "BANotReady"
	BRNotReady  = "BRNotReady"
	BNotReady   = "BNotReady"

	ResourcesReady     = "ResourceReady"
	WritingCredentials = "WritingCredentials"
	SuccessfulPublish  = "Success"
)

Variables

var (
	ErrorBARNoAccess = errors.New("bucketAccessRequest does not grant access")
	ErrorBARUnsetBR  = errors.New("bucketAccessRequest.Spec.BucketRequestName unset")
	ErrorBARUnsetBA  = errors.New("bucketAccessRequest.Status.BucketAccessName unset")

	ErrorBANoAccess       = errors.New("bucketAccess does not grant access")
	ErrorBANoMintedSecret = errors.New("bucketAccess.Status.MintedSecretName unset")

	ErrorBRNotAvailable    = errors.New("bucketRequest is not available yet")
	ErrorBRUnsetBucketName = errors.New("bucketRequest.Status.BucketInstanceName unset")

	ErrorBNotAvailable = errors.New("bucket is not available yet")

	ErrorInvalidProtocol = errors.New("unrecognized protocol, unable to extract connection data")
)

var (
	ErrorTemplateVolCtxUnset          = "required volume context key unset: %v"
	ErrorTemplateVolumeAlreadyMounted = "%s is already mounted"
	ErrorTemplateMountFailed          = "failed to mount device: %s at %s"
)

var (
	BARBucketRequestNotSet = EventResource{
							// contains filtered or unexported fields
	}
	BARAccessNotGranted = EventResource{
						// contains filtered or unexported fields
	}
	BARBucketAccessNotSet = EventResource{
							// contains filtered or unexported fields
	}

	BAAccessNotGranted = EventResource{
						// contains filtered or unexported fields
	}
	BAMintedSecretNotSet = EventResource{
							// contains filtered or unexported fields
	}

	BRNotAvailable = EventResource{
					// contains filtered or unexported fields
	}
	BRBucketNameNotSet = EventResource{
						// contains filtered or unexported fields
	}

	BNotAvailable = EventResource{
					// contains filtered or unexported fields
	}

	MintedSecretNotFound = EventResource{
							// contains filtered or unexported fields
	}
)

var (
	AllResourcesReady = EventResource{
						// contains filtered or unexported fields
	}

	CredentialsWritten = EventResource{
						// contains filtered or unexported fields
	}

	SuccessfullyPublishedVolume = EventResource{
								// contains filtered or unexported fields
	}

	SuccessfullyUnpublishedVolume = EventResource{
									// contains filtered or unexported fields
	}
)

Functions

func EmitNormalEvent

func EmitNormalEvent(recorder record.EventRecorder, object runtime.Object, resource EventResource)

func EmitWarningEvent

func EmitWarningEvent(recorder record.EventRecorder, object runtime.Object, resource EventResource)

func EquateErrors

func EquateErrors() cmp.Option

func LogErr

func LogErr(e error) error

logErr should be called at the interface method scope, prior to returning errors to the gRPC client.

func ParseData

func ParseData(s *v1.Secret) ([]byte, error)

func ParseValue

func ParseValue(key string, volCtx map[string]string) (string, error)

Types

type EventResource

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