Add consul version compatibility check on startup #62
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lornasong
approved these changes
May 18, 2020
| // to retry the request. | ||
| return fmt.Errorf("unable to check version compatibility with Consul agent: %s", err) | ||
| } | ||
| agentVersionRaw, ok := agentInfo["Config"]["Version"] |
There was a problem hiding this comment.
cool - didn't know you could check a map within a map in one call!
There was a problem hiding this comment.
I honestly always have to sanity check this in https://play.golang.com/ 😂
| if err != nil { | ||
| if strings.Contains(err.Error(), "429") { | ||
| // 429 is a warning that something is unhealthy. This may occur when ESM | ||
| // races with Consul servers first starting up, so this is safe to retry. |
|
|
||
| func TestAgent_VerifyConsulCompatibility(t *testing.T) { | ||
| // Smoke test to test the compatibility with the current Consul version | ||
| // pinned in go dependency. |
The ESM Consul client uses endpoints that are not supported in Consul prior to 1.4.1. This checks for compatibility with all running Consul servers at startup and exits with an informative error rather than silently failing on updating health checks for external services.
Compatibility with agent is necessary because the ESM client makes health check update using txn request to the local agent first, which then is forwarded to the servers.
lornasong
added a commit
that referenced
this pull request
Aug 6, 2020
ACL for operator:read is necessary for Consul-ESM v0.4.0 due to a new feature that check’s ESM and Consul’s version compatibility on start up: #62. This feature makes a request to /operator/autopilot, which needs to be added to the list of necessary ACLs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recent versions of the ESM Consul client uses endpoints that are not supported in Consul
prior to 1.4.1. This checks for compatibility with all running Consul servers at startup and exits
with an informative error rather than silently failing on updating health checks for external
services.
This a follow-up PR to enforce the version constraint in the documentation
https://github.com/hashicorp/consul-esm#prerequisites
Example error message
New CLI version output
Resolves #33