-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Adds support for WAN soft fail and join flooding. #2801
Changes from 23 commits
376fdde
78b62ca
472f1bd
fe2bd89
dc1572d
1091c73
a8ee32c
1bdd0f3
b969d92
7c27ca1
7525836
fcbb615
f1acda4
5626d35
7360e0b
b58faff
d556d14
7a451f7
79e192f
f7c5541
3a0739c
90174d3
5dd6058
e91377f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
// The /v1/operator/area endpoints are available only in Consul Enterprise and | ||
// interact with its network area subsystem. Network areas are used to link | ||
// together Consul servers in different Consul datacenters. With network areas, | ||
// Consul datacenters can be linked together in ways other than a fully-connected | ||
// mesh, as is required for Consul's WAN. | ||
package api | ||
|
||
import ( | ||
"net" | ||
"time" | ||
) | ||
|
||
// Area defines a network area. | ||
type Area struct { | ||
// ID is this identifier for an area (a UUID). This must be left empty | ||
// when creating a new area. | ||
ID string | ||
|
||
// PeeerDatacenter is the peer Consul datacenter that will make up the | ||
// other side of this network area. Network areas always involve a pair | ||
// of datacenters: the datacenter where the area was created, and the | ||
// peer datacenter. This is required | ||
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. Missing a period here |
||
PeerDatacenter string | ||
|
||
// RetryJoin specifies the address of Consul servers to join to, such as | ||
// an IPs or hostnames with an optional port number. This is optional. | ||
RetryJoin []string | ||
} | ||
|
||
// AreaJoinResponse is returned when a join occurs and gives the result for each | ||
// address. | ||
type AreaJoinResponse struct { | ||
// The address that was joined. | ||
Address string | ||
|
||
// Whether or not the join was a success. | ||
Joined bool | ||
|
||
// If we couldn't join, this is the message with information. | ||
What string | ||
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. Could this just be called 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. Yeah that's probably better - that was a C++ carryover. |
||
} | ||
|
||
// SerfMember is a generic structure for reporting information about members in | ||
// a Serf cluster. This is only used by the area endpoints right now, but this | ||
// could be expanded to other endpoints in the future. | ||
type SerfMember struct { | ||
// ID is the node identifier (a UUID). | ||
ID string | ||
|
||
// Name is the node name. | ||
Name string | ||
|
||
// Addr has the IP address. | ||
Addr net.IP | ||
|
||
// Port is the RPC port. | ||
Port uint16 | ||
|
||
// Datacenter is the DC name. | ||
Datacenter string | ||
|
||
// Role is "client", "server", or "unknown". | ||
Role string | ||
|
||
// Build has the version of the Consul agent. | ||
Build string | ||
|
||
// Protocol is the protocol of the Consul agent. | ||
Protocol int | ||
|
||
// Status is the Serf health status "none", "alive", "leaving", "left", | ||
// or "failed". | ||
Status string | ||
|
||
// RTT is the estimated round trip time from the server handling the | ||
// request to the this member. This will be negative if no RTT estimate | ||
// is available. | ||
RTT time.Duration | ||
} | ||
|
||
// AreaCreate will create a new network area. The ID in the given structure must | ||
// be empty and a generated ID will be returned on success. | ||
func (op *Operator) AreaCreate(area *Area, q *WriteOptions) (string, *WriteMeta, error) { | ||
r := op.c.newRequest("POST", "/v1/operator/area") | ||
r.setWriteOptions(q) | ||
r.obj = area | ||
rtt, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return "", nil, err | ||
} | ||
defer resp.Body.Close() | ||
|
||
wm := &WriteMeta{} | ||
wm.RequestTime = rtt | ||
|
||
var out struct{ ID string } | ||
if err := decodeBody(resp, &out); err != nil { | ||
return "", nil, err | ||
} | ||
return out.ID, wm, nil | ||
} | ||
|
||
// AreaList returns all the available network areas. | ||
func (op *Operator) AreaList(q *QueryOptions) ([]*Area, *QueryMeta, error) { | ||
var out []*Area | ||
qm, err := op.c.query("/v1/operator/area", &out, q) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
return out, qm, nil | ||
} | ||
|
||
// AreaDelete deletes the given network area. | ||
func (op *Operator) AreaDelete(areaID string, q *WriteOptions) (*WriteMeta, error) { | ||
r := op.c.newRequest("DELETE", "/v1/operator/area/"+areaID) | ||
r.setWriteOptions(q) | ||
rtt, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
defer resp.Body.Close() | ||
|
||
wm := &WriteMeta{} | ||
wm.RequestTime = rtt | ||
return wm, nil | ||
} | ||
|
||
// AreaJoin attempts to join the given set of join addresses to the given | ||
// network area. See the Area structure for details about join addresses. | ||
func (op *Operator) AreaJoin(areaID string, addresses []string, q *WriteOptions) ([]*AreaJoinResponse, *WriteMeta, error) { | ||
r := op.c.newRequest("PUT", "/v1/operator/area/"+areaID+"/join") | ||
r.setWriteOptions(q) | ||
r.obj = addresses | ||
rtt, resp, err := requireOK(op.c.doRequest(r)) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
defer resp.Body.Close() | ||
|
||
wm := &WriteMeta{} | ||
wm.RequestTime = rtt | ||
|
||
var out []*AreaJoinResponse | ||
if err := decodeBody(resp, &out); err != nil { | ||
return nil, nil, err | ||
} | ||
return out, wm, nil | ||
} | ||
|
||
// AreaMembers lists the Serf information about the members in the given area. | ||
func (op *Operator) AreaMembers(areaID string, q *QueryOptions) ([]*SerfMember, *QueryMeta, error) { | ||
var out []*SerfMember | ||
qm, err := op.c.query("/v1/operator/area/"+areaID+"/members", &out, q) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
return out, qm, nil | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,7 @@ type Server struct { | |
ID string | ||
Datacenter string | ||
Port int | ||
WanJoinPort int | ||
Bootstrap bool | ||
Expect int | ||
Version int | ||
|
@@ -80,16 +81,28 @@ func IsConsulServer(m serf.Member) (bool, *Server) { | |
return false, nil | ||
} | ||
|
||
wan_join_port := 0 | ||
wan_join_port_str, ok := m.Tags["wan_join_port"] | ||
if ok { | ||
wan_join_port, err = strconv.Atoi(wan_join_port_str) | ||
if err != nil { | ||
return false, nil | ||
} | ||
} | ||
|
||
vsn_str := m.Tags["vsn"] | ||
vsn, err := strconv.Atoi(vsn_str) | ||
if err != nil { | ||
return false, nil | ||
} | ||
|
||
raft_vsn_str := m.Tags["raft_vsn"] | ||
raft_vsn, err := strconv.Atoi(raft_vsn_str) | ||
if err != nil { | ||
return false, nil | ||
raft_vsn := 0 | ||
raft_vsn_str, ok := m.Tags["raft_vsn"] | ||
if ok { | ||
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. Good catch with this, I wouldn't have realized to do this until testing alongside an older consul binary |
||
raft_vsn, err = strconv.Atoi(raft_vsn_str) | ||
if err != nil { | ||
return false, nil | ||
} | ||
} | ||
|
||
addr := &net.TCPAddr{IP: m.Addr, Port: port} | ||
|
@@ -99,6 +112,7 @@ func IsConsulServer(m serf.Member) (bool, *Server) { | |
ID: m.Tags["id"], | ||
Datacenter: datacenter, | ||
Port: port, | ||
WanJoinPort: wan_join_port, | ||
Bootstrap: bootstrap, | ||
Expect: expect, | ||
Addr: addr, | ||
|
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.
typo, should be
PeerDatacenter