Manage resources by tags only

Author: Tomy2e

internal/scope/cluster.go

@@ -83,15 +83,7 @@ func (c *Cluster) Close(ctx context.Context) error {
 // ResourceNameName returns the name/prefix that resources created for the cluster should have.
 // It is possible to provide additional suffixes that will be appended to the name with a leading "-".
 func (c *Cluster) ResourceName(suffixes ...string) string {
-	name := strings.Builder{}
-	name.WriteString("caps")
-
-	for _, suffix := range append([]string{c.ScalewayCluster.Name}, suffixes...) {
-		name.WriteString("-")
-		name.WriteString(suffix)
-	}
-
-	return truncateString(name.String())
+	return truncateString(strings.Join(append([]string{c.ScalewayCluster.Name}, suffixes...), "-"), 128)
 }
 
 // ResourceTags returns the tags that resources created for the cluster should have.

internal/scope/cluster_test.go

@@ -34,7 +34,7 @@ func TestCluster_ResourceName(t *testing.T) {
 				},
 			},
 			args: args{},
-			want: "caps-cluster-name",
+			want: "cluster-name",
 		},
 		{
 			name: "suffix provided",
@@ -46,7 +46,7 @@ func TestCluster_ResourceName(t *testing.T) {
 				},
 			},
 			args: args{suffixes: []string{"0"}},
-			want: "caps-cluster-name-0",
+			want: "cluster-name-0",
 		},
 	}
 	for _, tt := range tests {

internal/scope/machine.go

@@ -4,8 +4,6 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"slices"
-	"strings"
 
 	infrav1 "github.com/scaleway/cluster-api-provider-scaleway/api/v1alpha1"
 	"github.com/scaleway/cluster-api-provider-scaleway/internal/service/scaleway"
@@ -73,28 +71,14 @@ func (m *Machine) Close(ctx context.Context) error {
 	return m.PatchObject(ctx)
 }
 
-// ResourceNameName returns the name/prefix that resources created for the machine should have.
-// It is possible to provide additional suffixes that will be appended to the name with a leading "-".
-func (m *Machine) ResourceName(suffixes ...string) string {
-	name := strings.Builder{}
-	name.WriteString("caps")
-
-	for _, suffix := range append([]string{m.ScalewayMachine.Name}, suffixes...) {
-		name.WriteString("-")
-		name.WriteString(suffix)
-	}
-
-	return truncateString(name.String())
+// ResourceNameName returns the name that resources created for the machine should have.
+func (m *Machine) ResourceName() string {
+	return truncateString(m.ScalewayMachine.Name, 63)
 }
 
 // ResourceTags returns the tags that resources created for the machine should have.
-// It is possible to provide additional tags that will be added to the default tags.
-func (m *Machine) ResourceTags(additional ...string) []string {
-	return slices.Concat(
-		m.Cluster.ResourceTags(),
-		[]string{fmt.Sprintf("caps-scalewaymachine=%s", m.ScalewayMachine.Name)},
-		additional,
-	)
+func (m *Machine) ResourceTags() []string {
+	return append(m.Cluster.ResourceTags(), fmt.Sprintf("caps-scalewaymachine=%s", m.ScalewayMachine.Name))
 }
 
 // Zone returns the zone of the machine.

internal/scope/scope.go

@@ -1,15 +1,12 @@
 package scope
 
-// maxResourceNameLen is the maximum length a Scaleway resource name should have.
-const maxResourceNameLen = 128
-
-// truncateString shortens a string to a maximum of 128 characters.
+// truncateString shortens a string to a maximum of maxLen characters.
 // If the string exceeds this length, it replaces the middle portion
 // with a single dash, preserving characters from the start and end.
-func truncateString(s string) string {
-	if len(s) <= maxResourceNameLen {
+func truncateString(s string, maxLen int) string {
+	if len(s) <= maxLen {
 		return s
 	}
-	n := (maxResourceNameLen - 1) / 2
-	return s[:n] + "-" + s[len(s)-(maxResourceNameLen-1-n):]
+	n := (maxLen - 1) / 2
+	return s[:n] + "-" + s[len(s)-(maxLen-1-n):]
 }

internal/scope/scope_test.go

@@ -4,32 +4,42 @@ import "testing"
 
 func Test_truncateString(t *testing.T) {
 	type args struct {
-		s string
+		s      string
+		maxLen int
 	}
 	tests := []struct {
 		name string
 		args args
 		want string
 	}{
 		{
-			name: "short string",
-			args: args{s: "short"},
+			name: "string below max length",
+			args: args{
+				s:      "short",
+				maxLen: 128,
+			},
 			want: "short",
 		},
 		{
 			name: "exact length",
-			args: args{s: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
+			args: args{
+				s:      "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+				maxLen: 128,
+			},
 			want: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
 		},
 		{
 			name: "long string",
-			args: args{s: "this is a very long string that exceeds the maximum length of 128 characters, so it should be truncated in the middle to fit within the limit imposed by Scaleway resource naming conventions."},
+			args: args{
+				s:      "this is a very long string that exceeds the maximum length of 128 characters, so it should be truncated in the middle to fit within the limit imposed by Scaleway resource naming conventions.",
+				maxLen: 128,
+			},
 			want: "this is a very long string that exceeds the maximum length of 1-ithin the limit imposed by Scaleway resource naming conventions.",
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := truncateString(tt.args.s); got != tt.want {
+			if got := truncateString(tt.args.s, tt.args.maxLen); got != tt.want {
 				t.Errorf("truncateString() = %v, want %v", got, tt.want)
 			}
 		})

internal/service/scaleway/client/block.go

@@ -46,6 +46,10 @@ func (c *Client) FindVolume(ctx context.Context, zone scw.Zone, tags []string) (
 		return nil, err
 	}
 
+	if err := validateTags(tags); err != nil {
+		return nil, err
+	}
+
 	resp, err := c.block.ListVolumes(&block.ListVolumesRequest{
 		Zone: zone,
 		Tags: tags,

internal/service/scaleway/client/client.go

@@ -15,6 +15,11 @@ import (
 	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
+const (
+	createdByTag         = "created-by=cluster-api-provider-scaleway"
+	createdByDescription = "Created by cluster-api-provider-scaleway"
+)
+
 // Client is a wrapper over scaleway-sdk-go to access Scaleway Product APIs in
 // a specific region and project.
 type Client struct {
@@ -85,3 +90,11 @@ func matchTags(tags []string, wantedTags []string) bool {
 
 	return true
 }
+
+func validateTags(tags []string) error {
+	if len(tags) == 0 {
+		return fmt.Errorf("tags cannot be empty")
+	}
+
+	return nil
+}

internal/service/scaleway/client/domain.go

@@ -51,7 +51,7 @@ func (c *Client) SetDNSZoneRecords(ctx context.Context, zone, name string, ips [
 			Priority: 0,
 			TTL:      60,
 			Type:     domain.RecordTypeA,
-			Comment:  scw.StringPtr("Created by cluster-api-provider-scaleway"),
+			Comment:  scw.StringPtr(createdByDescription),
 		})
 	}
 

internal/service/scaleway/client/instance.go

@@ -11,25 +11,29 @@ import (
 	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
-// FindServer finds an existing Instance server by name.
+// FindServer finds an existing Instance server by tags.
 // It returns ErrNoItemFound if no matching server is found.
-func (c *Client) FindServer(ctx context.Context, zone scw.Zone, name string) (*instance.Server, error) {
+func (c *Client) FindServer(ctx context.Context, zone scw.Zone, tags []string) (*instance.Server, error) {
 	if err := c.validateZone(c.instance, zone); err != nil {
 		return nil, err
 	}
 
+	if err := validateTags(tags); err != nil {
+		return nil, err
+	}
+
 	resp, err := c.instance.ListServers(&instance.ListServersRequest{
-		Name:    scw.StringPtr(name),
+		Tags:    tags,
 		Project: &c.projectID,
 		Zone:    zone,
 	}, scw.WithContext(ctx), scw.WithAllPages())
 	if err != nil {
 		return nil, newCallError("ListServers", err)
 	}
 
-	// Filter out all servers that have the wrong name.
+	// Filter out all servers that have the wrong tags.
 	servers := slices.DeleteFunc(resp.Servers, func(server *instance.Server) bool {
-		return server.Name != name
+		return !matchTags(server.Tags, tags)
 	})
 
 	switch len(servers) {
@@ -38,7 +42,7 @@ func (c *Client) FindServer(ctx context.Context, zone scw.Zone, name string) (*i
 	case 1:
 		return servers[0], nil
 	default:
-		return nil, fmt.Errorf("%w: found %d servers with name %s", ErrTooManyItemsFound, len(servers), name)
+		return nil, fmt.Errorf("%w: found %d servers with tags %s", ErrTooManyItemsFound, len(servers), tags)
 	}
 }
 
@@ -75,7 +79,7 @@ func (c *Client) CreateServer(
 				Boot:       scw.BoolPtr(true),
 			},
 		},
-		Tags: tags,
+		Tags: append(tags, createdByTag),
 	}
 
 	if len(publicIPs) > 0 {
@@ -136,6 +140,10 @@ func (c *Client) FindIPs(ctx context.Context, zone scw.Zone, tags []string) ([]*
 		return nil, err
 	}
 
+	if err := validateTags(tags); err != nil {
+		return nil, err
+	}
+
 	resp, err := c.instance.ListIPs(&instance.ListIPsRequest{
 		Zone:    zone,
 		Project: &c.projectID,
@@ -160,7 +168,7 @@ func (c *Client) CreateIP(ctx context.Context, zone scw.Zone, ipType instance.IP
 
 	ip, err := c.instance.CreateIP(&instance.CreateIPRequest{
 		Zone: zone,
-		Tags: tags,
+		Tags: append(tags, createdByTag),
 		Type: ipType,
 	}, scw.WithContext(ctx))
 	if err != nil {
@@ -194,6 +202,7 @@ func (c *Client) CreatePrivateNIC(ctx context.Context, zone scw.Zone, serverID,
 		Zone:             zone,
 		ServerID:         serverID,
 		PrivateNetworkID: privateNetworkID,
+		Tags:             []string{createdByTag},
 	}, scw.WithContext(ctx))
 	if err != nil {
 		return nil, newCallError("CreatePrivateNIC", err)
@@ -303,6 +312,10 @@ func (c *Client) FindInstanceVolume(ctx context.Context, zone scw.Zone, tags []s
 		return nil, err
 	}
 
+	if err := validateTags(tags); err != nil {
+		return nil, err
+	}
+
 	resp, err := c.instance.ListVolumes(&instance.ListVolumesRequest{
 		Zone: zone,
 		Tags: tags,

internal/service/scaleway/client/lb.go

@@ -10,23 +10,27 @@ import (
 	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
-func (c *Client) FindLB(ctx context.Context, zone scw.Zone, name string) (*lb.LB, error) {
+func (c *Client) FindLB(ctx context.Context, zone scw.Zone, tags []string) (*lb.LB, error) {
 	if err := c.validateZone(c.lb, zone); err != nil {
 		return nil, err
 	}
 
+	if err := validateTags(tags); err != nil {
+		return nil, err
+	}
+
 	resp, err := c.lb.ListLBs(&lb.ZonedAPIListLBsRequest{
 		Zone:      zone,
-		Name:      &name,
+		Tags:      tags,
 		ProjectID: &c.projectID,
 	}, scw.WithContext(ctx), scw.WithAllPages())
 	if err != nil {
 		return nil, newCallError("ListLBs", err)
 	}
 
-	// Filter out all LBs that have the wrong name.
+	// Filter out all LBs that have the wrong tags.
 	lbs := slices.DeleteFunc(resp.LBs, func(lb *lb.LB) bool {
-		return lb.Name != name
+		return !matchTags(lb.Tags, tags)
 	})
 
 	switch len(lbs) {
@@ -35,7 +39,7 @@ func (c *Client) FindLB(ctx context.Context, zone scw.Zone, name string) (*lb.LB
 	case 1:
 		return lbs[0], nil
 	default:
-		return nil, fmt.Errorf("%w: found %d LBs with name %s", ErrTooManyItemsFound, len(lbs), name)
+		return nil, fmt.Errorf("%w: found %d LBs with tags %s", ErrTooManyItemsFound, len(lbs), tags)
 	}
 }
 
@@ -95,7 +99,8 @@ func (c *Client) CreateLB(
 		Name:               name,
 		Type:               lbType,
 		IPID:               ipID,
-		Tags:               tags,
+		Tags:               append(tags, createdByTag),
+		Description:        createdByDescription,
 		AssignFlexibleIP:   scw.BoolPtr(ipID == nil),
 		AssignFlexibleIPv6: scw.BoolPtr(false),
 	}, scw.WithContext(ctx))
@@ -122,11 +127,14 @@ func (c *Client) DeleteLB(ctx context.Context, zone scw.Zone, id string, release
 	return nil
 }
 
-func (c *Client) FindLBs(ctx context.Context, prefix string, tags []string) ([]*lb.LB, error) {
+func (c *Client) FindLBs(ctx context.Context, tags []string) ([]*lb.LB, error) {
+	if err := validateTags(tags); err != nil {
+		return nil, err
+	}
+
 	resp, err := c.lb.ListLBs(&lb.ZonedAPIListLBsRequest{
 		Zone:      scw.ZoneFrPar1, // Dummy value, refer to the scw.WithZones option.
 		ProjectID: &c.projectID,
-		Name:      scw.StringPtr(prefix),
 		Tags:      tags,
 	}, scw.WithContext(ctx), scw.WithAllPages(), scw.WithZones(c.productZones(c.lb)...))
 	if err != nil {
@@ -135,7 +143,7 @@ func (c *Client) FindLBs(ctx context.Context, prefix string, tags []string) ([]*
 
 	// Filter out LBs that don't have the right prefix or tags.
 	lbs := slices.DeleteFunc(resp.LBs, func(lb *lb.LB) bool {
-		return !strings.HasPrefix(lb.Name, prefix) || !matchTags(lb.Tags, tags)
+		return !matchTags(lb.Tags, tags)
 	})
 
 	return lbs, nil