more docs.

Author: guettli

.gitignore

@@ -8,4 +8,3 @@ hcloud-cloud-controller-manager
 *.tgz
 hack/.*
 coverage/
-.vscode

hcloud/runtime_credentials.go

@@ -49,7 +49,7 @@ func newRuntimeCredentials() (*runtimeCredentials, error) {
 	credentials.robotUserPath = files.RobotUser
 	credentials.robotPassPath = files.RobotPassword
 
-	if !files.HasAny() {
+	if !files.HasAnyFilePaths() {
 		return credentials, nil
 	}
 
@@ -115,6 +115,7 @@ func (c *runtimeCredentials) watch() {
 		select {
 		case event, ok := <-c.watcher.Events:
 			if !ok {
+				// !ok means the watcher closed the events channel.
 				return
 			}
 			if !shouldReload(event) {
@@ -129,6 +130,7 @@ func (c *runtimeCredentials) watch() {
 			debounceTimer.Reset(credentialsReloadDebounce)
 		case err, ok := <-c.watcher.Errors:
 			if !ok {
+				// !ok means the watcher closed the errors channel.
 				return
 			}
 			klog.ErrorS(err, "watching mounted credential files")

internal/config/runtime_credentials.go

@@ -10,16 +10,22 @@ import (
 	"github.com/hetznercloud/hcloud-go/v2/hcloud/exp/kit/envutil"
 )
 
+// RuntimeCredentialFiles contains file-backed credential sources that can be
+// watched for runtime reloads.
 type RuntimeCredentialFiles struct {
 	HCloudToken   string
 	RobotUser     string
 	RobotPassword string
 }
 
-func (f RuntimeCredentialFiles) HasAny() bool {
+// HasAnyFilePaths reports whether any runtime credential file path is
+// configured.
+func (f RuntimeCredentialFiles) HasAnyFilePaths() bool {
 	return f.HCloudToken != "" || f.RobotUser != "" || f.RobotPassword != ""
 }
 
+// Directories returns the unique parent directories of the configured
+// credential files.
 func (f RuntimeCredentialFiles) Directories() []string {
 	return uniqueDirectories(f.HCloudToken, f.RobotUser, f.RobotPassword)
 }

internal/config/runtime_credentials_test.go

@@ -12,7 +12,7 @@ import (
 
 func TestRuntimeCredentialFilesHelpers(t *testing.T) {
 	files := RuntimeCredentialFiles{}
-	assert.False(t, files.HasAny())
+	assert.False(t, files.HasAnyFilePaths())
 	assert.Empty(t, files.Directories())
 
 	files = RuntimeCredentialFiles{
@@ -21,7 +21,7 @@ func TestRuntimeCredentialFilesHelpers(t *testing.T) {
 		RobotPassword: "/tmp/two/password",
 	}
 
-	assert.True(t, files.HasAny())
+	assert.True(t, files.HasAnyFilePaths())
 	assert.ElementsMatch(t, []string{"/tmp/one", "/tmp/two"}, files.Directories())
 }