From 53a06af9ba62a26149e84838e96bb466d7521ffc Mon Sep 17 00:00:00 2001 From: Brian Picciano Date: Fri, 8 Nov 2024 17:46:44 +0100 Subject: [PATCH] Use the term 'role' or 'node' rather than 'peer' in the context of garage --- go/bootstrap/garage.go | 24 +++++++------- go/bootstrap/hosts.go | 10 +++--- go/cmd/entrypoint/garage.go | 4 +-- go/daemon/children/garage.go | 8 ++--- go/daemon/network/garage.go | 14 ++++---- go/daemon/network/network.go | 4 +-- go/daemon/network/network_it_test.go | 18 +++++------ go/garage/admin_client.go | 48 ++++++++++++---------------- go/garage/garagesrv/tpl.go | 8 ++--- go/garage/peer.go | 26 +++++++-------- 10 files changed, 78 insertions(+), 86 deletions(-) diff --git a/go/bootstrap/garage.go b/go/bootstrap/garage.go index 28d49ca..f0c2af4 100644 --- a/go/bootstrap/garage.go +++ b/go/bootstrap/garage.go @@ -4,26 +4,26 @@ import ( "isle/garage" ) -// GaragePeers returns a Peer for each known garage instance in the network. -func (b Bootstrap) GaragePeers() []garage.RemotePeer { - var peers []garage.RemotePeer +// GarageNodes returns a Node for each known garage instance in the network. +func (b Bootstrap) GarageNodes() []garage.RemoteNode { + var nodes []garage.RemoteNode for _, host := range b.Hosts { - peers = append(peers, host.GaragePeers()...) + nodes = append(nodes, host.GarageNodes()...) } - return peers + return nodes } -// ChooseGaragePeer returns a Peer for a garage instance from the network. It -// will prefer a garage instance on this particular host, if there is one, but -// will otherwise return a random endpoint. -func (b Bootstrap) ChooseGaragePeer() garage.RemotePeer { +// ChooseGarageNode returns a RemoteNode for a garage instance from the network. +// It will prefer a garage instance on this particular host, if there is one, +// but will otherwise return a random endpoint. +func (b Bootstrap) ChooseGarageNode() garage.RemoteNode { thisHost := b.ThisHost() if len(thisHost.Garage.Instances) > 0 { - return thisHost.GaragePeers()[0] + return thisHost.GarageNodes()[0] } - for _, peer := range b.GaragePeers() { - return peer + for _, node := range b.GarageNodes() { + return node } panic("no garage instances configured") diff --git a/go/bootstrap/hosts.go b/go/bootstrap/hosts.go index f5670d0..b4880da 100644 --- a/go/bootstrap/hosts.go +++ b/go/bootstrap/hosts.go @@ -93,17 +93,17 @@ func (h Host) IP() netip.Addr { return addr } -// GaragePeers returns a RemotePeer for each garage instance advertised by this +// GarageNodes returns a RemoteNode for each garage instance advertised by this // Host. -func (h Host) GaragePeers() []garage.RemotePeer { - var peers []garage.RemotePeer +func (h Host) GarageNodes() []garage.RemoteNode { + var nodes []garage.RemoteNode for _, instance := range h.Garage.Instances { - peers = append(peers, garage.RemotePeer{ + nodes = append(nodes, garage.RemoteNode{ ID: instance.ID, IP: h.IP().String(), RPCPort: instance.RPCPort, S3APIPort: instance.S3APIPort, }) } - return peers + return nodes } diff --git a/go/cmd/entrypoint/garage.go b/go/cmd/entrypoint/garage.go index f67a136..b881ea6 100644 --- a/go/cmd/entrypoint/garage.go +++ b/go/cmd/entrypoint/garage.go @@ -56,7 +56,7 @@ var subCmdGarageMC = subCmd{ return fmt.Errorf("calling GetGarageClientParams: %w", err) } - s3APIAddr := clientParams.Peer.S3APIAddr() + s3APIAddr := clientParams.Node.S3APIAddr() if *keyID == "" { *keyID = clientParams.GlobalBucketS3APICredentials.ID @@ -135,7 +135,7 @@ var subCmdGarageCLI = subCmd{ args = append([]string{"garage"}, ctx.args...) cliEnv = append( os.Environ(), - "GARAGE_RPC_HOST="+clientParams.Peer.RPCPeerAddr(), + "GARAGE_RPC_HOST="+clientParams.Node.RPCNodeAddr(), "GARAGE_RPC_SECRET="+clientParams.RPCSecret, ) ) diff --git a/go/daemon/children/garage.go b/go/daemon/children/garage.go index c8b220a..3cc1a7c 100644 --- a/go/daemon/children/garage.go +++ b/go/daemon/children/garage.go @@ -76,8 +76,8 @@ func garageWriteChildConfig( thisHost = hostBootstrap.ThisHost() id = daecommon.BootstrapGarageHostForAlloc(thisHost, alloc).ID - peer = garage.LocalPeer{ - RemotePeer: garage.RemotePeer{ + node = garage.LocalNode{ + RemoteNode: garage.RemoteNode{ ID: id, IP: thisHost.IP().String(), RPCPort: alloc.RPCPort, @@ -102,8 +102,8 @@ func garageWriteChildConfig( RPCSecret: rpcSecret, AdminToken: adminToken, - LocalPeer: peer, - BootstrapPeers: hostBootstrap.GaragePeers(), + LocalNode: node, + BootstrapPeers: hostBootstrap.GarageNodes(), }, ) diff --git a/go/daemon/network/garage.go b/go/daemon/network/garage.go index 41fe19c..faa18ab 100644 --- a/go/daemon/network/garage.go +++ b/go/daemon/network/garage.go @@ -46,7 +46,7 @@ func getGarageClientParams( } return GarageClientParams{ - Peer: currBootstrap.ChooseGaragePeer(), + Node: currBootstrap.ChooseGarageNode(), GlobalBucketS3APICredentials: creds, RPCSecret: rpcSecret, }, nil @@ -88,8 +88,8 @@ func garageApplyLayout( ) hostName = currHost.Name allocs = networkConfig.Storage.Allocations - peers = make([]garage.PeerLayout, len(allocs)) - peerIDs = map[string]struct{}{} + roles = make([]garage.Role, len(allocs)) + roleIDs = map[string]struct{}{} idsToRemove = make([]string, 0, len(prevHost.Garage.Instances)) ) @@ -98,14 +98,14 @@ func garageApplyLayout( for i, alloc := range allocs { id := daecommon.BootstrapGarageHostForAlloc(currHost, alloc).ID - peerIDs[id] = struct{}{} + roleIDs[id] = struct{}{} zone := string(hostName) if alloc.Zone != "" { zone = alloc.Zone } - peers[i] = garage.PeerLayout{ + roles[i] = garage.Role{ ID: id, Capacity: alloc.Capacity * 1_000_000_000, Zone: zone, @@ -114,12 +114,12 @@ func garageApplyLayout( } for _, prevInst := range prevHost.Garage.Instances { - if _, ok := peerIDs[prevInst.ID]; !ok { + if _, ok := roleIDs[prevInst.ID]; !ok { idsToRemove = append(idsToRemove, prevInst.ID) } } - return adminClient.ApplyLayout(ctx, peers, idsToRemove) + return adminClient.ApplyLayout(ctx, roles, idsToRemove) } func garageInitializeGlobalBucket( diff --git a/go/daemon/network/network.go b/go/daemon/network/network.go index c2f48de..d311762 100644 --- a/go/daemon/network/network.go +++ b/go/daemon/network/network.go @@ -31,7 +31,7 @@ import ( // GarageClientParams contains all the data needed to instantiate garage // clients. type GarageClientParams struct { - Peer garage.RemotePeer + Node garage.RemoteNode GlobalBucketS3APICredentials garage.S3APICredentials // RPCSecret may be empty, if the secret is not available on the host. @@ -44,7 +44,7 @@ type GarageClientParams struct { // the global bucket. func (p GarageClientParams) GlobalBucketS3APIClient() *garage.S3APIClient { var ( - addr = p.Peer.S3APIAddr() + addr = p.Node.S3APIAddr() creds = p.GlobalBucketS3APICredentials ) return garage.NewS3APIClient(addr, creds) diff --git a/go/daemon/network/network_it_test.go b/go/daemon/network/network_it_test.go index 4875242..983a621 100644 --- a/go/daemon/network/network_it_test.go +++ b/go/daemon/network/network_it_test.go @@ -82,19 +82,19 @@ func TestNetwork_GetConfig(t *testing.T) { } func TestNetwork_SetConfig(t *testing.T) { - allocsToPeerLayouts := func( + allocsToRoles := func( hostName nebula.HostName, allocs []bootstrap.GarageHostInstance, - ) []garage.PeerLayout { - peers := make([]garage.PeerLayout, len(allocs)) + ) []garage.Role { + roles := make([]garage.Role, len(allocs)) for i := range allocs { - peers[i] = garage.PeerLayout{ + roles[i] = garage.Role{ ID: allocs[i].ID, Capacity: 1_000_000_000, Zone: string(hostName), Tags: []string{}, } } - return peers + return roles } t.Run("add storage alloc", func(t *testing.T) { @@ -142,10 +142,10 @@ func TestNetwork_SetConfig(t *testing.T) { assert.Equal(t, newHostsByName, storedBootstrap.Hosts) t.Log("Checking that garage layout contains the new allocation") - expPeers := allocsToPeerLayouts(network.hostName, allocs) + expRoles := allocsToRoles(network.hostName, allocs) layout, err := network.garageAdminClient(t).GetLayout(h.ctx) assert.NoError(t, err) - assert.ElementsMatch(t, expPeers, layout.Peers) + assert.ElementsMatch(t, expRoles, layout.Roles) }) t.Run("remove storage alloc", func(t *testing.T) { @@ -183,10 +183,10 @@ func TestNetwork_SetConfig(t *testing.T) { assert.Equal(t, newHostsByName, storedBootstrap.Hosts) t.Log("Checking that garage layout contains the new allocation") - expPeers := allocsToPeerLayouts(network.hostName, allocs) + expRoles := allocsToRoles(network.hostName, allocs) layout, err := network.garageAdminClient(t).GetLayout(h.ctx) assert.NoError(t, err) - assert.ElementsMatch(t, expPeers, layout.Peers) + assert.ElementsMatch(t, expRoles, layout.Roles) }) // TODO a host having allocs but removing all of them diff --git a/go/garage/admin_client.go b/go/garage/admin_client.go index 428ca63..129394b 100644 --- a/go/garage/admin_client.go +++ b/go/garage/admin_client.go @@ -283,9 +283,9 @@ func (c *AdminClient) GrantBucketPermissions( }) } -// PeerLayout describes the properties of a garage peer in the context of the -// layout of the cluster. -type PeerLayout struct { +// Role descibes a node's role in the garage cluster, i.e. what storage it is +// providing. +type Role struct { ID string `json:"id"` Capacity int `json:"capacity"` // Gb (SI units) Zone string `json:"zone"` @@ -294,7 +294,7 @@ type PeerLayout struct { // ClusterLayout describes the layout of the cluster as a whole. type ClusterLayout struct { - Peers []PeerLayout `json:"roles"` + Roles []Role `json:"roles"` } // GetLayout returns the currently applied ClusterLayout. @@ -306,42 +306,34 @@ func (c *AdminClient) GetLayout(ctx context.Context) (ClusterLayout, error) { } // ApplyLayout modifies the layout of the garage cluster. Only layout of the -// given peers will be modified/created/removed, other peers are not affected. +// given roles will be modified/created/removed, other roles are not affected. func (c *AdminClient) ApplyLayout( - ctx context.Context, addModifyPeers []PeerLayout, removePeerIDs []string, + ctx context.Context, addModifyRoles []Role, removeRoleIDs []string, ) error { - type removePeer struct { + type removeRole struct { ID string `json:"id"` Remove bool `json:"remove"` } - peers := make([]any, 0, len(addModifyPeers)+len(removePeerIDs)) - for _, p := range addModifyPeers { - peers = append(peers, p) + roles := make([]any, 0, len(addModifyRoles)+len(removeRoleIDs)) + for _, p := range addModifyRoles { + roles = append(roles, p) } - for _, id := range removePeerIDs { - peers = append(peers, removePeer{ID: id, Remove: true}) - } - - { - // https://garagehq.deuxfleurs.fr/api/garage-admin-v1.html#tag/Layout/operation/ApplyLayout - err := c.do(ctx, nil, "POST", "/v1/layout", peers) - if err != nil { - return fmt.Errorf("staging layout changes: %w", err) - } + for _, id := range removeRoleIDs { + roles = append(roles, removeRole{ID: id, Remove: true}) } // https://garagehq.deuxfleurs.fr/api/garage-admin-v1.html#tag/Layout/operation/GetLayout var clusterLayout struct { - Version int `json:"version"` - StagedRoleChanges []PeerLayout `json:"stagedRoleChanges"` + Version int `json:"version"` + StagedRoleChanges []Role `json:"stagedRoleChanges"` } - if err := c.do(ctx, &clusterLayout, "GET", "/v1/layout", nil); err != nil { - return fmt.Errorf("retrieving staged layout change: %w", err) - } - - if len(clusterLayout.StagedRoleChanges) == 0 { + // https://garagehq.deuxfleurs.fr/api/garage-admin-v1.html#tag/Layout/operation/ApplyLayout + err := c.do(ctx, &clusterLayout, "POST", "/v1/layout", roles) + if err != nil { + return fmt.Errorf("staging layout changes: %w", err) + } else if len(clusterLayout.StagedRoleChanges) == 0 { return nil } @@ -352,7 +344,7 @@ func (c *AdminClient) ApplyLayout( Version: clusterLayout.Version + 1, } - err := c.do(ctx, nil, "POST", "/v1/layout/apply", applyClusterLayout) + err = c.do(ctx, nil, "POST", "/v1/layout/apply", applyClusterLayout) if err != nil { return fmt.Errorf("applying new layout (new version:%d): %w", applyClusterLayout.Version, err) } diff --git a/go/garage/garagesrv/tpl.go b/go/garage/garagesrv/tpl.go index f36804a..ccf031b 100644 --- a/go/garage/garagesrv/tpl.go +++ b/go/garage/garagesrv/tpl.go @@ -23,8 +23,8 @@ type GarageTomlData struct { RPCSecret string AdminToken string - garage.LocalPeer - BootstrapPeers []garage.RemotePeer + garage.LocalNode + BootstrapPeers []garage.RemoteNode } var garageTomlTpl = template.Must(template.New("").Parse(` @@ -38,7 +38,7 @@ rpc_bind_addr = "{{ .RPCAddr }}" rpc_public_addr = "{{ .RPCAddr }}" bootstrap_peers = [{{- range .BootstrapPeers }} -"{{ .RPCPeerAddr }}", +"{{ .RPCNodeAddr }}", {{ end -}}] [s3_api] @@ -66,7 +66,7 @@ func WriteGarageTomlFile( ) ( bool, error, ) { - slices.SortFunc(data.BootstrapPeers, func(i, j garage.RemotePeer) int { + slices.SortFunc(data.BootstrapPeers, func(i, j garage.RemoteNode) int { return cmp.Or( cmp.Compare(i.IP, j.IP), cmp.Compare(i.RPCPort, j.RPCPort), diff --git a/go/garage/peer.go b/go/garage/peer.go index c58479b..4481281 100644 --- a/go/garage/peer.go +++ b/go/garage/peer.go @@ -6,39 +6,39 @@ import ( "strconv" ) -// RemotePeer describes all information necessary to connect to a given garage +// RemoteNode describes all information necessary to connect to a given garage // node. -type RemotePeer struct { +type RemoteNode struct { ID string IP string RPCPort int S3APIPort int } -// LocalPeer describes the configuration of a local garage instance. -type LocalPeer struct { - RemotePeer +// LocalNode describes the configuration of a local garage instance. +type LocalNode struct { + RemoteNode AdminPort int } -// RPCAddr returns the address of the peer's RPC port. -func (p RemotePeer) RPCAddr() string { +// RPCAddr returns the address of the node's RPC port. +func (p RemoteNode) RPCAddr() string { return net.JoinHostPort(p.IP, strconv.Itoa(p.RPCPort)) } -// RPCPeerAddr returns the full peer address (e.g. "id@ip:port") of the garage +// RPCNodeAddr returns the full node address (e.g. "id@ip:port") of the garage // node for use in communicating over RPC. -func (p RemotePeer) RPCPeerAddr() string { +func (p RemoteNode) RPCNodeAddr() string { return fmt.Sprintf("%s@%s", p.ID, p.RPCAddr()) } -// S3APIAddr returns the address of the peer's S3 API port. -func (p RemotePeer) S3APIAddr() string { +// S3APIAddr returns the address of the node's S3 API port. +func (p RemoteNode) S3APIAddr() string { return net.JoinHostPort(p.IP, strconv.Itoa(p.S3APIPort)) } -// AdminAddr returns the address of the peer's S3 API port. -func (p LocalPeer) AdminAddr() string { +// AdminAddr returns the address of the node's S3 API port. +func (p LocalNode) AdminAddr() string { return net.JoinHostPort(p.IP, strconv.Itoa(p.AdminPort)) }