secretsdrain

Documentation

Overview

Package secretsdrain provides the api client for the secretsdrain facade.

Index

• type ChangeSecretBackendArg
• type ChangeSecretBackendResult
  • func (r ChangeSecretBackendResult) ErrorCount() (out int)
• type Client
  • func NewClient(facade base.FacadeCaller) *Client
  • func (c *Client) ChangeSecretBackend(ctx context.Context, metaRevisions []ChangeSecretBackendArg) (ChangeSecretBackendResult, error)
  • func (c *Client) GetSecretsToDrain(ctx context.Context) ([]coresecrets.SecretMetadataForDrain, error)
  • func (c *Client) WatchSecretBackendChanged(ctx context.Context) (watcher.NotifyWatcher, error)

Types

type ChangeSecretBackendArg

type ChangeSecretBackendArg struct {
	URI      *coresecrets.URI
	Revision int
	Data     map[string]string
	ValueRef *coresecrets.ValueRef
}

ChangeSecretBackendArg is the argument for ChangeSecretBackend.

type ChangeSecretBackendResult

type ChangeSecretBackendResult struct {
	Results []error
}

ChangeSecretBackendResult is the result for ChangeSecretBackend.

func (ChangeSecretBackendResult) ErrorCount

func (r ChangeSecretBackendResult) ErrorCount() (out int)

ErrorCount returns the number of errors in the result.

type Client

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

Client is the api client for the SecretsDrain facade.

func NewClient

func NewClient(facade base.FacadeCaller) *Client

NewClient creates a secrets api client.

func (*Client) ChangeSecretBackend

func (c *Client) ChangeSecretBackend(ctx context.Context, metaRevisions []ChangeSecretBackendArg) (ChangeSecretBackendResult, error)

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

func (*Client) GetSecretsToDrain

func (c *Client) GetSecretsToDrain(ctx context.Context) ([]coresecrets.SecretMetadataForDrain, error)

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

func (*Client) WatchSecretBackendChanged

func (c *Client) WatchSecretBackendChanged(ctx context.Context) (watcher.NotifyWatcher, error)

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