driver

Documentation

Index

• Constants
• Variables
• type ConfigMaps
  • func NewConfigMaps(impl corev1.ConfigMapInterface) *ConfigMaps
  • func (cfgmaps *ConfigMaps) Create(key string, rls *rspb.Release) error
  • func (cfgmaps *ConfigMaps) Delete(key string) (rls *rspb.Release, err error)
  • func (cfgmaps *ConfigMaps) Get(key string) (*rspb.Release, error)
  • func (cfgmaps *ConfigMaps) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)
  • func (cfgmaps *ConfigMaps) Name() string
  • func (cfgmaps *ConfigMaps) Query(labels map[string]string) ([]*rspb.Release, error)
  • func (cfgmaps *ConfigMaps) Update(key string, rls *rspb.Release) error
• type Creator
• type Deletor
• type Driver
• type Memory
  • func NewMemory() *Memory
  • func (mem *Memory) Create(key string, rls *rspb.Release) error
  • func (mem *Memory) Delete(key string) (*rspb.Release, error)
  • func (mem *Memory) Get(key string) (*rspb.Release, error)
  • func (mem *Memory) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)
  • func (mem *Memory) Name() string
  • func (mem *Memory) Query(keyvals map[string]string) ([]*rspb.Release, error)
  • func (mem *Memory) SetNamespace(ns string)
  • func (mem *Memory) Update(key string, rls *rspb.Release) error
• type Queryor
• type Secrets
  • func NewSecrets(impl corev1.SecretInterface) *Secrets
  • func (secrets *Secrets) Create(key string, rls *rspb.Release) error
  • func (secrets *Secrets) Delete(key string) (rls *rspb.Release, err error)
  • func (secrets *Secrets) Get(key string) (*rspb.Release, error)
  • func (secrets *Secrets) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)
  • func (secrets *Secrets) Name() string
  • func (secrets *Secrets) Query(labels map[string]string) ([]*rspb.Release, error)
  • func (secrets *Secrets) Update(key string, rls *rspb.Release) error
• type Updator

Constants

const ConfigMapsDriverName = "ConfigMap"

ConfigMapsDriverName is the string name of the driver.

const (
	// MemoryDriverName is the string name of this driver.
	MemoryDriverName = "Memory"
)

const SecretsDriverName = "Secret"

SecretsDriverName is the string name of the driver.

Variables

var (
	// ErrReleaseNotFound indicates that a release is not found.
	ErrReleaseNotFound = errors.New("release: not found")
	// ErrReleaseExists indicates that a release already exists.
	ErrReleaseExists = errors.New("release: already exists")
	// ErrInvalidKey indicates that a release key could not be parsed.
	ErrInvalidKey = errors.Errorf("release: invalid key")
)

Types

type ConfigMaps

type ConfigMaps struct {
	Log func(string, ...interface{})
	// contains filtered or unexported fields
}

ConfigMaps is a wrapper around an implementation of a kubernetes ConfigMapsInterface.

func NewConfigMaps

func NewConfigMaps(impl corev1.ConfigMapInterface) *ConfigMaps

NewConfigMaps initializes a new ConfigMaps wrapping an implementation of the kubernetes ConfigMapsInterface.

func (*ConfigMaps) Create

func (cfgmaps *ConfigMaps) Create(key string, rls *rspb.Release) error

Create creates a new ConfigMap holding the release. If the ConfigMap already exists, ErrReleaseExists is returned.

func (*ConfigMaps) Delete

func (cfgmaps *ConfigMaps) Delete(key string) (rls *rspb.Release, err error)

Delete deletes the ConfigMap holding the release named by key.

func (*ConfigMaps) Get

func (cfgmaps *ConfigMaps) Get(key string) (*rspb.Release, error)

Get fetches the release named by key. The corresponding release is returned or error if not found.

func (*ConfigMaps) List

func (cfgmaps *ConfigMaps) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)

List fetches all releases and returns the list releases such that filter(release) == true. An error is returned if the configmap fails to retrieve the releases.

func (*ConfigMaps) Name

func (cfgmaps *ConfigMaps) Name() string

Name returns the name of the driver.

func (*ConfigMaps) Query

func (cfgmaps *ConfigMaps) Query(labels map[string]string) ([]*rspb.Release, error)

Query fetches all releases that match the provided map of labels. An error is returned if the configmap fails to retrieve the releases.

func (*ConfigMaps) Update

func (cfgmaps *ConfigMaps) Update(key string, rls *rspb.Release) error

Update updates the ConfigMap holding the release. If not found the ConfigMap is created to hold the release.

type Creator

type Creator interface {
	Create(key string, rls *rspb.Release) error
}

Creator is the interface that wraps the Create method.

Create stores the release or returns ErrReleaseExists if an identical release already exists.

type Deletor

type Deletor interface {
	Delete(key string) (*rspb.Release, error)
}

Deletor is the interface that wraps the Delete method.

Delete deletes the release named by key or returns ErrReleaseNotFound if the release does not exist.

type Driver

type Driver interface {
	Creator
	Updator
	Deletor
	Queryor
	Name() string
}

Driver is the interface composed of Creator, Updator, Deletor, and Queryor interfaces. It defines the behavior for storing, updating, deleted, and retrieving Helm releases from some underlying storage mechanism, e.g. memory, configmaps.

type Memory

type Memory struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Memory is the in-memory storage driver implementation.

func NewMemory

func NewMemory() *Memory

NewMemory initializes a new memory driver.

func (*Memory) Create

func (mem *Memory) Create(key string, rls *rspb.Release) error

Create creates a new release or returns ErrReleaseExists.

func (*Memory) Delete

func (mem *Memory) Delete(key string) (*rspb.Release, error)

Delete deletes a release or returns ErrReleaseNotFound.

func (*Memory) Get

func (mem *Memory) Get(key string) (*rspb.Release, error)

Get returns the release named by key or returns ErrReleaseNotFound.

func (*Memory) List

func (mem *Memory) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)

List returns the list of all releases such that filter(release) == true

func (*Memory) Name

func (mem *Memory) Name() string

Name returns the name of the driver.

func (*Memory) Query

func (mem *Memory) Query(keyvals map[string]string) ([]*rspb.Release, error)

Query returns the set of releases that match the provided set of labels

func (*Memory) SetNamespace

func (mem *Memory) SetNamespace(ns string)

SetNamespace sets a specific namespace in which releases will be accessed. An empty string indicates all namespaces (for the list operation)

func (*Memory) Update

func (mem *Memory) Update(key string, rls *rspb.Release) error

Update updates a release or returns ErrReleaseNotFound.

type Queryor

type Queryor interface {
	Get(key string) (*rspb.Release, error)
	List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)
	Query(labels map[string]string) ([]*rspb.Release, error)
}

Queryor is the interface that wraps the Get and List methods.

Get returns the release named by key or returns ErrReleaseNotFound if the release does not exist.

List returns the set of all releases that satisfy the filter predicate.

Query returns the set of all releases that match the provided label set.

type Secrets

type Secrets struct {
	Log func(string, ...interface{})
	// contains filtered or unexported fields
}

Secrets is a wrapper around an implementation of a kubernetes SecretsInterface.

func NewSecrets

func NewSecrets(impl corev1.SecretInterface) *Secrets

NewSecrets initializes a new Secrets wrapping an implementation of the kubernetes SecretsInterface.

func (*Secrets) Create

func (secrets *Secrets) Create(key string, rls *rspb.Release) error

Create creates a new Secret holding the release. If the Secret already exists, ErrReleaseExists is returned.

func (*Secrets) Delete

func (secrets *Secrets) Delete(key string) (rls *rspb.Release, err error)

Delete deletes the Secret holding the release named by key.

func (*Secrets) Get

func (secrets *Secrets) Get(key string) (*rspb.Release, error)

Get fetches the release named by key. The corresponding release is returned or error if not found.

func (*Secrets) List

func (secrets *Secrets) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error)

List fetches all releases and returns the list releases such that filter(release) == true. An error is returned if the secret fails to retrieve the releases.

func (*Secrets) Name

func (secrets *Secrets) Name() string

Name returns the name of the driver.

func (*Secrets) Query

func (secrets *Secrets) Query(labels map[string]string) ([]*rspb.Release, error)

Query fetches all releases that match the provided map of labels. An error is returned if the secret fails to retrieve the releases.

func (*Secrets) Update

func (secrets *Secrets) Update(key string, rls *rspb.Release) error

Update updates the Secret holding the release. If not found the Secret is created to hold the release.

type Updator

type Updator interface {
	Update(key string, rls *rspb.Release) error
}

Updator is the interface that wraps the Update method.

Update updates an existing release or returns ErrReleaseNotFound if the release does not exist.