cartridge roles: read roles from annotations, fallback to labels

Author: vasiliy-t

examples/kv/helm-chart/values.yaml

@@ -35,4 +35,3 @@ RoleConfig:
     MemtxMemoryMB: 256
     RolesToAssign:
       - storage
-      - vshard.storage

pkg/topology/builtin.go

@@ -152,6 +152,42 @@ var getServerStatQuery = `query serverList {
 	}
 }`
 
+// GetRoles comment
+func GetRoles(pod *corev1.Pod) ([]string, error) {
+	thisPodLabels := pod.GetLabels()
+	thisPodAnnotations := pod.GetAnnotations()
+
+	rolesFromAnnotations, ok := thisPodAnnotations["tarantool.io/rolesToAssign"]
+	if !ok {
+		rolesFromLabels, ok := thisPodLabels["tarantool.io/rolesToAssign"]
+		if !ok {
+			return nil, errors.New("role undefined")
+		}
+
+		roles := strings.Split(rolesFromLabels, ".")
+		log.Info("roles", "roles", roles)
+
+		return roles, nil
+	}
+
+	var singleRole string
+	var roleArray []string
+
+	err := json.Unmarshal([]byte(rolesFromAnnotations), &singleRole)
+	if err == nil {
+		log.Info("roles", "roles", singleRole)
+		return []string{singleRole}, nil
+	}
+
+	err = json.Unmarshal([]byte(rolesFromAnnotations), &roleArray)
+	if err == nil {
+		log.Info("roles", "roles", roleArray)
+		return roleArray, nil
+	}
+
+	return nil, errors.New("failed to parse roles from annotations")
+}
+
 // Join comment
 func (s *BuiltInTopologyService) Join(pod *corev1.Pod) error {
 
@@ -171,10 +207,11 @@ func (s *BuiltInTopologyService) Join(pod *corev1.Pod) error {
 		return errors.New("instance uuid empty")
 	}
 
-	role, ok := thisPodLabels["tarantool.io/rolesToAssign"]
-	if !ok {
-		return errors.New("role undefined")
+	roles, err := GetRoles(pod)
+	if err != nil {
+		return err
 	}
+	log.Info("roles", "roles", roles)
 
 	vshardGroup := "default"
 	useVshardGroups, ok := thisPodLabels["tarantool.io/useVshardGroups"]
@@ -189,10 +226,6 @@ func (s *BuiltInTopologyService) Join(pod *corev1.Pod) error {
 		}
 	}
 
-	roles := strings.Split(role, ".")
-
-	log.Info("roles", "roles", roles)
-
 	client := graphql.NewClient(s.serviceHost, graphql.WithHTTPClient(&http.Client{Timeout: time.Duration(time.Second * 5)}))
 	req := graphql.NewRequest(joinMutation)
 

pkg/topology/builtin_test.go

@@ -0,0 +1,151 @@
+package topology
+
+import (
+	"strings"
+	"testing"
+
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func Contains(a []string, x string) bool {
+	for _, n := range a {
+		if x == n {
+			return true
+		}
+	}
+	return false
+}
+
+type errorTestCase struct {
+	pod         *corev1.Pod
+	expectedErr string
+}
+
+func TestGetRoles_ErrorCases(t *testing.T) {
+	cases := []errorTestCase{
+		{
+			pod:         &corev1.Pod{},
+			expectedErr: "role undefined",
+		},
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{},
+				},
+			},
+			expectedErr: "role undefined",
+		},
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						"tarantool.io/someLabel": "some value",
+					},
+				},
+			},
+			expectedErr: "role undefined",
+		},
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{},
+					Labels:      map[string]string{},
+				},
+			},
+			expectedErr: "role undefined",
+		},
+	}
+	for i, c := range cases {
+		roles, err := GetRoles(c.pod)
+
+		if roles != nil {
+			t.Fatalf("%d: roles must be nil", i)
+		}
+
+		if strings.Contains(err.Error(), c.expectedErr) == false {
+			t.Fatalf("%d: expected error %s, got %s", i, c.expectedErr, err.Error())
+		}
+	}
+}
+
+type parseRolesTestCase struct {
+	pod           *corev1.Pod
+	expectedRoles []string
+}
+
+func TestGetRoles_ParsesRolesFromLabels(t *testing.T) {
+	cases := []parseRolesTestCase{
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						"tarantool.io/rolesToAssign": "router",
+					},
+				},
+			},
+			expectedRoles: []string{"router"},
+		},
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						"tarantool.io/rolesToAssign": "router.storage",
+					},
+				},
+			},
+			expectedRoles: []string{"router", "storage"},
+		},
+	}
+
+	for i, c := range cases {
+		roles, _ := GetRoles(c.pod)
+		if len(roles) != len(c.expectedRoles) {
+			t.Fatalf("%d: expected %d roles, got %d", i, len(c.expectedRoles), len(roles))
+		}
+
+		for _, v := range c.expectedRoles {
+			if Contains(roles, v) == false {
+				t.Fatalf("%d: roles must contain %s", i, v)
+			}
+		}
+	}
+}
+
+func TestGetRoles_ParseRolesFromAnnotations(t *testing.T) {
+	cases := []parseRolesTestCase{
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{
+						"tarantool.io/rolesToAssign": `"router"`,
+					},
+				},
+			},
+			expectedRoles: []string{"router"},
+		},
+		{
+			pod: &corev1.Pod{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{
+						"tarantool.io/rolesToAssign": `["router", "vshard.storage"]`,
+					},
+				},
+			},
+			expectedRoles: []string{"router", "vshard.storage"},
+		},
+	}
+
+	for i, c := range cases {
+		roles, _ := GetRoles(c.pod)
+		if len(roles) != len(c.expectedRoles) {
+			t.Fatalf("%d: expected %d roles, got %d", i, len(c.expectedRoles), len(roles))
+		}
+
+		for _, v := range c.expectedRoles {
+			if Contains(roles, v) == false {
+				t.Fatalf("%d: roles must contain %s", i, v)
+			}
+		}
+	}
+}