From 272327af89c91888837c10cf03bea0fc1f11fc35 Mon Sep 17 00:00:00 2001
From: Jose Diaz-Gonzalez <email@josediazgonzalez.com>
Date: Sat, 19 Jul 2025 00:38:06 -0400
Subject: [PATCH] chore: add docs to the ChartInput type

---
 plugins/scheduler-k3s/helm.go | 34 ++++++++++++++++++++++++++--------
 1 file changed, 26 insertions(+), 8 deletions(-)

diff --git a/plugins/scheduler-k3s/helm.go b/plugins/scheduler-k3s/helm.go
index 0a0310332..f40502778 100644
--- a/plugins/scheduler-k3s/helm.go
+++ b/plugins/scheduler-k3s/helm.go
@@ -51,16 +51,34 @@ var DeployLogPrinter = func(format string, v ...interface{}) {
 	}
 }
 
+// ChartInput is the input for the InstallOrUpgradeChart function
 type ChartInput struct {
-	ChartPath         string
-	Namespace         string
-	ReleaseName       string
-	RepoURL           string
+	// ChartPath is the path to the chart to install or upgrade
+	ChartPath string
+
+	// Namespace is the namespace to install or upgrade the chart in
+	Namespace string
+
+	// ReleaseName is the name of the release to install or upgrade
+	ReleaseName string
+
+	// RepoURL is the URL of the chart repository to install or upgrade the chart from
+	RepoURL string
+
+	// RollbackOnFailure is whether to rollback on failure
 	RollbackOnFailure bool
-	Timeout           time.Duration
-	Wait              bool
-	Version           string
-	Values            map[string]interface{}
+
+	// Timeout is the timeout for the install or upgrade
+	Timeout time.Duration
+
+	// Wait is whether to wait for the install or upgrade to complete
+	Wait bool
+
+	// Version is the version of the chart to install or upgrade
+	Version string
+
+	// Values is the values to pass to the chart
+	Values map[string]interface{}
 }
 
 type Release struct {