From a5e766ba6a239a91f7c71b27717cb6edf2d6c209 Mon Sep 17 00:00:00 2001 From: Anthony Yeh Date: Sun, 26 Feb 2017 16:28:40 -0800 Subject: [PATCH] Deployment: Update Lister documentation for ControllerRef. The Deployment 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. Kubernetes-commit: 57fb5e2bba0b55053973398fd8abb3371379c64f --- listers/extensions/v1beta1/deployment_expansion.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/listers/extensions/v1beta1/deployment_expansion.go b/listers/extensions/v1beta1/deployment_expansion.go index 276aed7a..c3ba9990 100644 --- a/listers/extensions/v1beta1/deployment_expansion.go +++ b/listers/extensions/v1beta1/deployment_expansion.go @@ -34,7 +34,10 @@ type DeploymentListerExpansion interface { // DeploymentNamespaeLister. type DeploymentNamespaceListerExpansion interface{} -// GetDeploymentsForReplicaSet returns a list of deployments managing a replica set. Returns an error only if no matching deployments are found. +// GetDeploymentsForReplicaSet returns a list of Deployments that potentially +// match a ReplicaSet. Only the one specified in the ReplicaSet's ControllerRef +// will actually manage it. +// Returns an error only if no matching Deployments are found. func (s *deploymentLister) GetDeploymentsForReplicaSet(rs *extensions.ReplicaSet) ([]*extensions.Deployment, error) { if len(rs.Labels) == 0 { return nil, fmt.Errorf("no deployments found for ReplicaSet %v because it has no labels", rs.Name)