crud

Documentation

Index

• Constants
• func FromSecret(resource string, secret *corev1.Secret, data JSON) error
• type JSON
• type Storage
  • func New(resource string, secrets corev1client.SecretInterface, clock func() time.Time) Storage

Constants

const (
	SecretLabelKey = "storage.pinniped.dev/type"

	SecretLifetimeAnnotationKey        = "storage.pinniped.dev/garbage-collect-after"
	SecretLifetimeAnnotationDateFormat = time.RFC3339

	ErrSecretTypeMismatch    = constable.Error("secret storage data has incorrect type")
	ErrSecretLabelMismatch   = constable.Error("secret storage data has incorrect label")
	ErrSecretVersionMismatch = constable.Error("secret storage data has incorrect version")
)

Functions

func FromSecret

func FromSecret(resource string, secret *corev1.Secret, data JSON) error

FromSecret is similar to Get, but for when you already have a Secret in hand, e.g. from an informer. It validates and unmarshals the Secret. The data parameter is filled in as the result.

Types

type JSON

type JSON any // document that we need valid JSON types

type Storage

type Storage interface {
	Create(ctx context.Context, signature string, data JSON, additionalLabels map[string]string, ownerReferences []metav1.OwnerReference, lifetime time.Duration) (resourceVersion string, err error)
	Get(ctx context.Context, signature string, data JSON) (resourceVersion string, err error)
	Update(ctx context.Context, signature, resourceVersion string, data JSON) (newResourceVersion string, err error)
	Delete(ctx context.Context, signature string) error
	DeleteByLabel(ctx context.Context, labelName string, labelValue string) error
	GetName(signature string) string
}

func New

func New(resource string, secrets corev1client.SecretInterface, clock func() time.Time) Storage