Add controller-name label for Pod and service (kubeflow#1067)

* Add controller-name label for Pod and service * Fix test error
ChenYi015 · Aug 16, 2019 · 3cc84f9 · 3cc84f9
1 parent b7de6e4
commit 3cc84f9
Show file tree

Hide file tree

Showing 47 changed files with 81 additions and 54 deletions.
diff --git a/cmd/tf-operator.v1/app/options/options.go b/cmd/tf-operator.v1/app/options/options.go
@@ -18,7 +18,7 @@ import (
 	"flag"
 	"time"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 )
 
 const DefaultResyncPeriod = 12 * time.Hour

diff --git a/cmd/tf-operator.v1/app/server.go b/cmd/tf-operator.v1/app/server.go
@@ -21,7 +21,7 @@ import (
 	"time"
 
 	"github.com/kubeflow/tf-operator/cmd/tf-operator.v1/app/options"
-	"github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1"
+	v1 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1"
 	tfjobclientset "github.com/kubeflow/tf-operator/pkg/client/clientset/versioned"
 	"github.com/kubeflow/tf-operator/pkg/client/clientset/versioned/scheme"
 	tfjobinformers "github.com/kubeflow/tf-operator/pkg/client/informers/externalversions"

diff --git a/cmd/tf-operator.v1beta2/app/options/options.go b/cmd/tf-operator.v1beta2/app/options/options.go
@@ -17,7 +17,7 @@ package options
 import (
 	"flag"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 )
 
 // ServerOption is the main context object for the controller manager.

diff --git a/cmd/tf-operator.v1beta2/app/server.go b/cmd/tf-operator.v1beta2/app/server.go
@@ -30,7 +30,7 @@ import (
 	"github.com/kubeflow/tf-operator/pkg/version"
 	kubebatchclient "github.com/kubernetes-sigs/kube-batch/pkg/client/clientset/versioned"
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kubeinformers "k8s.io/client-go/informers"

diff --git a/dashboard/backend/handler/api_handler.go b/dashboard/backend/handler/api_handler.go
@@ -160,7 +160,7 @@ func (apiHandler *APIHandler) handleGetTFJobDetail(request *restful.Request, res
 
 	// Get associated pods
 	pods, err := apiHandler.cManager.ClientSet.CoreV1().Pods(namespace).List(metav1.ListOptions{
-		LabelSelector: fmt.Sprintf("group-name=kubeflow.org,job-name=%s", name),
+		LabelSelector: fmt.Sprintf("group-name=kubeflow.org,job-name=%s,controller-name=tf-operator", name),
 	})
 	if err != nil {
 		log.Warningf("failed to list pods for TFJob %v under namespace %v: %v", name, namespace, err)

diff --git a/pkg/apis/common/v1/types.go b/pkg/apis/common/v1/types.go
@@ -14,7 +14,7 @@
 package v1
 
 import (
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 

diff --git a/pkg/apis/common/v1beta2/types.go b/pkg/apis/common/v1beta2/types.go
@@ -14,7 +14,7 @@
 package v1beta2
 
 import (
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 

diff --git a/pkg/apis/tensorflow/v1/defaults.go b/pkg/apis/tensorflow/v1/defaults.go
@@ -18,7 +18,7 @@ import (
 	"strings"
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 )
 

diff --git a/pkg/apis/tensorflow/v1/defaults_test.go b/pkg/apis/tensorflow/v1/defaults_test.go
@@ -18,7 +18,7 @@ import (
 	"reflect"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1"
 	"github.com/kubeflow/tf-operator/pkg/util"

diff --git a/pkg/apis/tensorflow/v1beta2/defaults.go b/pkg/apis/tensorflow/v1beta2/defaults.go
@@ -18,7 +18,7 @@ import (
 	"strings"
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 )
 

diff --git a/pkg/apis/tensorflow/v1beta2/defaults_test.go b/pkg/apis/tensorflow/v1beta2/defaults_test.go
@@ -18,7 +18,7 @@ import (
 	"reflect"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2"
 	"github.com/kubeflow/tf-operator/pkg/util"

diff --git a/pkg/apis/tensorflow/validation/validation_test.go b/pkg/apis/tensorflow/validation/validation_test.go
@@ -23,7 +23,7 @@ import (
 	tfv1 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1"
 	tfv1beta2 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1beta2"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 )
 
 func TestValidateBetaTwoTFJobSpec(t *testing.T) {

diff --git a/pkg/common/jobcontroller/jobcontroller.go b/pkg/common/jobcontroller/jobcontroller.go
@@ -8,7 +8,7 @@ import (
 	"github.com/kubernetes-sigs/kube-batch/pkg/apis/scheduling/v1alpha1"
 	kubebatchclient "github.com/kubernetes-sigs/kube-batch/pkg/client/clientset/versioned"
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/api/policy/v1beta1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
@@ -142,6 +142,9 @@ const (
 
 	// JobRoleLabel represents the label key for the job role, e.g. the value is master
 	JobRoleLabel = "job-role"
+
+	// ControllerNameLabel represents the label key for the job controller name
+	ControllerNameLabel = "controller-name"
 )
 
 func NewJobController(
@@ -208,10 +211,12 @@ func (jc *JobController) GenLabels(jobName string) map[string]string {
 	// deprecatedLabel is kept for backward compatibility. Has to be removed later
 	deprecatedLabelJobName := jc.Controller.GetJobNameLabelKey()
 	groupName := jc.Controller.GetGroupNameLabelValue()
+	controllerName := jc.Controller.ControllerName()
 	return map[string]string{
 		labelGroupName:         groupName,
 		JobNameLabel:           strings.Replace(jobName, "/", "-", -1),
 		deprecatedLabelJobName: strings.Replace(jobName, "/", "-", -1),
+		ControllerNameLabel:    controllerName,
 	}
 }
 
@@ -265,7 +270,8 @@ func (jc *JobController) SyncPdb(job metav1.Object, minAvailableReplicas int32)
 			MinAvailable: &minAvailable,
 			Selector: &metav1.LabelSelector{
 				MatchLabels: map[string]string{
-					JobNameLabel: job.GetName(),
+					JobNameLabel:        job.GetName(),
+					ControllerNameLabel: jc.Controller.ControllerName(),
 				},
 			},
 		},

diff --git a/pkg/common/jobcontroller/pod.go b/pkg/common/jobcontroller/pod.go
@@ -6,7 +6,7 @@ import (
 	"strconv"
 
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"

diff --git a/pkg/common/jobcontroller/service.go b/pkg/common/jobcontroller/service.go
@@ -5,7 +5,7 @@ import (
 	"strconv"
 
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/kubernetes/pkg/controller"

diff --git a/pkg/common/util/v1/testutil/pod.go b/pkg/common/util/v1/testutil/pod.go
@@ -18,7 +18,7 @@ import (
 	"fmt"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/tools/cache"
 

diff --git a/pkg/common/util/v1/testutil/service.go b/pkg/common/util/v1/testutil/service.go
@@ -18,7 +18,7 @@ import (
 	"fmt"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/tools/cache"
 

diff --git a/pkg/common/util/v1/testutil/tfjob.go b/pkg/common/util/v1/testutil/tfjob.go
@@ -17,7 +17,7 @@ package testutil
 import (
 	"time"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1"

diff --git a/pkg/common/util/v1/testutil/util.go b/pkg/common/util/v1/testutil/util.go
@@ -21,15 +21,16 @@ import (
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1"
 	tfv1 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/client-go/tools/cache"
 )
 
 const (
-	LabelGroupName = "group-name"
-	JobNameLabel   = "job-name"
+	LabelGroupName      = "group-name"
+	JobNameLabel        = "job-name"
+	ControllerNameLabel = "controller-name"
 	// Deprecated label. Has to be removed later
 	DeprecatedLabelTFJobName = "tf-job-name"
 )
@@ -38,15 +39,17 @@ var (
 	// KeyFunc is the short name to DeletionHandlingMetaNamespaceKeyFunc.
 	// IndexerInformer uses a delta queue, therefore for deletes we have to use this
 	// key function but it should be just fine for non delete events.
-	KeyFunc   = cache.DeletionHandlingMetaNamespaceKeyFunc
-	GroupName = tfv1.GroupName
+	KeyFunc        = cache.DeletionHandlingMetaNamespaceKeyFunc
+	GroupName      = tfv1.GroupName
+	ControllerName = "tf-operator"
 )
 
 func GenLabels(jobName string) map[string]string {
 	return map[string]string{
 		LabelGroupName:           GroupName,
 		JobNameLabel:             strings.Replace(jobName, "/", "-", -1),
 		DeprecatedLabelTFJobName: strings.Replace(jobName, "/", "-", -1),
+		ControllerNameLabel:      ControllerName,
 	}
 }
 

diff --git a/pkg/common/util/v1beta2/testutil/pod.go b/pkg/common/util/v1beta2/testutil/pod.go
@@ -18,7 +18,7 @@ import (
 	"fmt"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/tools/cache"
 

diff --git a/pkg/common/util/v1beta2/testutil/service.go b/pkg/common/util/v1beta2/testutil/service.go
@@ -18,7 +18,7 @@ import (
 	"fmt"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/tools/cache"
 

diff --git a/pkg/common/util/v1beta2/testutil/tfjob.go b/pkg/common/util/v1beta2/testutil/tfjob.go
@@ -17,7 +17,7 @@ package testutil
 import (
 	"time"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2"

diff --git a/pkg/common/util/v1beta2/testutil/util.go b/pkg/common/util/v1beta2/testutil/util.go
@@ -21,7 +21,7 @@ import (
 
 	common "github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2"
 	tfv1beta2 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1beta2"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/client-go/tools/cache"
@@ -31,21 +31,24 @@ const (
 	LabelGroupName           = "group-name"
 	JobNameLabel             = "job-name"
 	DeprecatedLabelTFJobName = "tf-job-name"
+	ControllerNameLabel      = "controller-name"
 )
 
 var (
 	// KeyFunc is the short name to DeletionHandlingMetaNamespaceKeyFunc.
 	// IndexerInformer uses a delta queue, therefore for deletes we have to use this
 	// key function but it should be just fine for non delete events.
-	KeyFunc   = cache.DeletionHandlingMetaNamespaceKeyFunc
-	GroupName = tfv1beta2.GroupName
+	KeyFunc        = cache.DeletionHandlingMetaNamespaceKeyFunc
+	GroupName      = tfv1beta2.GroupName
+	ControllerName = "tf-operator"
 )
 
 func GenLabels(jobName string) map[string]string {
 	return map[string]string{
 		LabelGroupName:           GroupName,
 		JobNameLabel:             strings.Replace(jobName, "/", "-", -1),
 		DeprecatedLabelTFJobName: strings.Replace(jobName, "/", "-", -1),
+		ControllerNameLabel:      ControllerName,
 	}
 }
 

diff --git a/pkg/control/pod_control.go b/pkg/control/pod_control.go
@@ -23,7 +23,7 @@ import (
 	"fmt"
 
 	"github.com/golang/glog"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

diff --git a/pkg/control/pod_control_test.go b/pkg/control/pod_control_test.go
@@ -22,7 +22,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	apiequality "k8s.io/apimachinery/pkg/api/equality"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"

diff --git a/pkg/control/service_control.go b/pkg/control/service_control.go
@@ -19,7 +19,7 @@ import (
 	"sync"
 
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

diff --git a/pkg/control/service_control_test.go b/pkg/control/service_control_test.go
@@ -20,7 +20,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	apiequality "k8s.io/apimachinery/pkg/api/equality"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"

diff --git a/pkg/control/service_ref_manager.go b/pkg/control/service_ref_manager.go
@@ -20,7 +20,7 @@ import (
 	"fmt"
 
 	"github.com/golang/glog"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"

diff --git a/pkg/control/service_ref_manager_test.go b/pkg/control/service_ref_manager_test.go
@@ -18,7 +18,7 @@ import (
 	"reflect"
 	"testing"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 

diff --git a/pkg/controller.v1/tensorflow/controller.go b/pkg/controller.v1/tensorflow/controller.go
@@ -22,7 +22,7 @@ import (
 
 	kubebatchclient "github.com/kubernetes-sigs/kube-batch/pkg/client/clientset/versioned"
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	"k8s.io/apimachinery/pkg/util/wait"

diff --git a/pkg/controller.v1/tensorflow/controller_test.go b/pkg/controller.v1/tensorflow/controller_test.go
@@ -21,7 +21,6 @@ import (
 	"time"
 
 	kubebatchclient "github.com/kubernetes-sigs/kube-batch/pkg/client/clientset/versioned"
-	"k8s.io/api/core/v1"
 	kubeinformers "k8s.io/client-go/informers"
 	kubeclientset "k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
@@ -35,6 +34,7 @@ import (
 	tfjobinformers "github.com/kubeflow/tf-operator/pkg/client/informers/externalversions"
 	"github.com/kubeflow/tf-operator/pkg/common/util/v1/testutil"
 	"github.com/kubeflow/tf-operator/pkg/control"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/api/policy/v1beta1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
@@ -455,7 +455,8 @@ func TestSyncPdb(t *testing.T) {
 					MinAvailable: &minAvailable,
 					Selector: &metav1.LabelSelector{
 						MatchLabels: map[string]string{
-							"job-name": "test-sync-pdb",
+							"job-name":        "test-sync-pdb",
+							"controller-name": "tf-operator",
 						},
 					},
 				},

diff --git a/pkg/controller.v1/tensorflow/job.go b/pkg/controller.v1/tensorflow/job.go
@@ -5,7 +5,7 @@ import (
 	"time"
 
 	log "github.com/sirupsen/logrus"
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	metav1unstructured "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/client-go/kubernetes/scheme"
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,7 @@ import ( @@
     	"flag"
     	"time"
-    	"k8s.io/api/core/v1"
+    	v1 "k8s.io/api/core/v1"
     )
     const DefaultResyncPeriod = 12 * time.Hour
@@ Expand Down @@