Categorygithub.com/itzmanish/go-micro-plugins/config/source/consul/v2
modulepackage
2.10.0
Repository: https://github.com/itzmanish/go-micro-plugins.git
Documentation: pkg.go.dev

# README

Consul Source

The consul source reads config from consul key/values

Consul Format

The consul source expects keys under the default prefix /micro/config

Values are expected to be json

// set database
consul kv put micro/config/database '{"address": "10.0.0.1", "port": 3306}'
// set cache
consul kv put micro/config/cache '{"address": "10.0.0.2", "port": 6379}'

Keys are split on / so access becomes

conf.Get("micro", "config", "database")

New Source

Specify source with data

consulSource := consul.NewSource(
	// optionally specify consul address; default to localhost:8500
	consul.WithAddress("10.0.0.10:8500"),
	// optionally specify prefix; defaults to /micro/config
	consul.WithPrefix("/my/prefix"),
  // optionally strip the provided prefix from the keys, defaults to false
  consul.StripPrefix(true),
)

Load Source

Load the source into config

// Create new config
conf := config.NewConfig()

// Load consul source
conf.Load(consulSource)

# Functions

NewSource creates a new consul source.
StripPrefix indicates whether to remove the prefix from config entries, or leave it in place.
WithAddress sets the consul address.
WithConfig set consul-specific options.
No description provided by the author
WithPrefix sets the key prefix to use.
WithToken sets the key token to use.

# Variables

DefaultPrefix is the prefix that consul keys will be assumed to have if you haven't specified one.