DaemonSet: Update Lister documentation for ControllerRef.

The DaemonSet 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.
pull/6/head
Anthony Yeh 2017-02-25 17:34:50 -08:00
parent 1099811833
commit c288f52d2f
3 changed files with 9 additions and 6 deletions

View File

@ -35,8 +35,9 @@ type DaemonSetListerExpansion interface {
// DaemonSetNamespaeLister.
type DaemonSetNamespaceListerExpansion interface{}
// GetPodDaemonSets returns a list of daemon sets managing a pod.
// Returns an error if and only if no matching daemon sets are found.
// GetPodDaemonSets returns a list of DaemonSets 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 DaemonSets are found.
func (s *daemonSetLister) GetPodDaemonSets(pod *api.Pod) ([]*extensions.DaemonSet, error) {
var selector labels.Selector
var daemonSet *extensions.DaemonSet

View File

@ -35,8 +35,9 @@ type DaemonSetListerExpansion interface {
// DaemonSetNamespaeLister.
type DaemonSetNamespaceListerExpansion interface{}
// GetPodDaemonSets returns a list of daemon sets managing a pod.
// Returns an error if and only if no matching daemon sets are found.
// GetPodDaemonSets returns a list of DaemonSets 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 DaemonSets are found.
func (s *daemonSetLister) GetPodDaemonSets(pod *v1.Pod) ([]*v1beta1.DaemonSet, error) {
var selector labels.Selector
var daemonSet *v1beta1.DaemonSet

View File

@ -35,8 +35,9 @@ type DaemonSetListerExpansion interface {
// DaemonSetNamespaeLister.
type DaemonSetNamespaceListerExpansion interface{}
// GetPodDaemonSets returns a list of daemon sets managing a pod.
// Returns an error if and only if no matching daemon sets are found.
// GetPodDaemonSets returns a list of DaemonSets 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 DaemonSets are found.
func (s *daemonSetLister) GetPodDaemonSets(pod *v1.Pod) ([]*v1beta1.DaemonSet, error) {
var selector labels.Selector
var daemonSet *v1beta1.DaemonSet