secretbackendrotate

Documentation

Overview

Package secretbackendrotate provides a worker for tracking and rotating a secret backend token.

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 (c ManifoldConfig) Validate() error
• type SecretBackendManagerFacade
• type Worker
  • func (w *Worker) Kill()
  • func (w *Worker) Wait() error

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a dependency.Manifold that runs a secretbackendrotate worker.

func NewWorker

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

NewWorker returns a Secret Backend token rotation Worker backed by config, or an error.

Types

type Config

type Config struct {
	SecretBackendManagerFacade SecretBackendManagerFacade
	Logger                     Logger
	Clock                      clock.Clock
}

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{})
}

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

type ManifoldConfig

type ManifoldConfig struct {
	Logger        Logger
	APICallerName string
}

ManifoldConfig holds dependencies and configuration for a secretbackendrotate worker.

func (ManifoldConfig) Validate

func (c ManifoldConfig) Validate() error

Validate validates a manifold config.

type SecretBackendManagerFacade

type SecretBackendManagerFacade interface {
	WatchTokenRotationChanges() (watcher.SecretBackendRotateWatcher, error)
	RotateBackendTokens(info ...string) error
}

SecretBackendManagerFacade instances provide a watcher for secret rotation changes.

type Worker

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

Worker fires events when secrets should be rotated.

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.