make controller logic independable with certain tidbcluster label (#1419

)
pingcap · Dec 26, 2019 · 2d407d9 · 2d407d9
1 parent eb67f58
commit 2d407d9
Show file tree

Hide file tree

Showing 17 changed files with 106 additions and 94 deletions.
diff --git a/pkg/apis/pingcap/v1alpha1/tidbcluster.go b/pkg/apis/pingcap/v1alpha1/tidbcluster.go
@@ -16,6 +16,7 @@ package v1alpha1
 import (
 	"fmt"
 
+	"github.com/pingcap/tidb-operator/pkg/label"
 	corev1 "k8s.io/api/core/v1"
 )
 
@@ -403,3 +404,14 @@ func (tc *TidbCluster) Timezone() string {
 	}
 	return tz
 }
+
+func (tc *TidbCluster) GetInstanceName() string {
+	labels := tc.ObjectMeta.GetLabels()
+	// Keep backward compatibility for helm.
+	// This introduce a hidden danger that change this label will trigger rolling-update of most of the components
+	// TODO(aylei): disallow mutation of this label or adding this label with value other than the cluster name in ValidateUpdate()
+	if inst, ok := labels[label.InstanceLabelKey]; ok {
+		return inst
+	}
+	return tc.Name
+}
diff --git a/pkg/manager/member/orphan_pods_cleaner.go b/pkg/manager/member/orphan_pods_cleaner.go
@@ -71,7 +71,7 @@ func (opc *orphanPodsCleaner) Clean(tc *v1alpha1.TidbCluster) (map[string]string
 	// for unit test
 	skipReason := map[string]string{}
 
-	selector, err := label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).Selector()
+	selector, err := label.New().Instance(tc.GetInstanceName()).Selector()
 	if err != nil {
 		return skipReason, err
 	}

diff --git a/pkg/manager/member/orphan_pods_cleaner_test.go b/pkg/manager/member/orphan_pods_cleaner_test.go
@@ -86,7 +86,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).TiDB().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).TiDB().Labels(),
 					},
 				},
 			},
@@ -104,7 +104,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Status: corev1.PodStatus{
 						Phase: corev1.PodPending,
@@ -125,7 +125,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -158,7 +158,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -198,7 +198,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -233,7 +233,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -268,7 +268,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 						UID:             "pod-1-uid",
 						ResourceVersion: "1",
 						Namespace:       metav1.NamespaceDefault,
-						Labels:          label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:          label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -294,7 +294,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 						UID:             "pod-1-uid",
 						ResourceVersion: "2",
 						Namespace:       metav1.NamespaceDefault,
-						Labels:          label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:          label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -327,7 +327,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -361,7 +361,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-1",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -383,7 +383,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-2",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).TiKV().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).TiKV().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -405,7 +405,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-3",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).TiKV().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).TiKV().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{
@@ -427,7 +427,7 @@ func TestOrphanPodsCleanerClean(t *testing.T) {
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "pod-4",
 						Namespace: metav1.NamespaceDefault,
-						Labels:    label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).TiDB().Labels(),
+						Labels:    label.New().Instance(tc.GetInstanceName()).TiDB().Labels(),
 					},
 					Spec: corev1.PodSpec{
 						Volumes: []corev1.Volume{

diff --git a/pkg/manager/member/pd_member_manager.go b/pkg/manager/member/pd_member_manager.go
@@ -438,7 +438,7 @@ func (pmm *pdMemberManager) getNewPDServiceForTidbCluster(tc *v1alpha1.TidbClust
 	ns := tc.Namespace
 	tcName := tc.Name
 	svcName := controller.PDMemberName(tcName)
-	instanceName := tc.GetLabels()[label.InstanceLabelKey]
+	instanceName := tc.GetInstanceName()
 	pdLabel := label.New().Instance(instanceName).PD().Labels()
 
 	return &corev1.Service{
@@ -467,7 +467,7 @@ func getNewPDHeadlessServiceForTidbCluster(tc *v1alpha1.TidbCluster) *corev1.Ser
 	ns := tc.Namespace
 	tcName := tc.Name
 	svcName := controller.PDPeerMemberName(tcName)
-	instanceName := tc.GetLabels()[label.InstanceLabelKey]
+	instanceName := tc.GetInstanceName()
 	pdLabel := label.New().Instance(instanceName).PD().Labels()
 
 	return &corev1.Service{
@@ -498,7 +498,7 @@ func (pmm *pdMemberManager) pdStatefulSetIsUpgrading(set *apps.StatefulSet, tc *
 		return true, nil
 	}
 	selector, err := label.New().
-		Instance(tc.GetLabels()[label.InstanceLabelKey]).
+		Instance(tc.GetInstanceName()).
 		PD().
 		Selector()
 	if err != nil {
@@ -523,7 +523,7 @@ func (pmm *pdMemberManager) pdStatefulSetIsUpgrading(set *apps.StatefulSet, tc *
 func getNewPDSetForTidbCluster(tc *v1alpha1.TidbCluster, cm *corev1.ConfigMap) (*apps.StatefulSet, error) {
 	ns := tc.Namespace
 	tcName := tc.Name
-	instanceName := tc.GetLabels()[label.InstanceLabelKey]
+	instanceName := tc.GetInstanceName()
 	pdConfigMap := controller.MemberConfigMapName(tc, v1alpha1.PDMemberType)
 	if cm != nil {
 		pdConfigMap = cm.Name
@@ -728,7 +728,7 @@ func getPDConfigMap(tc *v1alpha1.TidbCluster) (*corev1.ConfigMap, error) {
 		return nil, err
 	}
 
-	instanceName := tc.GetLabels()[label.InstanceLabelKey]
+	instanceName := tc.GetInstanceName()
 	pdLabel := label.New().Instance(instanceName).PD().Labels()
 	cm := &corev1.ConfigMap{
 		ObjectMeta: metav1.ObjectMeta{

diff --git a/pkg/manager/member/pd_member_manager_test.go b/pkg/manager/member/pd_member_manager_test.go
@@ -447,7 +447,7 @@ func TestPDMemberManagerPdStatefulSetIsUpgrading(t *testing.T) {
 					Name:        ordinalPodName(v1alpha1.PDMemberType, tc.GetName(), 0),
 					Namespace:   metav1.NamespaceDefault,
 					Annotations: map[string]string{},
-					Labels:      label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).PD().Labels(),
+					Labels:      label.New().Instance(tc.GetInstanceName()).PD().Labels(),
 				},
 			}
 			if test.updatePod != nil {
@@ -849,7 +849,7 @@ func TestGetNewPDHeadlessServiceForTidbCluster(t *testing.T) {
 					Labels: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pd",
 					},
 					OwnerReferences: []metav1.OwnerReference{
@@ -880,7 +880,7 @@ func TestGetNewPDHeadlessServiceForTidbCluster(t *testing.T) {
 					Selector: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pd",
 					},
 					PublishNotReadyAddresses: true,
@@ -1088,7 +1088,7 @@ func TestGetPDConfigMap(t *testing.T) {
 					Labels: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pd",
 					},
 					OwnerReferences: []metav1.OwnerReference{

diff --git a/pkg/manager/member/pump_member_manager.go b/pkg/manager/member/pump_member_manager.go
@@ -402,7 +402,7 @@ func getNewPumpStatefulSet(tc *v1alpha1.TidbCluster, cm *corev1.ConfigMap) (*app
 }
 
 func getPumpMeta(tc *v1alpha1.TidbCluster, nameFunc func(string) string) (metav1.ObjectMeta, label.Label) {
-	instanceName := tc.GetLabels()[label.InstanceLabelKey]
+	instanceName := tc.GetInstanceName()
 	pumpLabel := label.New().Instance(instanceName).Pump()
 
 	objMeta := metav1.ObjectMeta{
@@ -453,7 +453,7 @@ func (pmm *pumpMemberManager) pumpStatefulSetIsUpgrading(set *apps.StatefulSet,
 		return true, nil
 	}
 	selector, err := label.New().
-		Instance(tc.GetLabels()[label.InstanceLabelKey]).
+		Instance(tc.GetInstanceName()).
 		Pump().
 		Selector()
 	if err != nil {

diff --git a/pkg/manager/member/pump_member_manager_test.go b/pkg/manager/member/pump_member_manager_test.go
@@ -548,7 +548,7 @@ func TestGetNewPumpHeadlessService(t *testing.T) {
 					Labels: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pump",
 					},
 					OwnerReferences: []metav1.OwnerReference{
@@ -579,7 +579,7 @@ func TestGetNewPumpHeadlessService(t *testing.T) {
 					Selector: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pump",
 					},
 					PublishNotReadyAddresses: true,
@@ -627,7 +627,7 @@ func TestGetNewPumpConfigMap(t *testing.T) {
 					Labels: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pump",
 					},
 					OwnerReferences: []metav1.OwnerReference{
@@ -676,7 +676,7 @@ func TestGetNewPumpConfigMap(t *testing.T) {
 					Labels: map[string]string{
 						"app.kubernetes.io/name":       "tidb-cluster",
 						"app.kubernetes.io/managed-by": "tidb-operator",
-						"app.kubernetes.io/instance":   "",
+						"app.kubernetes.io/instance":   "foo",
 						"app.kubernetes.io/component":  "pump",
 					},
 					OwnerReferences: []metav1.OwnerReference{

diff --git a/pkg/manager/member/pvc_cleaner.go b/pkg/manager/member/pvc_cleaner.go
@@ -273,7 +273,7 @@ func (rpc *realPVCCleaner) listAllPVCs(tc *v1alpha1.TidbCluster) ([]*corev1.Pers
 	ns := tc.GetNamespace()
 	tcName := tc.GetName()
 
-	selector, err := label.New().Instance(tc.GetLabels()[label.InstanceLabelKey]).Selector()
+	selector, err := label.New().Instance(tc.GetInstanceName()).Selector()
 	if err != nil {
 		return nil, fmt.Errorf("cluster %s/%s assemble label selector failed, err: %v", ns, tcName, err)
 	}