crdstorage

README

crdstorage

Package crdstorage implements the microstorage interface to provide storage primitives based on Kubernetes CRDs. The microstorage implementation using Kubernetes third-party-objects as its backend.

projects using crdstorage

• https://github.com/giantswarm/api
• https://github.com/giantswarm/cluster-service
• https://github.com/giantswarm/companyd
• https://github.com/giantswarm/kubernetesd
• https://github.com/giantswarm/kvm-operator
• https://github.com/giantswarm/tokend
• https://github.com/giantswarm/userd

Documentation

Index

• func IsInvalidConfig(err error) bool
• type Config
• type Storage
  • func New(config Config) (*Storage, error)
  • func (s *Storage) Boot(ctx context.Context) error
  • func (s *Storage) Delete(ctx context.Context, k microstorage.K) error
  • func (s *Storage) Exists(ctx context.Context, k microstorage.K) (bool, error)
  • func (s *Storage) List(ctx context.Context, k microstorage.K) ([]microstorage.KV, error)
  • func (s *Storage) Put(ctx context.Context, kv microstorage.KV) error
  • func (s *Storage) Search(ctx context.Context, k microstorage.K) (microstorage.KV, error)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	G8sClient versioned.Interface
	K8sClient kubernetes.Interface
	Logger    micrologger.Logger

	Name      string
	Namespace *corev1.Namespace
}

type Storage

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

func New

func New(config Config) (*Storage, error)

New creates an uninitialized instance of Storage. It is required to call Boot before running any read/write operations against the returned Storage instance.

func (*Storage) Boot

func (s *Storage) Boot(ctx context.Context) error

Boot initializes the Storage by ensuring Kubernetes resources used by the Storage are in place. It is safe to call Boot more than once.

func (*Storage) Delete

func (s *Storage) Delete(ctx context.Context, k microstorage.K) error

func (*Storage) Exists

func (s *Storage) Exists(ctx context.Context, k microstorage.K) (bool, error)

func (*Storage) List

func (s *Storage) List(ctx context.Context, k microstorage.K) ([]microstorage.KV, error)

func (*Storage) Put

func (s *Storage) Put(ctx context.Context, kv microstorage.KV) error

func (*Storage) Search

func (s *Storage) Search(ctx context.Context, k microstorage.K) (microstorage.KV, error)