cache

Documentation

Index

• Constants
• Variables
• func Digest2filename(digest digest.Digest) string
• func EventAnnotations(image string) map[string]string
• func EventLabels(image string) map[string]string
• func GetImageEvents(kube kubernetes.Interface, eventNamespace, image string) ([]v1.Event, error)
• func MakeDaemonSet(name, namespace, image string, labels map[string]string, args []string, ...) *appsv1.DaemonSet
• func MakeRbac(name, namespace string) (*rbacv1.Role, *rbacv1.RoleBinding)
• func MakeServiceAccount(name, namespace string) *v1.ServiceAccount
• func NewDeployer(kube kubernetes.Interface, namespace, name string, imageRepo, imageTag string, ...) *deployer
• func NewLocalImagePuller(imageCache Cache, refFile string, directory string, ...) *localImagePuller
• type Cache
  • func NewCache(puller pull.ImagePuller) Cache
• type CacheImpl
  • func (c *CacheImpl) Add(ctx context.Context, ref string) (digest.Digest, error)
  • func (c *CacheImpl) Get(ctx context.Context, digest digest.Digest) (model.Filter, error)
  • func (c *CacheImpl) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type Deployer
• type EventNotifier
• type LocalImagePuller
• type Notifier
  • func NewNotifier(kube kubernetes.Interface, wasmeNamespace string, cacheName string) *Notifier
  • func (n *Notifier) Notify(err error, image string) error

Constants

const (
	// marked as "true" always, for searching
	CacheGlobalLabel = "cache.wasme.io/cache_event"
	// ref to the image
	CacheImageRefLabel = "cache.wasme.io/image_ref"
	Reason_ImageAdded  = "ImageAdded"
	Reason_ImageError  = "ImageError"
)

Variables

var (
	CacheName            = "wasme-cache"
	CacheNamespace       = "wasme"
	CacheImageRepository = "quay.io/solo-io/wasme"
	CacheImageTag        = version.Version
	ImagesKey            = "images"
	DefaultCacheArgs     = func(namespace string) []string {
		return []string{
			"cache",
			"--directory",
			"/var/local/lib/wasme-cache",
			"--ref-file",
			"/etc/wasme-cache/images.txt",
			"--cache-ns",
			namespace,
		}
	}
)

Functions

func Digest2filename

func Digest2filename(digest digest.Digest) string

func EventAnnotations

func EventAnnotations(image string) map[string]string

func EventLabels

func EventLabels(image string) map[string]string

func GetImageEvents

func GetImageEvents(kube kubernetes.Interface, eventNamespace, image string) ([]v1.Event, error)

get the cache events for an image. used by tests and the istio deployer, not by this package

func MakeDaemonSet

func MakeDaemonSet(name, namespace, image string, labels map[string]string, args []string, pullPolicy v1.PullPolicy) *appsv1.DaemonSet

func MakeRbac

func MakeRbac(name, namespace string) (*rbacv1.Role, *rbacv1.RoleBinding)

func MakeServiceAccount

func MakeServiceAccount(name, namespace string) *v1.ServiceAccount

func NewDeployer

func NewDeployer(kube kubernetes.Interface, namespace, name string, imageRepo, imageTag string, args []string, pullPolicy v1.PullPolicy) *deployer

func NewLocalImagePuller

func NewLocalImagePuller(imageCache Cache, refFile string, directory string, cacheNotifier EventNotifier) *localImagePuller

Types

type Cache

type Cache interface {
	// adds the image retrieve the digest for the image.
	// the digest will be cached if it is the initial Get
	Add(ctx context.Context, image string) (digest.Digest, error)

	// retrieve the wasm file from the image
	Get(ctx context.Context, digest digest.Digest) (model.Filter, error)
	http.Handler
}

Cache stores digests and image contents in memory

func NewCache

func NewCache(puller pull.ImagePuller) Cache

type CacheImpl

type CacheImpl struct {
	Puller pull.ImagePuller
	// contains filtered or unexported fields
}

func (*CacheImpl) Add

func (c *CacheImpl) Add(ctx context.Context, ref string) (digest.Digest, error)

func (*CacheImpl) Get

func (c *CacheImpl) Get(ctx context.Context, digest digest.Digest) (model.Filter, error)

func (*CacheImpl) ServeHTTP

func (c *CacheImpl) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type Deployer

type Deployer interface {
	// ensures the desired cache is deployed.
	// if a cache component already exists, it is updated
	EnsureCache() error
}

the cache deployer deploys an instance of the cache to Kubernetes.

type EventNotifier

type EventNotifier interface {
	Notify(err error, image string) error
}

type LocalImagePuller

type LocalImagePuller interface {
	// watches ref file (images.txt) pulls each image to disk
	WatchFile(ctx context.Context) error
}

pulls images for a local cache

type Notifier

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

sends Events to kubernetes when images are added to the cache

func NewNotifier

func NewNotifier(kube kubernetes.Interface, wasmeNamespace string, cacheName string) *Notifier

func (*Notifier) Notify

func (n *Notifier) Notify(err error, image string) error