secretspruner

Documentation

Overview

Package secretspruner provides a worker for tracking and pruning when a user supplied secret revision is obsolote.

Index

• func Manifold(config ManifoldConfig) dependency.Manifold
• func NewWorker(config Config) (worker.Worker, error)
• type Config
  • func (config Config) Validate() error
• type Logger
• type ManifoldConfig
  • func (cfg ManifoldConfig) Validate() error
• type SecretsFacade
  • func NewUserSecretsFacade(caller base.APICaller) SecretsFacade
• type Worker
  • func (w *Worker) Kill()
  • func (w *Worker) Wait() error

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a Manifold that encapsulates the secretspruner worker.

func NewWorker

func NewWorker(config Config) (worker.Worker, error)

NewWorker returns a secretspruner Worker backed by config, or an error.

Types

type Config

type Config struct {
	SecretsFacade
	Logger Logger
}

Config defines the operation of the Worker.

func (Config) Validate

func (config Config) Validate() error

Validate returns an error if config cannot drive the Worker.

type Logger

type Logger interface {
	Debugf(string, ...interface{})
	Warningf(string, ...interface{})
	Infof(string, ...interface{})
}

Logger represents the methods used by the worker to log information.

type ManifoldConfig

type ManifoldConfig struct {
	APICallerName string
	Logger        Logger

	NewUserSecretsFacade func(base.APICaller) SecretsFacade
	NewWorker            func(Config) (worker.Worker, error)
}

ManifoldConfig describes the resources used by the secretspruner worker.

func (ManifoldConfig) Validate

func (cfg ManifoldConfig) Validate() error

Validate is called by start to check for bad configuration.

type SecretsFacade

type SecretsFacade interface {
	WatchRevisionsToPrune() (watcher.StringsWatcher, error)
	DeleteRevisions(uri *coresecrets.URI, revisions ...int) error
}

SecretsFacade instances provide a set of API for the worker to deal with secret prune.

func NewUserSecretsFacade

func NewUserSecretsFacade(caller base.APICaller) SecretsFacade

NewUserSecretsFacade returns a new SecretsFacade.

type Worker

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

Worker prunes the user supplied secret revisions.

func (*Worker) Kill

func (w *Worker) Kill()

Kill is defined on worker.Worker.

func (*Worker) Wait

func (w *Worker) Wait() error

Wait is part of the worker.Worker interface.