add finalizer logics to the API server and the garbage collector; han…

…dling DeleteOptions.OrphanDependents in the API server
kubernetes · May 24, 2016 · 1665546 · 1665546
1 parent 5303794
commit 1665546
Show file tree

Hide file tree

Showing 20 changed files with 1,038 additions and 124 deletions.
diff --git a/cmd/kube-apiserver/app/options/options.go b/cmd/kube-apiserver/app/options/options.go
@@ -24,6 +24,7 @@ import (
 	genericoptions "k8s.io/kubernetes/pkg/genericapiserver/options"
 	kubeletclient "k8s.io/kubernetes/pkg/kubelet/client"
 	"k8s.io/kubernetes/pkg/master/ports"
+	"k8s.io/kubernetes/pkg/registry/generic/registry"
 
 	"github.com/spf13/pflag"
 )
@@ -83,4 +84,5 @@ func (s *APIServer) AddFlags(fs *pflag.FlagSet) {
 	fs.StringVar(&s.KubeletConfig.CAFile, "kubelet-certificate-authority", s.KubeletConfig.CAFile, "Path to a cert. file for the certificate authority.")
 	// TODO: delete this flag as soon as we identify and fix all clients that send malformed updates, like #14126.
 	fs.BoolVar(&validation.RepairMalformedUpdates, "repair-malformed-updates", validation.RepairMalformedUpdates, "If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates.")
+	fs.BoolVar(&registry.EnableGarbageCollector, "enable-garbage-collector", false, "Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.")
 }
diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md
@@ -72,6 +72,7 @@ kube-apiserver
       --cors-allowed-origins=[]: List of allowed origins for CORS, comma separated.  An allowed origin can be a regular expression to support subdomain matching.  If this list is empty CORS will not be enabled.
       --delete-collection-workers=1: Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.
       --deserialization-cache-size=50000: Number of deserialized json objects to cache in memory.
+      --enable-garbage-collector[=false]: Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.
       --enable-swagger-ui[=false]: Enables swagger ui on the apiserver at /swagger-ui
       --etcd-cafile="": SSL Certificate Authority file used to secure etcd communication
       --etcd-certfile="": SSL certification file used to secure etcd communication
@@ -123,7 +124,7 @@ kube-apiserver
       --watch-cache-sizes=[]: List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled.
 ```
 
-###### Auto generated by spf13/cobra on 18-May-2016
+###### Auto generated by spf13/cobra on 23-May-2016
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

diff --git a/hack/verify-flags/known-flags.txt b/hack/verify-flags/known-flags.txt
@@ -109,6 +109,7 @@ enable-debugging-handlers
 enable-hostpath-provisioner
 enable-server
 enable-swagger-ui
+enable-garbage-collector
 etcd-cafile
 etcd-certfile
 etcd-config

diff --git a/pkg/api/helpers.go b/pkg/api/helpers.go
@@ -225,7 +225,9 @@ func IsServiceIPRequested(service *Service) bool {
 }
 
 var standardFinalizers = sets.NewString(
-	string(FinalizerKubernetes))
+	string(FinalizerKubernetes),
+	FinalizerOrphan,
+)
 
 func IsStandardFinalizerName(str string) bool {
 	return standardFinalizers.Has(str)

diff --git a/pkg/api/meta.go b/pkg/api/meta.go
@@ -90,6 +90,8 @@ func (meta *ObjectMeta) GetLabels() map[string]string                 { return m
 func (meta *ObjectMeta) SetLabels(labels map[string]string)           { meta.Labels = labels }
 func (meta *ObjectMeta) GetAnnotations() map[string]string            { return meta.Annotations }
 func (meta *ObjectMeta) SetAnnotations(annotations map[string]string) { meta.Annotations = annotations }
+func (meta *ObjectMeta) GetFinalizers() []string                      { return meta.Finalizers }
+func (meta *ObjectMeta) SetFinalizers(finalizers []string)            { meta.Finalizers = finalizers }
 
 func (meta *ObjectMeta) GetOwnerReferences() []metatypes.OwnerReference {
 	ret := make([]metatypes.OwnerReference, len(meta.OwnerReferences))

diff --git a/pkg/api/meta/interfaces.go b/pkg/api/meta/interfaces.go
@@ -58,6 +58,8 @@ type Object interface {
 	SetLabels(labels map[string]string)
 	GetAnnotations() map[string]string
 	SetAnnotations(annotations map[string]string)
+	GetFinalizers() []string
+	SetFinalizers(finalizers []string)
 	GetOwnerReferences() []metatypes.OwnerReference
 	SetOwnerReferences([]metatypes.OwnerReference)
 }

diff --git a/pkg/api/meta/meta.go b/pkg/api/meta/meta.go
@@ -395,6 +395,7 @@ type genericAccessor struct {
 	labels            *map[string]string
 	annotations       *map[string]string
 	ownerReferences   reflect.Value
+	finalizers        *[]string
 }
 
 func (a genericAccessor) GetNamespace() string {
@@ -527,6 +528,17 @@ func (a genericAccessor) SetAnnotations(annotations map[string]string) {
 	*a.annotations = annotations
 }
 
+func (a genericAccessor) GetFinalizers() []string {
+	if a.finalizers == nil {
+		return nil
+	}
+	return *a.finalizers
+}
+
+func (a genericAccessor) SetFinalizers(finalizers []string) {
+	*a.finalizers = finalizers
+}
+
 func (a genericAccessor) GetOwnerReferences() []metatypes.OwnerReference {
 	var ret []metatypes.OwnerReference
 	s := a.ownerReferences
@@ -599,6 +611,9 @@ func extractFromObjectMeta(v reflect.Value, a *genericAccessor) error {
 	if err := runtime.FieldPtr(v, "Annotations", &a.annotations); err != nil {
 		return err
 	}
+	if err := runtime.FieldPtr(v, "Finalizers", &a.finalizers); err != nil {
+		return err
+	}
 	ownerReferences := v.FieldByName("OwnerReferences")
 	if !ownerReferences.IsValid() {
 		return fmt.Errorf("struct %#v lacks OwnerReferences type", v)

diff --git a/pkg/api/meta/meta_test.go b/pkg/api/meta/meta_test.go
@@ -43,6 +43,10 @@ func TestAPIObjectMeta(t *testing.T) {
 			SelfLink:        "some/place/only/we/know",
 			Labels:          map[string]string{"foo": "bar"},
 			Annotations:     map[string]string{"x": "y"},
+			Finalizers: []string{
+				"finalizer.1",
+				"finalizer.2",
+			},
 		},
 	}
 	var _ meta.Object = &j.ObjectMeta
@@ -72,6 +76,9 @@ func TestAPIObjectMeta(t *testing.T) {
 	if e, a := "some/place/only/we/know", accessor.GetSelfLink(); e != a {
 		t.Errorf("expected %v, got %v", e, a)
 	}
+	if e, a := []string{"finalizer.1", "finalizer.2"}, accessor.GetFinalizers(); !reflect.DeepEqual(e, a) {
+		t.Errorf("expected %v, got %v", e, a)
+	}
 
 	typeAccessor, err := meta.TypeAccessor(j)
 	if err != nil {
@@ -92,6 +99,7 @@ func TestAPIObjectMeta(t *testing.T) {
 	typeAccessor.SetKind("d")
 	accessor.SetResourceVersion("2")
 	accessor.SetSelfLink("google.com")
+	accessor.SetFinalizers([]string{"finalizer.3"})
 
 	// Prove that accessor changes the original object.
 	if e, a := "baz", j.Namespace; e != a {
@@ -118,6 +126,9 @@ func TestAPIObjectMeta(t *testing.T) {
 	if e, a := "google.com", j.SelfLink; e != a {
 		t.Errorf("expected %v, got %v", e, a)
 	}
+	if e, a := []string{"finalizer.3"}, j.Finalizers; !reflect.DeepEqual(e, a) {
+		t.Errorf("expected %v, got %v", e, a)
+	}
 
 	typeAccessor.SetAPIVersion("d")
 	typeAccessor.SetKind("e")
@@ -143,6 +154,7 @@ func TestGenericTypeMeta(t *testing.T) {
 		Labels            map[string]string    `json:"labels,omitempty"`
 		Annotations       map[string]string    `json:"annotations,omitempty"`
 		OwnerReferences   []api.OwnerReference `json:"ownerReferences,omitempty"`
+		Finalizers        []string             `json:"finalizers,omitempty"`
 	}
 	type Object struct {
 		TypeMeta `json:",inline"`
@@ -159,6 +171,7 @@ func TestGenericTypeMeta(t *testing.T) {
 			SelfLink:        "some/place/only/we/know",
 			Labels:          map[string]string{"foo": "bar"},
 			Annotations:     map[string]string{"x": "y"},
+			Finalizers:      []string{"finalizer.1", "finalizer.2"},
 		},
 	}
 	accessor, err := meta.Accessor(&j)
@@ -183,6 +196,9 @@ func TestGenericTypeMeta(t *testing.T) {
 	if e, a := "some/place/only/we/know", accessor.GetSelfLink(); e != a {
 		t.Errorf("expected %v, got %v", e, a)
 	}
+	if e, a := []string{"finalizer.1", "finalizer.2"}, accessor.GetFinalizers(); !reflect.DeepEqual(e, a) {
+		t.Errorf("expected %v, got %v", e, a)
+	}
 
 	typeAccessor, err := meta.TypeAccessor(&j)
 	if err != nil {
@@ -203,6 +219,7 @@ func TestGenericTypeMeta(t *testing.T) {
 	typeAccessor.SetKind("d")
 	accessor.SetResourceVersion("2")
 	accessor.SetSelfLink("google.com")
+	accessor.SetFinalizers([]string{"finalizer.3"})
 
 	// Prove that accessor changes the original object.
 	if e, a := "baz", j.Namespace; e != a {
@@ -229,6 +246,9 @@ func TestGenericTypeMeta(t *testing.T) {
 	if e, a := "google.com", j.SelfLink; e != a {
 		t.Errorf("expected %v, got %v", e, a)
 	}
+	if e, a := []string{"finalizer.3"}, j.Finalizers; !reflect.DeepEqual(e, a) {
+		t.Errorf("expected %v, got %v", e, a)
+	}
 
 	typeAccessor.SetAPIVersion("d")
 	typeAccessor.SetKind("e")
@@ -252,6 +272,7 @@ type InternalTypeMeta struct {
 	APIVersion        string               `json:"apiVersion,omitempty"`
 	Labels            map[string]string    `json:"labels,omitempty"`
 	Annotations       map[string]string    `json:"annotations,omitempty"`
+	Finalizers        []string             `json:"finalizers,omitempty"`
 	OwnerReferences   []api.OwnerReference `json:"ownerReferences,omitempty"`
 }
 
@@ -435,6 +456,7 @@ func TestGenericObjectMeta(t *testing.T) {
 		ResourceVersion   string               `json:"resourceVersion,omitempty"`
 		Labels            map[string]string    `json:"labels,omitempty"`
 		Annotations       map[string]string    `json:"annotations,omitempty"`
+		Finalizers        []string             `json:"finalizers,omitempty"`
 		OwnerReferences   []api.OwnerReference `json:"ownerReferences,omitempty"`
 	}
 	type Object struct {
@@ -455,6 +477,10 @@ func TestGenericObjectMeta(t *testing.T) {
 			SelfLink:        "some/place/only/we/know",
 			Labels:          map[string]string{"foo": "bar"},
 			Annotations:     map[string]string{"a": "b"},
+			Finalizers: []string{
+				"finalizer.1",
+				"finalizer.2",
+			},
 		},
 	}
 	accessor, err := meta.Accessor(&j)
@@ -485,6 +511,9 @@ func TestGenericObjectMeta(t *testing.T) {
 	if e, a := 1, len(accessor.GetAnnotations()); e != a {
 		t.Errorf("expected %v, got %v", e, a)
 	}
+	if e, a := []string{"finalizer.1", "finalizer.2"}, accessor.GetFinalizers(); !reflect.DeepEqual(e, a) {
+		t.Errorf("expected %v, got %v", e, a)
+	}
 
 	typeAccessor, err := meta.TypeAccessor(&j)
 	if err != nil {
@@ -507,6 +536,7 @@ func TestGenericObjectMeta(t *testing.T) {
 	accessor.SetSelfLink("google.com")
 	accessor.SetLabels(map[string]string{"other": "label"})
 	accessor.SetAnnotations(map[string]string{"c": "d"})
+	accessor.SetFinalizers([]string{"finalizer.3"})
 
 	// Prove that accessor changes the original object.
 	if e, a := "baz", j.Namespace; e != a {
@@ -539,6 +569,9 @@ func TestGenericObjectMeta(t *testing.T) {
 	if e, a := map[string]string{"c": "d"}, j.Annotations; !reflect.DeepEqual(e, a) {
 		t.Errorf("expected %#v, got %#v", e, a)
 	}
+	if e, a := []string{"finalizer.3"}, j.Finalizers; !reflect.DeepEqual(e, a) {
+		t.Errorf("expected %v, got %v", e, a)
+	}
 }
 
 func TestGenericListMeta(t *testing.T) {

diff --git a/pkg/api/types.go b/pkg/api/types.go
@@ -2084,6 +2084,7 @@ type FinalizerName string
 // These are internal finalizer values to Kubernetes, must be qualified name unless defined here
 const (
 	FinalizerKubernetes FinalizerName = "kubernetes"
+	FinalizerOrphan     string        = "orphan"
 )
 
 // NamespaceStatus is information about the current status of a Namespace.

diff --git a/pkg/api/validation/validation.go b/pkg/api/validation/validation.go
@@ -323,7 +323,9 @@ func ValidateObjectMeta(meta *api.ObjectMeta, requiresNamespace bool, nameFn Val
 	allErrs = append(allErrs, unversionedvalidation.ValidateLabels(meta.Labels, fldPath.Child("labels"))...)
 	allErrs = append(allErrs, ValidateAnnotations(meta.Annotations, fldPath.Child("annotations"))...)
 	allErrs = append(allErrs, ValidateOwnerReferences(meta.OwnerReferences, fldPath.Child("ownerReferences"))...)
-
+	for _, finalizer := range meta.Finalizers {
+		allErrs = append(allErrs, validateFinalizerName(finalizer, fldPath.Child("finalizers"))...)
+	}
 	return allErrs
 }
 
@@ -373,7 +375,6 @@ func ValidateObjectMetaUpdate(newMeta, oldMeta *api.ObjectMeta, fldPath *field.P
 	allErrs = append(allErrs, ValidateImmutableField(newMeta.Namespace, oldMeta.Namespace, fldPath.Child("namespace"))...)
 	allErrs = append(allErrs, ValidateImmutableField(newMeta.UID, oldMeta.UID, fldPath.Child("uid"))...)
 	allErrs = append(allErrs, ValidateImmutableField(newMeta.CreationTimestamp, oldMeta.CreationTimestamp, fldPath.Child("creationTimestamp"))...)
-	allErrs = append(allErrs, ValidateImmutableField(newMeta.Finalizers, oldMeta.Finalizers, fldPath.Child("finalizers"))...)
 
 	allErrs = append(allErrs, unversionedvalidation.ValidateLabels(newMeta.Labels, fldPath.Child("labels"))...)
 	allErrs = append(allErrs, ValidateAnnotations(newMeta.Annotations, fldPath.Child("annotations"))...)

diff --git a/pkg/api/validation/validation_test.go b/pkg/api/validation/validation_test.go
@@ -267,21 +267,6 @@ func TestValidateObjectMetaTrimsTrailingSlash(t *testing.T) {
 	}
 }
 
-// Ensure updating finalizers is disallowed
-func TestValidateObjectMetaUpdateDisallowsUpdatingFinalizers(t *testing.T) {
-	errs := ValidateObjectMetaUpdate(
-		&api.ObjectMeta{Name: "test", ResourceVersion: "1", Finalizers: []string{"orphaning"}},
-		&api.ObjectMeta{Name: "test", ResourceVersion: "1"},
-		field.NewPath("field"),
-	)
-	if len(errs) != 1 {
-		t.Fatalf("unexpected errors: %v", errs)
-	}
-	if !strings.Contains(errs[0].Error(), "field is immutable") {
-		t.Errorf("unexpected error message: %v", errs)
-	}
-}
-
 func TestValidateAnnotations(t *testing.T) {
 	successCases := []map[string]string{
 		{"simple": "bar"},

diff --git a/pkg/client/cache/delta_fifo.go b/pkg/client/cache/delta_fifo.go
@@ -84,7 +84,7 @@ func NewDeltaFIFO(keyFunc KeyFunc, compressor DeltaCompressor, knownObjects KeyL
 // A note on the KeyLister used by the DeltaFIFO: It's main purpose is
 // to list keys that are "known", for the purpose of figuring out which
 // items have been deleted when Replace() or Delete() are called. The deleted
-// objet will be included in the DeleteFinalStateUnknown markers. These objects
+// object will be included in the DeleteFinalStateUnknown markers. These objects
 // could be stale.
 //
 // You may provide a function to compress deltas (e.g., represent a