-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Autopilot feature from Consul #3670
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
448e328
vendor: add autopilot and flags packages from consul
kyhavlov 54e6b7f
Add autopilot docs
kyhavlov c2d0c11
Add autopilot functionality based on Consul's autopilot
kyhavlov 2544587
Add raft remove by id endpoint/command
kyhavlov 46254e1
Fix comments/text referring to consul
kyhavlov 4e9735d
Merge branch 'master' into autopilot
kyhavlov 4962c8b
Formatting/test adjustments
kyhavlov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,232 @@ | ||
package api | ||
|
||
import ( | ||
"bytes" | ||
"fmt" | ||
"io" | ||
"strconv" | ||
"strings" | ||
"time" | ||
) | ||
|
||
// AutopilotConfiguration is used for querying/setting the Autopilot configuration. | ||
// Autopilot helps manage operator tasks related to Nomad servers like removing | ||
// failed servers from the Raft quorum. | ||
type AutopilotConfiguration struct { | ||
// CleanupDeadServers controls whether to remove dead servers from the Raft | ||
// peer list when a new server joins | ||
CleanupDeadServers bool | ||
|
||
// LastContactThreshold is the limit on the amount of time a server can go | ||
// without leader contact before being considered unhealthy. | ||
LastContactThreshold *ReadableDuration | ||
|
||
// MaxTrailingLogs is the amount of entries in the Raft Log that a server can | ||
// be behind before being considered unhealthy. | ||
MaxTrailingLogs uint64 | ||
|
||
// ServerStabilizationTime is the minimum amount of time a server must be | ||
// in a stable, healthy state before it can be added to the cluster. Only | ||
// applicable with Raft protocol version 3 or higher. | ||
ServerStabilizationTime *ReadableDuration | ||
|
||
// (Enterprise-only) RedundancyZoneTag is the node tag to use for separating | ||
// servers into zones for redundancy. If left blank, this feature will be disabled. | ||
RedundancyZoneTag string | ||
|
||
// (Enterprise-only) DisableUpgradeMigration will disable Autopilot's upgrade migration | ||
// strategy of waiting until enough newer-versioned servers have been added to the | ||
// cluster before promoting them to voters. | ||
DisableUpgradeMigration bool | ||
|
||
// (Enterprise-only) UpgradeVersionTag is the node tag to use for version info when | ||
// performing upgrade migrations. If left blank, the Nomad version will be used. | ||
UpgradeVersionTag string | ||
|
||
// CreateIndex holds the index corresponding the creation of this configuration. | ||
// This is a read-only field. | ||
CreateIndex uint64 | ||
|
||
// ModifyIndex will be set to the index of the last update when retrieving the | ||
// Autopilot configuration. Resubmitting a configuration with | ||
// AutopilotCASConfiguration will perform a check-and-set operation which ensures | ||
// there hasn't been a subsequent update since the configuration was retrieved. | ||
ModifyIndex uint64 | ||
} | ||
|
||
// ServerHealth is the health (from the leader's point of view) of a server. | ||
type ServerHealth struct { | ||
// ID is the raft ID of the server. | ||
ID string | ||
|
||
// Name is the node name of the server. | ||
Name string | ||
|
||
// Address is the address of the server. | ||
Address string | ||
|
||
// The status of the SerfHealth check for the server. | ||
SerfStatus string | ||
|
||
// Version is the Nomad version of the server. | ||
Version string | ||
|
||
// Leader is whether this server is currently the leader. | ||
Leader bool | ||
|
||
// LastContact is the time since this node's last contact with the leader. | ||
LastContact *ReadableDuration | ||
|
||
// LastTerm is the highest leader term this server has a record of in its Raft log. | ||
LastTerm uint64 | ||
|
||
// LastIndex is the last log index this server has a record of in its Raft log. | ||
LastIndex uint64 | ||
|
||
// Healthy is whether or not the server is healthy according to the current | ||
// Autopilot config. | ||
Healthy bool | ||
|
||
// Voter is whether this is a voting server. | ||
Voter bool | ||
|
||
// StableSince is the last time this server's Healthy value changed. | ||
StableSince time.Time | ||
} | ||
|
||
// OperatorHealthReply is a representation of the overall health of the cluster | ||
type OperatorHealthReply struct { | ||
// Healthy is true if all the servers in the cluster are healthy. | ||
Healthy bool | ||
|
||
// FailureTolerance is the number of healthy servers that could be lost without | ||
// an outage occurring. | ||
FailureTolerance int | ||
|
||
// Servers holds the health of each server. | ||
Servers []ServerHealth | ||
} | ||
|
||
// ReadableDuration is a duration type that is serialized to JSON in human readable format. | ||
type ReadableDuration time.Duration | ||
|
||
func NewReadableDuration(dur time.Duration) *ReadableDuration { | ||
d := ReadableDuration(dur) | ||
return &d | ||
} | ||
|
||
func (d *ReadableDuration) String() string { | ||
return d.Duration().String() | ||
} | ||
|
||
func (d *ReadableDuration) Duration() time.Duration { | ||
if d == nil { | ||
return time.Duration(0) | ||
} | ||
return time.Duration(*d) | ||
} | ||
|
||
func (d *ReadableDuration) MarshalJSON() ([]byte, error) { | ||
return []byte(fmt.Sprintf(`"%s"`, d.Duration().String())), nil | ||
} | ||
|
||
func (d *ReadableDuration) UnmarshalJSON(raw []byte) error { | ||
if d == nil { | ||
return fmt.Errorf("cannot unmarshal to nil pointer") | ||
} | ||
|
||
str := string(raw) | ||
if len(str) < 2 || str[0] != '"' || str[len(str)-1] != '"' { | ||
return fmt.Errorf("must be enclosed with quotes: %s", str) | ||
} | ||
dur, err := time.ParseDuration(str[1 : len(str)-1]) | ||
if err != nil { | ||
return err | ||
} | ||
*d = ReadableDuration(dur) | ||
return nil | ||
} | ||
|
||
// AutopilotGetConfiguration is used to query the current Autopilot configuration. | ||
func (op *Operator) AutopilotGetConfiguration(q *QueryOptions) (*AutopilotConfiguration, error) { | ||
r, err := op.c.newRequest("GET", "/v1/operator/autopilot/configuration") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 152-166 can be replaced by:
All of the APIs should use this format. There is a query as well as write helper for PUTs |
||
if err != nil { | ||
return nil, err | ||
} | ||
r.setQueryOptions(q) | ||
_, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
defer resp.Body.Close() | ||
|
||
var out AutopilotConfiguration | ||
if err := decodeBody(resp, &out); err != nil { | ||
return nil, err | ||
} | ||
|
||
return &out, nil | ||
} | ||
|
||
// AutopilotSetConfiguration is used to set the current Autopilot configuration. | ||
func (op *Operator) AutopilotSetConfiguration(conf *AutopilotConfiguration, q *WriteOptions) error { | ||
r, err := op.c.newRequest("PUT", "/v1/operator/autopilot/configuration") | ||
if err != nil { | ||
return err | ||
} | ||
r.setWriteOptions(q) | ||
r.obj = conf | ||
_, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return err | ||
} | ||
resp.Body.Close() | ||
return nil | ||
} | ||
|
||
// AutopilotCASConfiguration is used to perform a Check-And-Set update on the | ||
// Autopilot configuration. The ModifyIndex value will be respected. Returns | ||
// true on success or false on failures. | ||
func (op *Operator) AutopilotCASConfiguration(conf *AutopilotConfiguration, q *WriteOptions) (bool, error) { | ||
r, err := op.c.newRequest("PUT", "/v1/operator/autopilot/configuration") | ||
if err != nil { | ||
return false, err | ||
} | ||
r.setWriteOptions(q) | ||
r.params.Set("cas", strconv.FormatUint(conf.ModifyIndex, 10)) | ||
r.obj = conf | ||
_, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return false, err | ||
} | ||
defer resp.Body.Close() | ||
|
||
var buf bytes.Buffer | ||
if _, err := io.Copy(&buf, resp.Body); err != nil { | ||
return false, fmt.Errorf("Failed to read response: %v", err) | ||
} | ||
res := strings.Contains(buf.String(), "true") | ||
|
||
return res, nil | ||
} | ||
|
||
// AutopilotServerHealth is used to query Autopilot's top-level view of the health | ||
// of each Nomad server. | ||
func (op *Operator) AutopilotServerHealth(q *QueryOptions) (*OperatorHealthReply, error) { | ||
r, err := op.c.newRequest("GET", "/v1/operator/autopilot/health") | ||
if err != nil { | ||
return nil, err | ||
} | ||
r.setQueryOptions(q) | ||
_, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
defer resp.Body.Close() | ||
|
||
var out OperatorHealthReply | ||
if err := decodeBody(resp, &out); err != nil { | ||
return nil, err | ||
} | ||
return &out, nil | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
package api | ||
|
||
import ( | ||
"testing" | ||
|
||
"fmt" | ||
|
||
"github.com/hashicorp/consul/testutil/retry" | ||
"github.com/hashicorp/nomad/testutil" | ||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestAPI_OperatorAutopilotGetSetConfiguration(t *testing.T) { | ||
t.Parallel() | ||
assert := assert.New(t) | ||
c, s := makeClient(t, nil, nil) | ||
defer s.Stop() | ||
|
||
operator := c.Operator() | ||
config, err := operator.AutopilotGetConfiguration(nil) | ||
assert.Nil(err) | ||
assert.True(config.CleanupDeadServers) | ||
|
||
// Change a config setting | ||
newConf := &AutopilotConfiguration{CleanupDeadServers: false} | ||
err = operator.AutopilotSetConfiguration(newConf, nil) | ||
assert.Nil(err) | ||
|
||
config, err = operator.AutopilotGetConfiguration(nil) | ||
assert.Nil(err) | ||
assert.False(config.CleanupDeadServers) | ||
} | ||
|
||
func TestAPI_OperatorAutopilotCASConfiguration(t *testing.T) { | ||
t.Parallel() | ||
assert := assert.New(t) | ||
c, s := makeClient(t, nil, nil) | ||
defer s.Stop() | ||
|
||
operator := c.Operator() | ||
config, err := operator.AutopilotGetConfiguration(nil) | ||
assert.Nil(err) | ||
assert.True(config.CleanupDeadServers) | ||
|
||
// Pass an invalid ModifyIndex | ||
{ | ||
newConf := &AutopilotConfiguration{ | ||
CleanupDeadServers: false, | ||
ModifyIndex: config.ModifyIndex - 1, | ||
} | ||
resp, err := operator.AutopilotCASConfiguration(newConf, nil) | ||
assert.Nil(err) | ||
assert.False(resp) | ||
} | ||
|
||
// Pass a valid ModifyIndex | ||
{ | ||
newConf := &AutopilotConfiguration{ | ||
CleanupDeadServers: false, | ||
ModifyIndex: config.ModifyIndex, | ||
} | ||
resp, err := operator.AutopilotCASConfiguration(newConf, nil) | ||
assert.Nil(err) | ||
assert.True(resp) | ||
} | ||
} | ||
|
||
func TestAPI_OperatorAutopilotServerHealth(t *testing.T) { | ||
t.Parallel() | ||
c, s := makeClient(t, nil, func(c *testutil.TestServerConfig) { | ||
c.AdvertiseAddrs.RPC = "127.0.0.1" | ||
c.Server.RaftProtocol = 3 | ||
}) | ||
defer s.Stop() | ||
|
||
operator := c.Operator() | ||
retry.Run(t, func(r *retry.R) { | ||
out, err := operator.AutopilotServerHealth(nil) | ||
if err != nil { | ||
r.Fatalf("err: %v", err) | ||
} | ||
|
||
if len(out.Servers) != 1 || | ||
!out.Servers[0].Healthy || | ||
out.Servers[0].Name != fmt.Sprintf("%s.global", s.Config.NodeName) { | ||
r.Fatalf("bad: %v", out) | ||
} | ||
}) | ||
} |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should also return the query meta result:
(*AutopilotConfiguration, *QueryMeta, error)
and in the cases of writes,WriteMeta