Add code comment to config Repo setting

rancher · May 9, 2023 · 749395c · 749395c
1 parent 1d27a9b
commit 749395c
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -64,10 +64,13 @@ type Config struct {
 type Bootstrap struct {
 	Namespace      string `json:"namespace,omitempty"`
 	AgentNamespace string `json:"agentNamespace,omitempty"`
-	Repo           string `json:"repo,omitempty"`
-	Secret         string `json:"secret,omitempty"` // gitrepo.ClientSecretName for agent from repo
-	Paths          string `json:"paths,omitempty"`
-	Branch         string `json:"branch,omitempty"`
+	// Repo to add at install time that will deploy to the local cluster. This allows
+	// one to fully bootstrap fleet, its configuration and all its downstream clusters
+	// in one shot.
+	Repo   string `json:"repo,omitempty"`
+	Secret string `json:"secret,omitempty"` // gitrepo.ClientSecretName for agent from repo
+	Paths  string `json:"paths,omitempty"`
+	Branch string `json:"branch,omitempty"`
 }
 
 func OnChange(ctx context.Context, f func(*Config) error) {