secretrotate

Documentation

Overview

Package secretrotate provides a worker for tracking and notifying when a secret should be rotated.

Index

• func New(config Config) (worker.Worker, error)
• type Config
  • func (config Config) Validate() error
• type SecretManagerFacade
• type Worker
  • func (w *Worker) Kill()
  • func (w *Worker) Wait() error

Functions

func New

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

New returns a Secret Rotation Worker backed by config, or an error.

Types

type Config

type Config struct {
	SecretManagerFacade SecretManagerFacade
	Logger              logger.Logger
	Clock               clock.Clock

	SecretOwners  []names.Tag
	RotateSecrets chan<- []string
}

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 SecretManagerFacade

type SecretManagerFacade interface {
	WatchSecretsRotationChanges(ctx context.Context, ownerTags ...names.Tag) (watcher.SecretTriggerWatcher, error)
}

SecretManagerFacade 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.