Add doc comment to removeCustomResources

hashicorp · Nov 1, 2022 · 63aaf5b · 63aaf5b
1 parent 2073acd
commit 63aaf5b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/cli/cmd/uninstall/uninstall.go b/cli/cmd/uninstall/uninstall.go
@@ -395,6 +395,10 @@ func (c *Command) uninstallHelmRelease(releaseName, namespace, releaseType strin
 	return nil
 }
 
+// removeCustomResources fetches a list of custom resource defintions managed
+// by Consul and attempts to delete every custom resource for each definition.
+// If the resources cannot be deleted directly, the finalizers on each resource
+// are patched to be an empty list, freeing them to be deleted by Kubernetes.
 func (c *Command) removeCustomResources(uiLogger action.DebugLog) error {
 	uiLogger("Deleting custom resources managed by Consul")