secrets

Documentation

Index

• func LeadershipToken(authTag names.Tag, leadershipChecker leadership.Checker) (leadership.Token, error)
• func OwnerTagFromOwner(owner coresecrets.Owner) (names.Tag, error)
• type SecretBackendService
• type SecretService
• type SecretsDrainAPI
  • func NewSecretsDrainAPI(authTag names.Tag, authorizer facade.Authorizer, logger logger.Logger, ...) (*SecretsDrainAPI, error)
  • func (s *SecretsDrainAPI) ChangeSecretBackend(ctx context.Context, args params.ChangeSecretBackendArgs) (params.ErrorResults, error)
  • func (s *SecretsDrainAPI) GetSecretsToDrain(ctx context.Context) (params.SecretRevisionsToDrainResults, error)
  • func (s *SecretsDrainAPI) WatchSecretBackendChanged(ctx context.Context) (params.NotifyWatchResult, error)

Functions

func LeadershipToken

func LeadershipToken(authTag names.Tag, leadershipChecker leadership.Checker) (leadership.Token, error)

LeadershipToken returns a token used to determine if the authenticated caller is the unit leader of its application.

func OwnerTagFromOwner

func OwnerTagFromOwner(owner coresecrets.Owner) (names.Tag, error)

OwnerTagFromOwner returns the tag for a given secret owner.

Types

type SecretBackendService

type SecretBackendService interface {
	GetRevisionsToDrain(ctx context.Context, modelUUID coremodel.UUID, revs []secrets.SecretExternalRevision) ([]backendservice.RevisionInfo, error)
	WatchModelSecretBackendChanged(ctx context.Context, modelUUID coremodel.UUID) (watcher.NotifyWatcher, error)
}

SecretBackendService instances provide secret backend service apis.

type SecretService

type SecretService interface {
	ListCharmSecretsToDrain(
		ctx context.Context, owners ...secretservice.CharmSecretOwner,
	) ([]*secrets.SecretMetadataForDrain, error)
	ListUserSecretsToDrain(ctx context.Context) ([]*secrets.SecretMetadataForDrain, error)
	ChangeSecretBackend(ctx context.Context, uri *secrets.URI, revision int, params secretservice.ChangeSecretBackendParams) error
}

SecretService instances provide secret service apis.

type SecretsDrainAPI

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

SecretsDrainAPI is the implementation for the SecretsDrain facade.

func NewSecretsDrainAPI

func NewSecretsDrainAPI(
	authTag names.Tag,
	authorizer facade.Authorizer,
	logger logger.Logger,
	leadershipChecker leadership.Checker,
	modelUUID model.UUID,
	secretService SecretService,
	secretBackendService SecretBackendService,
	watcherRegistry facade.WatcherRegistry,
) (*SecretsDrainAPI, error)

NewSecretsDrainAPI returns a new SecretsDrainAPI.

func (*SecretsDrainAPI) ChangeSecretBackend

func (s *SecretsDrainAPI) ChangeSecretBackend(ctx context.Context, args params.ChangeSecretBackendArgs) (params.ErrorResults, error)

ChangeSecretBackend updates the backend for the specified secret after migration done.

func (*SecretsDrainAPI) GetSecretsToDrain

func (s *SecretsDrainAPI) GetSecretsToDrain(ctx context.Context) (params.SecretRevisionsToDrainResults, error)

GetSecretsToDrain returns metadata for the secrets that need to be drained.

func (*SecretsDrainAPI) WatchSecretBackendChanged

func (s *SecretsDrainAPI) WatchSecretBackendChanged(ctx context.Context) (params.NotifyWatchResult, error)

WatchSecretBackendChanged sets up a watcher to notify of changes to the secret backend.