Skip to content

Latest commit

 

History

History
359 lines (291 loc) · 27.3 KB

CHANGELOG.md

File metadata and controls

359 lines (291 loc) · 27.3 KB

Bootstrap Module (in Go)

Github repository

Change Logs for EdgeX Dependencies

[v3.1.0] - 2023-11-15

✨ Features

  • Add EnableNameFieldEscape config (b63a581…)
  • Add new -rsh/--remoteServiceHosts flag and corresponding env override (#596) (1d77273…)
  • Add wrapper func to wrap http handler for Echo (e1ab269…)
  • Move the common middleware to go-mod-bootstrap (#567) (8addaa2…)
  • Replace gorilla/mux router with echo (#557) (d7c12cc…)
  • Add better error handling when common config is missing (#566) (dcdd37f…)
  • Move all the common APIs into go-mod-bootstrap (#562) (40eb783…)
  • Use loadfile that allows reading from local file or uri (#558) (b171584…)
  • Implement reusable load file function (#555) (d15a138…)

🐛 Bug Fixes

👷 Build

🧪 Testing

  • Add httpserver test for uri4files to check secret header (#597) (4fcc5d1…)

[v3.0.0] - 2023-05-31

Features ✨

  • Add support for wildcard in secret updated callback and rename RegisteredSecretUpdatedCallback (#d335988)
    BREAKING CHANGE: Renamed RegisteredSecretUpdatedCallback to RegisterSecretUpdatedCallback
    
  • Apply env overrides only when config loaded from file (#99b3ee9)
    BREAKING CHANGE: Overrides are no longer applied to values pulled from Configuration Provider. Configuration Provider is now the system of record for configuration, when used.
    
  • Load common configuration (#e74b4a8)
    BREAKING CHANGE: calls to bootstrap.RunAndReturnWaitGroup must include the service type
    
  • Rename environment variables for the sake of consistency (#402) (#ff25685)
    BREAKING CHANGE:
    - `EDGEX_CONFIGURTION_PROVIDER` is replaced by `EDGEX_CONFIG_PROVIDER`
    - `EDGEX_CONF_DIR` is replaced by `EDGEX_CONFIG_DIR`
    
  • Support /api/v3/secret endpoint in non-secure mode (#542) (#77722ae)
  • Add Metrics for getting secret token and getting secret (#8d6813b)
  • Add -d/--dev common command-line flag to put service in Dev Mode (#516) (#0c0b475)
  • Add command line/environment flag for commonConfig (#487) (#fed18d9)
  • Implement watch for common config writable (#456) (#f5fe044)
  • Implement new IsRegistered API for MetricsManager (#446) (#8ddd9e2)
  • Add go-mod-bootstrap hooks for JWT generation and verification (#a31da98)
  • Add go-mod-bootstrap hooks for JWT generation and verification (#8d2d623)

Bug Fixes 🐛

  • Check nil pointer in buildPaths() (#495) (#02bbd1b)
  • InsecureSecrets change detection (#525) (#a09e027)
  • Don't attempt to wrap error to LoggingClient (#3bc6273)
  • metrics: do not use shared DefaultRegistry and fix wg.Done call (#543) (#4aa258a)

Code Refactoring ♻

  • Rework SecretProvider interface so App/Device Services have limited API (#d95cec14)
    BREAKING CHANGE: Services that need full SecretProvider API now use SecretProviderExt. Extra APIs have been removed for App/Device Services.
    
  • Change Database timeout to a duration string (#0c6b57a)
    BREAKING CHANGE: Database Timeout type has changed from `int` to duration`string`. Update configuration appropriately.
    
  • Rework to remove use of TOML package (#4f2cfc7)
    BREAKING CHANGE: OverrideTomlValues changed to OverrideConfigMapValues and GetConfigLocation changed to GetConfigFileLocation
    
  • Switch to loading configuation files as YAML (#9d98d1e)
    BREAKING CHANGE: All configruation file must now be in YAML format. The default file name has changed to be configuration.yaml
    
  • Remove unused AuthModeKey and SecretNameKey (#91df2ca)
    BREAKING CHANGE: AuthModeKey and SecretNameKey public constants have been removed
    
  • Refactor all usages of path to be secretName in APIs (#7449463)
    BREAKING CHANGE: path parameter has been renamed to secretName in all APIs
    
  • Replace topics from config with new constants (#45461fa)
    BREAKING CHANGE: Topics no longer in configuration
    
  • Rework MessageBus configuration for all services to use consistently (#3599fd1)
    BREAKING CHANGE: MessageQueue renamed to MessageBus and fields changed. See v3 Migration guide.
    
  • Replace SecretStore service config with default values and overrides (#4709c62)
    BREAKING CHANGE: SecretStore config no longer in service configuration file. Changes must be done via use of environment variable overrides of default values
    
    
  • Rename command line flags for the sake of consistency (#010e84a)
    BREAKING CHANGE:
      - `-c/--confdir` to `-cd/--configDir`
      - `-f/--file` to `-cf/--configFile`
    
  • Don't add version to Config Stem (#6cf9e04)
    BREAKING CHANGE: Service configuration location in Consul has changed
    
  • Update module to v3 (#608b320)
    BREAKING CHANGE: Import paths will need to change to v3
    
  • Use updated config provider function for isCommonConfigReady (#450) (#e72e993)
  • Move configuration location code to public helper function (#422) (#7c7ee01)
  • Config processor createProviderClient from receiver to helper (#421) (#a9675b9)
  • Adjust to MessageBus config with single broker host info (#407) (#cd249ec)

Build 👷

[v2.3.0] - 2022-11-09

Features ✨

Bug Fixes 🐛

  • Add capability to override config provider settings with "none" (#381) (#3493ca4)
  • Run WatchForChange in a new thread (#362) (#9c98e1c)
  • Ensure exit with non-zero code when error occurs (#358) (#816d4c9)

Build 👷

[v2.2.0] - 2022-05-11

Features ✨

  • Add RequestLimitMiddleware for Service.MaxRequestSize config (#321) (#42b690d)
  • Implement service metrics bootstrap and common capability (#313) (#8132711)
  • Location of client service obtained from the registry (#305) (#78c5fc9)
  • security: Use go-mod-secrets version that includes the capability of using non_delayedstart go build tags (#317) (#2a6ac6a)
  • security: Integrate runtime spiffe token provider client from go-mod-secrets (#4bf6376)

Bug Fixes 🐛

  • Generate proper Consul basepath on Windows (#0cfe34c)
  • config: ignore first change notification in ListenForCustomConfigChanges (#315) (#6332299)

Build 👷

  • Added "make lint" target and added to "make test" target (#302) (#d813076)

[v2.1.0] - 2021-11-17

Features ✨

  • Use Http Request timeout handler (#267) (#4da2238)
  • security: Add Access Token callback Vault token reload (#285) (#64217dd)
  • security: Add optional capability to seed service secrets (#276) (#a4676a4)
  • security: Add func to process CORS (#288) (#c292656)
  • security: Create CORS related config struct (#286) (#4ec4738)

Bug Fixes 🐛

  • Use correct name when logging EDGEX_CONF_DIR override (#266) (#2a375e7)

[v2.0.0] - 2021-06-30

Features ✨

  • v2: Add Subscribe config to MessageQueue config (#240) (#ac14ba0)
  • v2: Add bootstrap handler to create Messaging Client with secure options (#225) (#ae196fc)
  • v2: Use SecretProvider to get Config/Registry access tokens (#202) (#5d19aa5)
  • v2: Enable use of Registry & Config client access token (#195) (#f9d06ec)
  • v2: Add overwrite capability for custom configuration (#185) (#90b8a51)
  • v2: Add support for load/listen custom configuration (#180) (#f277873)
  • v2: Add config client in DIC (#178) (#ecde49d)
  • v2: Add helper to query DIC and returns the DeviceServiceCommandClient instance (#162) (#c087e44)
  • v2: Create Helper functions to retrieve client library instances through DIC (#158) (#3d89601)

Bug Fixes 🐛

  • Use /api/v2/ping for Registry healthchecks (#196) (#7d55b1a)
  • Add conditional for error message and return false on error (#f4390fe)
  • Replace hyphen with underscore in override names (#216) (#9f3edfd)
    BREAKING CHANGE:
    Overrides that have hyphens will not longer work and must be updated replace hyphens with underscores.
    
  • Remove messaging handler to avoid implicit ZMQ dependency (#235) (#9df977d)
  • Fix Secure MessageBus Secret validation for non-secure mode (#233) (#f6c98ef)
  • Generate mock for latest SecretProvider interface (#206) (#359809f)
  • Use V2 Ping for health check (#5bb40c1)
  • secuirty: remove retry config items from SecretStore config (#248) (#6002097)

Code Refactoring ♻

  • Update ServiceInfo struct to be used by all services and add MaxRequestSize (#9e3af34)
    BREAKING CHANGE:
    Service configuration has changed for all services
    
  • Update calling GenerateConsulToken (#212) (#e295a6e)
  • Replace use of BurntSushi/toml with pelletier/go-toml (#6c8f2b4)
  • Expose ConfigVersion so services can use if needed (#204) (#e966ad5)
  • Set the Config Version when creating Config Client (#201) (#615e600)
    BREAKING CHANGE:
    Configuration in Consul now under the `/2.0/` path
    
  • Refactor ListenForCustomConfigChanges to avoid use of channel (#187) (#cffb2fe)
  • Updated go.mod for tagged go-mod-secrets and fixed unittest (#05db8a1)
  • Add comment for new Type setting. (#d2e6caa)

[v0.0.68] - 2021-01-04

Features ✨

  • Enhance Timer to be used for timed loops beyond bootstrapping (#141) (#ff8e38c)

[v0.0.67] - 2021-01-04

Bug Fixes 🐛

[v0.0.66] - 2020-12-30

Code Refactoring ♻

[v0.0.65] - 2020-12-29

Code Refactoring ♻

  • Refactor to remove remote and file logging (#138) (#d92118e)

[v0.0.62] - 2020-12-20

Code Refactoring ♻

[v0.0.59] - 2020-11-25

Bug Fixes 🐛

  • LoggingClientFrom handle nil case properly (#c95d24f)

[v0.0.58] - 2020-11-19

Features ✨

  • Allow service to pass in initial logging client (#3651de7)

[v0.0.57] - 2020-10-28

Bug Fixes 🐛

  • Accept argument lists with a -r substring (#dc0e6ea)

[v0.0.50] - 2020-10-14

Bug Fixes 🐛

  • Handle env override values which have the '=' character (#4846fb7)

[v0.0.41] - 2020-09-29

Bug Fixes 🐛

  • Increase default startup duration to 60 seconds (#0761e33)

[v0.0.37] - 2020-07-30

Bug Fixes 🐛

  • Startup Duration and Interval never updated from default values (#c35f13c)

[v0.0.36] - 2020-07-13

Bug Fixes 🐛

  • Configurable ip address for ListenAndServe, fixes #83 (#ec63238)

[v0.0.35] - 2020-07-07

Code Refactoring ♻

  • config: Remove ClientMonitor from the ServiceInfo struct (#efe9cb9)

[v0.0.33] - 2020-06-01

Bug Fixes 🐛

  • Changed from using blank hostname to 0.0.0.0 (#38f87ec)
  • Don't use hostname for webserver ListenAndServe (#6dbe24f)

[v0.0.32] - 2020-05-29

Bug Fixes 🐛

  • Allow overrides that have empty/blank value (#5497010)

[v0.0.31] - 2020-04-29

Bug Fixes 🐛

  • config: Ignore first config changes notification on start-up (#2834834)

[v0.0.30] - 2020-04-21

Features ✨

  • environment: Perform case insensitive comparision for override names (#3d7becb)

[v0.0.28] - 2020-04-14

Bug Fixes 🐛

  • config: Change UpdatedStream to be defined as chan struct{} (#6d2e43b)

[v0.0.26] - 2020-03-31

Bug Fixes 🐛

  • logging: Logger not configured properly (#017c944)

[v0.0.25] - 2020-03-30

Features ✨

  • Add Self seeding, env var overrides, cmd-line options per ADR 0005-Service-Self-Config.md (#59) (#e56334c)

[v0.0.24] - 2020-03-26

Bug Fixes 🐛

  • Add retry loop for secret client if initial token is invalid (#60) (#ecac4d1)

[v0.0.13] - 2020-02-04

Bug

  • config: Embedded types do not work with package we use to pull from Consul (#38) (#2d9fcd4)

[v0.0.12] - 2020-01-31

Code Refactoring ♻

  • registry: Integrate new Configuration & Registry clients (#915c058)