configsource

Documentation

Index

• type Hook
• type ProviderWrapper
  • func New(logger *zap.Logger, hooks []Hook) *ProviderWrapper
  • func (pw *ProviderWrapper) ResolveForWrapped(ctx context.Context, uri string, onChange confmap.WatcherFunc, ...) (*confmap.Retrieved, error)
  • func (pw *ProviderWrapper) Wrap(provider confmap.ProviderFactory) confmap.ProviderFactory

Types

type Hook

type Hook interface {
	OnNew()
	OnRetrieve(scheme string, retrieved map[string]any)
	OnShutdown()
}

Hook is a means of providing introspection to a confmap.Provider's lifecycle, useful for evaluating Retrieve()'ed content.

type ProviderWrapper

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

ProviderWrapper is the entrypoint for existing confmap.Providers to be provided with configsource.ConfigSource retrieval functionality. Once Wrap()'ed, their Retrieve() method as invoked by the service's confmap.Resolver will be further resolved by any applicable ConfigSource directives (including any initial `config_sources:` settings declarations).

func New

func New(logger *zap.Logger, hooks []Hook) *ProviderWrapper

func (*ProviderWrapper) ResolveForWrapped

func (pw *ProviderWrapper) ResolveForWrapped(ctx context.Context, uri string, onChange confmap.WatcherFunc, w *wrappedProvider) (*confmap.Retrieved, error)

ResolveForWrapped will retrieve from the wrappedProvider and, if possible, resolve all config source directives with their resolved values. If the wrappedProvider's retrieved value is only valid AsRaw() (scalar/array) then that will be returned without further evaluation.

func (*ProviderWrapper) Wrap

func (pw *ProviderWrapper) Wrap(provider confmap.ProviderFactory) confmap.ProviderFactory

Wrap registers the provided confmap.ProviderWrapper in a provider store to proxy its methods and expose ConfigSource content resolution capabilities.