From 25d90cdaec71e38165742a0ebe37411bdd2e66e2 Mon Sep 17 00:00:00 2001 From: Anthony Yeh Date: Fri, 24 Feb 2017 13:10:50 -0800 Subject: [PATCH] StatefulSet: Update Lister documentation for ControllerRef. The StatefulSet Listers still use selectors, because this is the behavior expected by callers. This clarifies the meaning of the returned list. Some callers may need to switch to using GetControllerOf() instead, but that is a separate, case-by-case issue. --- .../listers/apps/internalversion/statefulset_expansion.go | 4 +++- pkg/client/listers/apps/v1beta1/statefulset_expansion.go | 4 +++- .../client-go/listers/apps/v1beta1/statefulset_expansion.go | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/pkg/client/listers/apps/internalversion/statefulset_expansion.go b/pkg/client/listers/apps/internalversion/statefulset_expansion.go index 0b58cf6a817..0c54dbb6494 100644 --- a/pkg/client/listers/apps/internalversion/statefulset_expansion.go +++ b/pkg/client/listers/apps/internalversion/statefulset_expansion.go @@ -35,7 +35,9 @@ type StatefulSetListerExpansion interface { // StatefulSetNamespaeLister. type StatefulSetNamespaceListerExpansion interface{} -// GetPodStatefulSets returns a list of StatefulSets managing a pod. Returns an error only if no matching StatefulSets are found. +// GetPodStatefulSets returns a list of StatefulSets that potentially match a pod. +// Only the one specified in the Pod's ControllerRef will actually manage it. +// Returns an error only if no matching StatefulSets are found. func (s *statefulSetLister) GetPodStatefulSets(pod *api.Pod) ([]*apps.StatefulSet, error) { var selector labels.Selector var ps *apps.StatefulSet diff --git a/pkg/client/listers/apps/v1beta1/statefulset_expansion.go b/pkg/client/listers/apps/v1beta1/statefulset_expansion.go index e032ae227f3..2eea9b1015c 100644 --- a/pkg/client/listers/apps/v1beta1/statefulset_expansion.go +++ b/pkg/client/listers/apps/v1beta1/statefulset_expansion.go @@ -35,7 +35,9 @@ type StatefulSetListerExpansion interface { // StatefulSetNamespaeLister. type StatefulSetNamespaceListerExpansion interface{} -// GetPodStatefulSets returns a list of StatefulSets managing a pod. Returns an error only if no matching StatefulSets are found. +// GetPodStatefulSets returns a list of StatefulSets that potentially match a pod. +// Only the one specified in the Pod's ControllerRef will actually manage it. +// Returns an error only if no matching StatefulSets are found. func (s *statefulSetLister) GetPodStatefulSets(pod *v1.Pod) ([]*apps.StatefulSet, error) { var selector labels.Selector var ps *apps.StatefulSet diff --git a/staging/src/k8s.io/client-go/listers/apps/v1beta1/statefulset_expansion.go b/staging/src/k8s.io/client-go/listers/apps/v1beta1/statefulset_expansion.go index d34e894ac35..4473477e219 100644 --- a/staging/src/k8s.io/client-go/listers/apps/v1beta1/statefulset_expansion.go +++ b/staging/src/k8s.io/client-go/listers/apps/v1beta1/statefulset_expansion.go @@ -35,7 +35,9 @@ type StatefulSetListerExpansion interface { // StatefulSetNamespaeLister. type StatefulSetNamespaceListerExpansion interface{} -// GetPodStatefulSets returns a list of StatefulSets managing a pod. Returns an error only if no matching StatefulSets are found. +// GetPodStatefulSets returns a list of StatefulSets that potentially match a pod. +// Only the one specified in the Pod's ControllerRef will actually manage it. +// Returns an error only if no matching StatefulSets are found. func (s *statefulSetLister) GetPodStatefulSets(pod *v1.Pod) ([]*apps.StatefulSet, error) { var selector labels.Selector var ps *apps.StatefulSet