chore: make config getter methods more clear wrt docker daemon/config…

… mounts
srl-labs · May 10, 2024 · 6997be1 · 6997be1
1 parent 4bb4239
commit 6997be1
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/config/manager.go b/config/manager.go
@@ -133,9 +133,11 @@ type Manager interface {
 	GetImagePullCriSockOverride() string
 	// GetImagePullCriKindOverride returns the cri kind override.
 	GetImagePullCriKindOverride() string
-	// GetDockerDaemonConfig returns the secret name to mount in /etc/docker.
+	// GetDockerDaemonConfig returns the secret name to mount in /etc/docker -- the secret *must*
+	// have a key "daemon.json" so the final mounted file is /etc/docker/daemon.json.
 	GetDockerDaemonConfig() string
-	// GetDockerConfig returns the secret name to mount in /root/.docker/.
+	// GetDockerConfig returns the secret name to mount in /root/.docker/ -- the secret *must* have
+	// a key "config.json" so the final mounted file is /root/.docker/config.json.
 	GetDockerConfig() string
 	// GetLauncherImage returns the global default launcher image.
 	GetLauncherImage() string