From cdded9575d1f3296af3cc8cbbefac184b4fc9c4c Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Tue, 21 Jan 2020 17:10:22 +0100 Subject: [PATCH] Small rephrase of method docblocks --- pkg/chartsync/git.go | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/pkg/chartsync/git.go b/pkg/chartsync/git.go index 794b69234..50e686098 100644 --- a/pkg/chartsync/git.go +++ b/pkg/chartsync/git.go @@ -339,7 +339,10 @@ func mirrorName(hr *v1.HelmRelease) string { return "" } -// addAuthForHTTPS will add basic auth to a git url that uses https and where auth values are supplied +// addAuthForHTTPS will attempt to add basic auth credentials from the +// given secretRef to the given gitURL and return the result, but only +// if the scheme of the URL is HTTPS. In case of a failure it returns +// an error. func (c *GitChartSync) addAuthForHTTPS(gitURL string, secretRef *corev1.LocalObjectReference, namespace string) (string, error) { if secretRef == nil { return gitURL, nil @@ -364,7 +367,10 @@ func (c *GitChartSync) addAuthForHTTPS(gitURL string, secretRef *corev1.LocalObj return modifiedURL.String(), nil } -// getAuthFromSecret will get a username/password from a secret +// getAuthFromSecret resolve the given `secretRef` from the given namespace +// using the core v1 secrets client, and return the username and password. +// If this errors, or the secret does not contain the expected keys, an +// error is returned. func (c *GitChartSync) getAuthFromSecret(secretRef *corev1.LocalObjectReference, ns string) (string, string, error) { secretName := secretRef.Name