etcd

ETCD configuration source

Configuration

## Configuration center related
asjard:
  config:
    ## etcd configuration center settings
    etcd:
      ## Configuration center name
      ## Configuration dependent on asjard.stores.etcd.clients.{client}
      # client: default
      ## Delimiter
      ## Delimiter between multiple keys in etcd
      # delimiter: "/"

Configuration priority

Priority increases from top to bottom. Use Englishasjard.config.etcd.delimiteras separator, do not end withasjard.config.etcd.delimiterending

• /{app}/configs/: Project-level global configuration

• /{app}/configs/{env}/: Environment-level global configuration

• /{app}/configs/service/{group}/: Service-related configuration

• /{app}/configs/service/{group}/{region}/: Service region-related configuration

• /{app}/configs/service/{group}/{region}/{az}/: Service region and availability zone configuration

• /{app}/configs/service/{service}/: Service-related configuration

• /{app}/configs/service/{service}/{region}/: Service region-related configuration

• /{app}/configs/service/{service}/{region}/{az}/: Service region and availability zone configuration

• /{app}/configs/{env}/service/{group}/: Service-related configuration

• /{app}/configs/{env}/service/{group}/{region}/: Service region-related configuration

• /{app}/configs/{env}/service/{group}/{region}/{az}/: Service region and availability zone configuration

• /{app}/configs/{env}/service/{service}/: Service-related configuration

• /{app}/configs/{env}/service/{service}/{region}/: Service region-related configuration

• /{app}/configs/{env}/service/{service}/{region}/{az}/: Service region and availability zone configuration

• /{app}/configs/runtime/{instance.ID}/: Instance configuration

If files exist under the same prefix, then all configurations in the files have the priority of that prefix

It is recommended not to use key/value and files at the same time, because priorities under the same prefix are the same, causing divergence between startup-time configuration overrides and runtime configuration overrides

For example:

## Key/value configured examples.timeout is 5ms
/examples/configs/examples/timeout
5ms

## File-based configured examples.timeout is 6ms
/examples/configs/global.yaml
examples:
  timeout: 6ms

# At startup, loaded in ASCII order: first /examples/configs/examples/timeout
# then /examples/configs/global.yaml will be loaded and override the previously loaded one
# So the examples.timeout you get is 6ms
# However
# When you modify it
# Because their values belong to the same priority, whichever you modify is what you will get
# If one day you modify /examples/configs/examples/timeout, without restarting it will be correct when fetched
# But after restarting the service you find it did not take effect, because the same configuration appears in different files at the same priority
# Causing a divergence between runtime logic and startup logic

Use

to add configuration. File configurations can be viewedhere

# Add configuration in key/value mode
etcdctl put /examples/configs/examples/timeout 5ms

# When adding by file, the key should end with json, yaml, yml, toml, props, or properties
# Otherwise it will be treated as plain text
etcdctl put /examples/configs/examples.yaml 'examples:
  timeout: 6ms'

import (
	// Import etcd configuration source
	_ "github.com/asjard/asjard/pkg/config/etcd"
)

config.GetDuration("examples.timeout", time.Second)