vault

Documentation

Overview

Package vault implements a koanf.Provider for Hashicorp Vault KV secrets engine and provides it to koanf to be parsed by a koanf.Parser.

Index

• type Config
• type Vault
  • func Provider(cfg Config) *Vault
  • func (r *Vault) Read() (map[string]interface{}, error)
  • func (r *Vault) ReadBytes() ([]byte, error)

Types

type Config

type Config struct {
	// Vault server address
	Address string

	// Vault static token
	Token string

	// Secret data path
	Path string

	// If FlatPaths is true, then the loaded configuration is not split into
	// hierarchical maps based on the delimiter. The keys including the delimiter,
	// eg: app.db.name stays as-is in the confmap.
	FlatPaths bool

	// Delim is the delimiter to use
	// when specifying config key paths, for instance a . for `parent.child.key`
	// or a / for `parent/child/key`.
	Delim string

	// Internal HTTP client timeout
	Timeout time.Duration

	// ExcludeMeta states whether the secret should be returned with its metadata.
	// If ExcludeMeta is true, no metadata will be returned, and the data can be
	// accessed as `k.String("key")`. If set to false, the value for data `key`
	// and the metadata `version` can be accessed as `k.String("data.key")` and
	// `k.Int("metadata.version")`.
	ExcludeMeta bool
}

type Vault

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

func Provider

func Provider(cfg Config) *Vault

Provider returns a provider that takes a Vault config.

func (*Vault) Read

func (r *Vault) Read() (map[string]interface{}, error)

Read fetches the configuration from the source and returns a nested config map.

func (*Vault) ReadBytes

func (r *Vault) ReadBytes() ([]byte, error)

ReadBytes is not supported by the vault provider.