1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
|
package cluster
import (
"bufio"
"context"
"crypto/tls"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/url"
"os"
"path/filepath"
"strconv"
"sync"
"time"
dqlite "github.com/cowsql/go-cowsql"
client "github.com/cowsql/go-cowsql/client"
"github.com/lxc/incus/v6/internal/server/certificate"
"github.com/lxc/incus/v6/internal/server/db"
"github.com/lxc/incus/v6/internal/server/response"
"github.com/lxc/incus/v6/internal/server/state"
localUtil "github.com/lxc/incus/v6/internal/server/util"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/revert"
"github.com/lxc/incus/v6/shared/tcp"
localtls "github.com/lxc/incus/v6/shared/tls"
"github.com/lxc/incus/v6/shared/util"
)
// NewGateway creates a new Gateway for managing access to the dqlite cluster.
//
// When a new gateway is created, the node-level database is queried to check
// what kind of role this node plays and if it's exposed over the network. It
// will initialize internal data structures accordingly, for example starting a
// local dqlite server if this node is a database node.
//
// After creation, the Daemon is expected to expose whatever http handlers the
// HandlerFuncs method returns and to access the dqlite cluster using the
// dialer returned by the DialFunc method.
func NewGateway(shutdownCtx context.Context, db *db.Node, networkCert *localtls.CertInfo, stateFunc func() *state.State, options ...Option) (*Gateway, error) {
ctx, cancel := context.WithCancel(context.Background())
o := newOptions()
for _, option := range options {
option(o)
}
gateway := &Gateway{
shutdownCtx: shutdownCtx,
db: db,
networkCert: networkCert,
options: o,
ctx: ctx,
cancel: cancel,
upgradeCh: make(chan struct{}),
acceptCh: make(chan net.Conn),
store: &dqliteNodeStore{},
state: stateFunc,
}
err := gateway.init(false)
if err != nil {
return nil, err
}
return gateway, nil
}
// HeartbeatHook represents a function that can be called as the heartbeat hook.
type HeartbeatHook func(heartbeatData *APIHeartbeat, isLeader bool, unavailableMembers []string)
// HeartbeatHandler represents a function that can be called when a heartbeat request arrives.
type HeartbeatHandler func(w http.ResponseWriter, r *http.Request, isLeader bool, hbData *APIHeartbeat)
// Gateway mediates access to the dqlite cluster using a gRPC SQL client, and
// possibly runs a dqlite replica on this member (if we're configured to do so).
type Gateway struct {
db *db.Node
networkCert *localtls.CertInfo
options *options
// The raft instance to use for creating the dqlite driver. It's nil if
// this member is not supposed to be part of the raft cluster.
info *db.RaftNode
// The gRPC server exposing the dqlite driver created by this
// gateway. It's nil if this member is not supposed to be part of the
// raft cluster.
server *dqlite.Node
acceptCh chan net.Conn
stopCh chan struct{}
// A dialer that will connect to the dqlite server using a loopback
// net.Conn. It's non-nil when clustering is not enabled on this member
// and so we don't expose any dqlite or raft network endpoint,
// but still we want to use dqlite as backend for the "cluster"
// database, to minimize the difference between code paths in
// clustering and non-clustering modes.
memoryDial client.DialFunc
// Used when shutting down the daemon to cancel any ongoing gRPC
// dialing attempt.
shutdownCtx context.Context
ctx context.Context
cancel context.CancelFunc
// Used to unblock nodes that are waiting for other nodes to upgrade
// their version.
upgradeCh chan struct{}
// Used to track whether we already triggered an upgrade because we
// detected a peer with an higher version.
upgradeTriggered bool
// Used for the heartbeat handler
Cluster *db.Cluster
HeartbeatNodeHook HeartbeatHook
HeartbeatOfflineThreshold time.Duration
heartbeatCancel context.CancelFunc
heartbeatCancelLock sync.Mutex
HeartbeatLock sync.Mutex
// NodeStore wrapper.
store *dqliteNodeStore
lock sync.RWMutex
// Abstract unix socket that the local dqlite task is listening to.
bindAddress string
// State function.
state func() *state.State
}
// Current dqlite protocol version.
const dqliteVersion = 1
// Set the dqlite version header.
func setDqliteVersionHeader(request *http.Request) {
request.Header.Set("X-Dqlite-Version", fmt.Sprintf("%d", dqliteVersion))
}
// HandlerFuncs returns the HTTP handlers that should be added to the REST API
// endpoint in order to handle database-related requests.
//
// There are two handlers, one for the /internal/raft endpoint and the other
// for /internal/db, which handle respectively raft and gRPC-SQL requests.
//
// These handlers might return 404, either because this server is a
// non-clustered member not available over the network or because it is not a
// database node part of the dqlite cluster.
func (g *Gateway) HandlerFuncs(heartbeatHandler HeartbeatHandler, trustedCerts func() (map[certificate.Type]map[string]x509.Certificate, error)) map[string]http.HandlerFunc {
database := func(w http.ResponseWriter, r *http.Request) {
g.lock.RLock()
certs, err := trustedCerts()
if err != nil {
g.lock.RUnlock()
http.Error(w, "403 invalid client certificate", http.StatusForbidden)
return
}
if !tlsCheckCert(r, g.networkCert, g.state().ServerCert(), certs) {
g.lock.RUnlock()
http.Error(w, "403 invalid client certificate", http.StatusForbidden)
return
}
g.lock.RUnlock()
// Compare the dqlite version of the connecting client
// with our own one.
versionHeader := r.Header.Get("X-Dqlite-Version")
if versionHeader == "" {
// No version header means an old pre dqlite 1.0 client.
versionHeader = "0"
}
version, err := strconv.Atoi(versionHeader)
if err != nil {
http.Error(w, "400 invalid dqlite version", http.StatusBadRequest)
return
}
if version != dqliteVersion {
if version > dqliteVersion {
g.lock.Lock()
if !g.upgradeTriggered {
err = triggerUpdate()
if err == nil {
g.upgradeTriggered = true
}
}
g.lock.Unlock()
http.Error(w, "503 unsupported dqlite version", http.StatusServiceUnavailable)
} else {
http.Error(w, "426 dqlite version too old ", http.StatusUpgradeRequired)
}
return
}
// Handle heartbeats (these normally come from leader, but can come from joining nodes too).
if r.Method == "PUT" {
if g.shutdownCtx.Err() != nil {
logger.Warn("Rejecting heartbeat request as shutting down")
http.Error(w, "503 Shutting down", http.StatusServiceUnavailable)
return
}
var heartbeatData APIHeartbeat
err := json.NewDecoder(r.Body).Decode(&heartbeatData)
if err != nil {
logger.Error("Failed decoding heartbeat", logger.Ctx{"err": err})
http.Error(w, "400 Failed decoding heartbeat", http.StatusBadRequest)
return
}
g.lock.RLock()
isLeader, err := g.isLeader()
g.lock.RUnlock()
if err != nil {
logger.Error("Failed checking if leader", logger.Ctx{"err": err})
http.Error(w, "500 Failed checking if leader", http.StatusInternalServerError)
return
}
if heartbeatHandler == nil {
logger.Error("No heartbeat handler", logger.Ctx{"err": err})
return
}
heartbeatHandler(w, r, isLeader, &heartbeatData)
return
}
// Handle database upgrade notifications.
if r.Method == "PATCH" {
select {
case g.upgradeCh <- struct{}{}:
default:
}
return
}
// From here on we require that this node is part of the raft
// cluster.
g.lock.RLock()
if g.server == nil || g.memoryDial != nil {
g.lock.RUnlock()
http.NotFound(w, r)
return
}
g.lock.RUnlock()
// NOTE: this is kept for backward compatibility when upgrading
// a cluster with version <= 4.2.
//
// Once all nodes are on >= 4.3 this code is effectively
// unused.
if r.Method == "HEAD" {
g.lock.RLock()
defer g.lock.RUnlock()
// We can safely know about current leader only if we are a voter.
if g.info.Role != db.RaftVoter {
http.NotFound(w, r)
return
}
client, err := g.getClient()
if err != nil {
http.Error(w, "500 failed to get dqlite client", http.StatusInternalServerError)
return
}
defer func() { _ = client.Close() }()
ctx, cancel := context.WithTimeout(g.ctx, 3*time.Second)
defer cancel()
leader, err := client.Leader(ctx)
if err != nil {
http.Error(w, "500 failed to get leader address", http.StatusInternalServerError)
return
}
if leader == nil || leader.ID != g.info.ID {
http.Error(w, "503 not leader", http.StatusServiceUnavailable)
return
}
return
}
// Handle leader address requests.
if r.Method == "GET" {
leader, err := g.LeaderAddress()
if err != nil {
http.Error(w, "500 no elected leader", http.StatusInternalServerError)
return
}
_ = localUtil.WriteJSON(w, map[string]string{"leader": leader}, nil)
return
}
if r.Header.Get("Upgrade") != "dqlite" {
http.Error(w, "Missing or invalid upgrade header", http.StatusBadRequest)
return
}
hijacker, ok := w.(http.Hijacker)
if !ok {
http.Error(w, "Webserver doesn't support hijacking", http.StatusInternalServerError)
return
}
conn, _, err := hijacker.Hijack()
if err != nil {
http.Error(w, fmt.Errorf("Failed to hijack connection: %w", err).Error(), http.StatusInternalServerError)
return
}
err = response.Upgrade(conn, "dqlite")
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
_ = conn.Close()
return
}
g.acceptCh <- conn
}
return map[string]http.HandlerFunc{
databaseEndpoint: database,
}
}
// WaitUpgradeNotification waits for a notification from another node that all
// nodes in the cluster should now have been upgraded and have matching schema
// and API versions.
func (g *Gateway) WaitUpgradeNotification() {
select {
case <-g.upgradeCh:
case <-time.After(time.Minute):
}
}
// IsDqliteNode returns true if this gateway is running a dqlite node.
func (g *Gateway) IsDqliteNode() bool {
g.lock.RLock()
defer g.lock.RUnlock()
if g.info != nil {
if g.server == nil {
panic("gateway has node identity but no dqlite server")
}
return true
}
if g.server != nil {
panic("gateway dqlite server but no node identity")
}
return true
}
// DialFunc returns a dial function that can be used to connect to one of the
// dqlite nodes.
func (g *Gateway) DialFunc() client.DialFunc {
return func(ctx context.Context, address string) (net.Conn, error) {
g.lock.RLock()
defer g.lock.RUnlock()
// Memory connection.
if g.memoryDial != nil {
return g.memoryDial(ctx, address)
}
conn, err := dqliteNetworkDial(ctx, "dqlite", address, g)
if err != nil {
return nil, err
}
// We successfully established a connection with the leader. Maybe the
// leader is ourselves, and we were recently elected. In that case
// trigger a full heartbeat now: it will be a no-op if we aren't
// actually leaders.
go g.heartbeat(g.ctx, heartbeatInitial)
return conn, nil
}
}
// Dial function for establishing raft connections.
func (g *Gateway) raftDial() client.DialFunc {
return func(ctx context.Context, address string) (net.Conn, error) {
nodeAddress, err := g.nodeAddress(address)
if err != nil {
return nil, err
}
conn, err := dqliteNetworkDial(ctx, "raft", nodeAddress, g)
if err != nil {
return nil, err
}
listener, err := net.Listen("unix", "")
if err != nil {
return nil, fmt.Errorf("Failed to create unix listener: %w", err)
}
goUnix, err := net.Dial("unix", listener.Addr().String())
if err != nil {
return nil, fmt.Errorf("Failed to connect to unix listener: %w", err)
}
cUnix, err := listener.Accept()
if err != nil {
return nil, fmt.Errorf("Failed to connect to unix listener: %w", err)
}
_ = listener.Close()
go dqliteProxy("raft", g.stopCh, conn, goUnix)
return cUnix, nil
}
}
// Context returns a cancellation context to pass to dqlite.NewDriver as
// option.
//
// This context gets cancelled by Gateway.Kill() and at that point any
// connection failure won't be retried.
func (g *Gateway) Context() context.Context {
return g.ctx
}
// NodeStore returns a dqlite server store that can be used to lookup the
// addresses of known database nodes.
func (g *Gateway) NodeStore() client.NodeStore {
return g.store
}
// Kill is an API that the daemon calls before it actually shuts down and calls
// Shutdown(). It will abort any ongoing or new attempt to establish a SQL gRPC
// connection with the dialer (typically for running some pre-shutdown
// queries).
func (g *Gateway) Kill() {
logger.Debug("Cancel ongoing or future gRPC connection attempts")
g.cancel()
}
// TransferLeadership attempts to transfer leadership to another node.
func (g *Gateway) TransferLeadership() error {
client, err := g.getClient()
if err != nil {
return err
}
defer func() { _ = client.Close() }()
// Try to find a voter that is also online.
servers, err := client.Cluster(context.Background())
if err != nil {
return err
}
var id uint64
for _, server := range servers {
if server.ID == g.info.ID || server.Role != db.RaftVoter {
continue
}
address, err := g.nodeAddress(server.Address)
if err != nil {
return err
}
if !HasConnectivity(g.networkCert, g.state().ServerCert(), address, false) {
continue
}
id = server.ID
break
}
if id == 0 {
return errors.New("No online voter found")
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
return client.Transfer(ctx, id)
}
// DemoteOfflineNode force demoting an offline node.
func (g *Gateway) DemoteOfflineNode(raftID uint64) error {
cli, err := g.getClient()
if err != nil {
return fmt.Errorf("Connect to local dqlite node: %w", err)
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err = cli.Assign(ctx, raftID, db.RaftSpare)
if err != nil {
return err
}
return nil
}
// Shutdown this gateway, stopping the gRPC server and possibly the raft factory.
func (g *Gateway) Shutdown() error {
logger.Debugf("Stop database gateway")
var err error
if g.server != nil {
if g.info.Role == db.RaftVoter {
g.Sync()
}
err = g.server.Close()
close(g.stopCh)
// Unset the memory dial, since Shutdown() is also called for
// switching between in-memory and network mode.
g.lock.Lock()
g.memoryDial = nil
g.lock.Unlock()
}
return err
}
// Sync dumps the content of the database to disk. This is useful for
// inspection purposes, and it's also needed by the activateifneeded command so
// it can inspect the database in order to decide whether to activate the
// daemon or not.
func (g *Gateway) Sync() {
g.lock.RLock()
defer g.lock.RUnlock()
if g.server == nil || g.info.Role != db.RaftVoter {
return
}
client, err := g.getClient()
if err != nil {
logger.Warnf("Failed to get client: %v", err)
return
}
defer func() { _ = client.Close() }()
files, err := client.Dump(context.Background(), "db.bin")
if err != nil {
// Just log a warning, since this is not fatal.
logger.Warnf("Failed get database dump: %v", err)
return
}
dir := filepath.Join(g.db.Dir(), "global")
for _, file := range files {
path := filepath.Join(dir, file.Name)
err := os.WriteFile(path, file.Data, 0o600)
if err != nil {
logger.Warnf("Failed to dump database file %s: %v", file.Name, err)
}
}
}
func (g *Gateway) getClient() (*client.Client, error) {
return client.New(context.Background(), g.bindAddress)
}
// Reset the gateway, shutting it down.
//
// This is used when disabling clustering on a node.
func (g *Gateway) Reset(networkCert *localtls.CertInfo) error {
err := g.Shutdown()
if err != nil {
return err
}
err = os.RemoveAll(filepath.Join(g.db.Dir(), "global"))
if err != nil {
return err
}
err = g.db.Transaction(context.TODO(), func(ctx context.Context, tx *db.NodeTx) error {
return tx.ReplaceRaftNodes(nil)
})
if err != nil {
return err
}
g.networkCert = networkCert
return nil
}
// ErrNodeIsNotClustered indicates the node is not clustered.
var ErrNodeIsNotClustered error = errors.New("Server is not clustered")
// LeaderAddress returns the address of the current raft leader.
func (g *Gateway) LeaderAddress() (string, error) {
g.lock.RLock()
defer g.lock.RUnlock()
// If we aren't clustered, return an error.
if g.memoryDial != nil {
return "", ErrNodeIsNotClustered
}
// If this is a voter node, return the address of the current leader, or wait a bit until one is elected.
if g.server != nil && g.info.Role == db.RaftVoter {
ctx, cancel := context.WithTimeout(g.ctx, 5*time.Second)
defer cancel()
for {
client, err := g.getClient()
if err != nil {
return "", fmt.Errorf("Failed to get dqlite client: %w", err)
}
leader, err := client.Leader(ctx)
if err != nil {
_ = client.Close()
return "", fmt.Errorf("Failed to get leader address: %w", err)
}
if leader != nil && leader.Address != "" {
_ = client.Close()
return leader.Address, nil
}
_ = client.Close()
select {
case <-ctx.Done():
return "", ctx.Err()
case <-time.After(time.Second):
continue
}
}
}
// If this isn't a raft node, contact a raft node and ask for the
// address of the current leader.
config, err := tlsClientConfig(g.networkCert, g.state().ServerCert())
if err != nil {
return "", err
}
addresses := []string{}
err = g.db.Transaction(context.TODO(), func(ctx context.Context, tx *db.NodeTx) error {
nodes, err := tx.GetRaftNodes(ctx)
if err != nil {
return err
}
for _, node := range nodes {
if node.Role != db.RaftVoter {
continue
}
addresses = append(addresses, node.Address)
}
return nil
})
if err != nil {
return "", fmt.Errorf("Failed to fetch raft nodes addresses: %w", err)
}
if len(addresses) == 0 {
// This should never happen because the raft_nodes table should
// be never empty for a clustered node, but check it for good
// measure.
return "", errors.New("No raft node known")
}
transport, cleanup := tlsTransport(config)
defer cleanup()
for _, address := range addresses {
timeout := 2 * time.Second
client := &http.Client{
Transport: transport,
Timeout: timeout,
}
url := fmt.Sprintf("https://%s%s", address, databaseEndpoint)
request, err := http.NewRequest("GET", url, nil)
if err != nil {
return "", err
}
setDqliteVersionHeader(request)
// Use 1s later timeout to give HTTP client chance timeout with
// more useful info.
ctx, cancel := context.WithTimeout(g.ctx, timeout+time.Second)
defer cancel()
request = request.WithContext(ctx)
response, err := client.Do(request)
if err != nil {
logger.Debugf("Failed to fetch leader address from %s", address)
continue
}
if response.StatusCode != http.StatusOK {
logger.Debugf("Request for leader address from %s failed", address)
continue
}
info := map[string]string{}
err = json.NewDecoder(response.Body).Decode(&info)
if err != nil {
logger.Debugf("Failed to parse leader address from %s", address)
continue
}
leader := info["leader"]
if leader == "" {
logger.Debugf("Raft node %s returned no leader address", address)
continue
}
return leader, nil
}
return "", errors.New("RAFT cluster is unavailable")
}
// NetworkUpdateCert sets a new network certificate for the gateway
// Use with Endpoints.NetworkUpdateCert() to fully update the API endpoint.
func (g *Gateway) NetworkUpdateCert(cert *localtls.CertInfo) {
g.lock.Lock()
defer g.lock.Unlock()
g.networkCert = cert
}
// Initialize the gateway, creating a new raft factory and gRPC server (if this
// node is a database node), and a gRPC dialer.
// @bootstrap should only be true when turning a non-clustered server into
// the first (and leader) member of a new cluster.
func (g *Gateway) init(bootstrap bool) error {
logger.Debugf("Initializing database gateway")
g.stopCh = make(chan struct{})
info, err := loadInfo(g.db, g.networkCert)
if err != nil {
return fmt.Errorf("Failed to create raft factory: %w", err)
}
dir := filepath.Join(g.db.Dir(), "global")
if util.PathExists(filepath.Join(dir, "logs.db")) {
return errors.New("Unsupported upgrade path, please first upgrade to LXD 4.0")
}
// If the resulting raft instance is not nil, it means that this node
// should serve as database node, so create a dqlite driver possibly
// exposing it over the network.
if info != nil {
// Use the autobind feature of abstract unix sockets to get a
// random unused address.
listener, err := net.Listen("unix", "")
if err != nil {
return fmt.Errorf("Failed to autobind unix socket: %w", err)
}
g.bindAddress = listener.Addr().String()
_ = listener.Close()
options := []dqlite.Option{
dqlite.WithBindAddress(g.bindAddress),
}
if info.Address == "1" {
if info.ID != 1 {
panic("unexpected server ID")
}
g.memoryDial = dqliteMemoryDial(g.bindAddress)
g.store.inMemory = client.NewInmemNodeStore()
err = g.store.Set(context.Background(), []client.NodeInfo{info.NodeInfo})
if err != nil {
return fmt.Errorf("Failed setting node info in store: %w", err)
}
} else {
go runDqliteProxy(g.stopCh, g.bindAddress, g.acceptCh)
g.store.inMemory = nil
options = append(options, dqlite.WithDialFunc(g.raftDial()))
}
server, err := dqlite.New(
info.ID,
info.Address,
dir,
options...,
)
if err != nil {
return fmt.Errorf("Failed to create dqlite server: %w", err)
}
// Force the correct configuration into the bootstrap node, this is needed
// when the raft node already has log entries, in which case a regular
// bootstrap fails, resulting in the node containing outdated configuration.
if bootstrap {
logger.Debugf("Bootstrap database gateway ID:%v Address:%v",
info.ID, info.Address)
cluster := []dqlite.NodeInfo{
{ID: uint64(info.ID), Address: info.Address},
}
err = server.Recover(cluster)
if err != nil {
return fmt.Errorf("Failed to recover database state: %w", err)
}
}
err = server.Start()
if err != nil {
return fmt.Errorf("Failed to start dqlite server: %w", err)
}
g.lock.Lock()
g.server = server
g.info = info
g.lock.Unlock()
} else {
g.lock.Lock()
g.server = nil
g.info = nil
g.store.inMemory = nil
g.lock.Unlock()
}
g.lock.Lock()
g.store.onDisk = client.NewNodeStore(
g.db.DB(), "main", "raft_nodes", "address")
g.lock.Unlock()
return nil
}
// WaitLeadership waits for the raft node to become leader.
func (g *Gateway) WaitLeadership() error {
n := 80
sleep := 250 * time.Millisecond
for range n {
g.lock.RLock()
isLeader, err := g.isLeader()
if err != nil {
g.lock.RUnlock()
return err
}
if isLeader {
g.lock.RUnlock()
return nil
}
g.lock.RUnlock()
time.Sleep(sleep)
}
return fmt.Errorf("RAFT node did not self-elect within %s", time.Duration(n)*sleep)
}
func (g *Gateway) isLeader() (bool, error) {
if g.server == nil || g.info.Role != db.RaftVoter {
return false, nil
}
client, err := g.getClient()
if err != nil {
return false, fmt.Errorf("Failed to get dqlite client: %w", err)
}
defer func() { _ = client.Close() }()
ctx, cancel := context.WithTimeout(g.ctx, 3*time.Second)
defer cancel()
leader, err := client.Leader(ctx)
if err != nil {
return false, fmt.Errorf("Failed to get leader address: %w", err)
}
return leader != nil && leader.ID == g.info.ID, nil
}
// ErrNotLeader signals that a node not the leader.
var ErrNotLeader = errors.New("Not leader")
// Return information about the cluster members that a currently part of the raft
// cluster, as configured in the raft log. It returns an error if this node is
// not the leader.
func (g *Gateway) currentRaftNodes() ([]db.RaftNode, error) {
g.lock.RLock()
defer g.lock.RUnlock()
if g.info == nil || g.info.Role != db.RaftVoter {
return nil, ErrNotLeader
}
isLeader, err := g.isLeader()
if err != nil {
return nil, err
}
if !isLeader {
return nil, ErrNotLeader
}
client, err := g.getClient()
if err != nil {
return nil, err
}
defer func() { _ = client.Close() }()
servers, err := client.Cluster(context.Background())
if err != nil {
return nil, err
}
raftNodes := make([]db.RaftNode, 0, len(servers))
for i, server := range servers {
address, err := g.nodeAddress(server.Address)
if err != nil {
return nil, fmt.Errorf("Failed to fetch raft server address: %w", err)
}
servers[i].Address = address
raftNode := db.RaftNode{NodeInfo: servers[i]}
raftNodes = append(raftNodes, raftNode)
}
// Get the names of the raft nodes from the global database.
if g.Cluster != nil {
err = g.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
members, err := tx.GetNodes(ctx)
if err != nil {
return fmt.Errorf("Failed getting cluster members: %w", err)
}
membersByAddress := make(map[string]db.NodeInfo, len(members))
for _, member := range members {
membersByAddress[member.Address] = member
}
for i, server := range servers {
member, found := membersByAddress[server.Address]
if !found {
logger.Warn("Cluster member info not found", logger.Ctx{"address": server.Address})
}
raftNodes[i].Name = member.Name
}
return nil
})
if err != nil {
logger.Warn("Failed getting raft nodes", logger.Ctx{"err": err})
}
}
return raftNodes, nil
}
// Translate a raft address to a node address. They are always the same except
// for the bootstrap node, which has address "1".
func (g *Gateway) nodeAddress(raftAddress string) (string, error) {
if raftAddress != "1" && raftAddress != "0" {
return raftAddress, nil
}
var address string
err := g.db.Transaction(context.TODO(), func(ctx context.Context, tx *db.NodeTx) error {
var err error
address, err = tx.GetRaftNodeAddress(ctx, 1)
if err != nil {
if !response.IsNotFoundError(err) {
return fmt.Errorf("Failed to fetch raft server address: %w", err)
}
// Use the initial address as fallback. This is an edge
// case that happens when listing members on a
// non-clustered node.
address = raftAddress
}
return nil
})
if err != nil {
return "", err
}
return address, nil
}
func dqliteNetworkDial(ctx context.Context, name string, addr string, g *Gateway) (net.Conn, error) {
config, err := tlsClientConfig(g.networkCert, g.state().ServerCert())
if err != nil {
return nil, err
}
path := fmt.Sprintf("https://%s%s", addr, databaseEndpoint)
// Establish the connection
request := &http.Request{
Method: "POST",
Proto: "HTTP/1.1",
ProtoMajor: 1,
ProtoMinor: 1,
Header: make(http.Header),
Host: addr,
}
request.URL, err = url.Parse(path)
if err != nil {
return nil, err
}
request.Header.Set("Upgrade", "dqlite")
setDqliteVersionHeader(request)
request = request.WithContext(ctx)
deadline, _ := ctx.Deadline()
dialer := &net.Dialer{Timeout: time.Until(deadline)}
reverter := revert.New()
defer reverter.Fail()
conn, err := tls.DialWithDialer(dialer, "tcp", addr, config)
if err != nil {
return nil, fmt.Errorf("Failed connecting to HTTP endpoint %q: %w", addr, err)
}
reverter.Add(func() { _ = conn.Close() })
l := logger.AddContext(logger.Ctx{"name": name, "local": conn.LocalAddr(), "remote": conn.RemoteAddr()})
l.Debug("Dqlite connected outbound")
remoteTCP, err := tcp.ExtractConn(conn)
if err != nil {
l.Warn("Failed extracting TCP connection from remote connection", logger.Ctx{"err": err})
} else {
err := tcp.SetTimeouts(remoteTCP, time.Second*30)
if err != nil {
l.Warn("Failed setting TCP timeouts on remote connection", logger.Ctx{"err": err})
}
}
err = request.Write(conn)
if err != nil {
return nil, fmt.Errorf("Failed sending HTTP request to %q: %w", request.URL, err)
}
response, err := http.ReadResponse(bufio.NewReader(conn), request)
if err != nil {
return nil, fmt.Errorf("Failed to read response: %w", err)
}
// If the remote server has detected that we are out of date, let's
// trigger an upgrade.
if response.StatusCode == http.StatusUpgradeRequired {
g.lock.Lock()
defer g.lock.Unlock()
if !g.upgradeTriggered {
err = triggerUpdate()
if err == nil {
g.upgradeTriggered = true
}
}
return nil, errors.New("Upgrade needed")
}
if response.StatusCode != http.StatusSwitchingProtocols {
return nil, fmt.Errorf("Dialing failed: expected status code 101 got %d", response.StatusCode)
}
if response.Header.Get("Upgrade") != "dqlite" {
return nil, errors.New("Missing or unexpected Upgrade header in response")
}
reverter.Success()
return conn, nil
}
// Create a dial function that connects to the local dqlite.
func dqliteMemoryDial(bindAddress string) client.DialFunc {
return func(ctx context.Context, address string) (net.Conn, error) {
return net.Dial("unix", bindAddress)
}
}
// The API endpoint path that gets routed to a dqlite server handler for
// performing SQL queries against the dqlite server running on this node.
const databaseEndpoint = "/internal/database"
// DqliteLog redirects dqlite's logs to our own logger.
func DqliteLog(l client.LogLevel, format string, a ...any) {
format = fmt.Sprintf("Dqlite: %s", format)
switch l {
case client.LogDebug:
logger.Debugf(format, a...)
case client.LogInfo:
logger.Debugf(format, a...)
case client.LogWarn:
logger.Debugf(format, a...)
case client.LogError:
logger.Errorf(format, a...)
}
}
// Copy incoming TLS streams from upgraded HTTPS connections into Unix sockets
// connected to the dqlite task.
func runDqliteProxy(stopCh chan struct{}, bindAddress string, acceptCh chan net.Conn) {
for {
remote := <-acceptCh
local, err := net.Dial("unix", bindAddress)
if err != nil {
continue
}
go dqliteProxy("dqlite", stopCh, remote, local)
}
}
// Copies data between a remote TLS network connection and a local unix socket.
// Accepts name argument that can be used to identify the connection in the logs.
func dqliteProxy(name string, stopCh chan struct{}, remote net.Conn, local net.Conn) {
l := logger.AddContext(logger.Ctx{"name": name, "local": remote.LocalAddr(), "remote": remote.RemoteAddr()})
l.Debug("Dqlite proxy started")
defer l.Debug("Dqlite proxy stopped")
remoteTCP, err := tcp.ExtractConn(remote)
if err != nil {
l.Warn("Failed extracting TCP connection from remote connection", logger.Ctx{"err": err})
} else {
err := tcp.SetTimeouts(remoteTCP, time.Second*30)
if err != nil {
l.Warn("Failed setting TCP timeouts on remote connection", logger.Ctx{"err": err})
}
}
remoteToLocal := make(chan error)
localToRemote := make(chan error)
// Start copying data back and forth until either the client or the
// server get closed or hit an error.
go func() {
_, err := io.Copy(local, remote)
remoteToLocal <- err
}()
go func() {
_, err := io.Copy(remote, local)
localToRemote <- err
}()
errs := make([]error, 2)
select {
case <-stopCh:
// Force closing, ignore errors.
_ = remote.Close()
_ = local.Close()
<-remoteToLocal
<-localToRemote
case err := <-remoteToLocal:
if err != nil {
errs[0] = fmt.Errorf("remote -> local: %w", err)
}
_ = local.(*net.UnixConn).CloseRead()
err = <-localToRemote
if err != nil {
errs[1] = fmt.Errorf("local -> remote: %w", err)
}
_ = remote.Close()
_ = local.Close()
case err := <-localToRemote:
if err != nil {
errs[0] = fmt.Errorf("local -> remote: %w", err)
}
_ = remoteTCP.CloseRead()
err = <-remoteToLocal
if err != nil {
errs[1] = fmt.Errorf("remote -> local: %w", err)
}
_ = local.Close()
_ = remote.Close()
}
if errs[0] != nil || errs[1] != nil {
err := dqliteProxyError{first: errs[0], second: errs[1]}
l.Debug("Dqlite proxy failed", logger.Ctx{"err": err})
}
}
type dqliteProxyError struct {
first error
second error
}
func (e dqliteProxyError) Error() string {
msg := ""
if e.first != nil {
msg += "first: " + e.first.Error()
}
if e.second != nil {
if e.first != nil {
msg += " "
}
msg += "second: " + e.second.Error()
}
return msg
}
// Conditionally uses the in-memory or the on-disk server store.
type dqliteNodeStore struct {
inMemory client.NodeStore
onDisk client.NodeStore
}
func (s *dqliteNodeStore) Get(ctx context.Context) ([]client.NodeInfo, error) {
if s.inMemory != nil {
return s.inMemory.Get(ctx)
}
return s.onDisk.Get(ctx)
}
func (s *dqliteNodeStore) Set(ctx context.Context, servers []client.NodeInfo) error {
if s.inMemory != nil {
return s.inMemory.Set(ctx, servers)
}
return s.onDisk.Set(ctx, servers)
}
|