Sets the flux cli suspend command --reason flag to an empty string

haggishunk · haggishunk · commit 0ba9db560bff · 2023-09-13T11:01:06.000-07:00
as default and changes the flux resource suspend behavior to only apply
the suspend reason annotation when a non-empty reason is provided.

Signed-off-by: Travis Mattera &lt;travis@mattera.io&gt;
diff --git a/cmd/flux/suspend.go b/cmd/flux/suspend.go
@@ -43,7 +43,7 @@ var suspendArgs SuspendFlags
 func init() {
 	suspendCmd.PersistentFlags().BoolVarP(&suspendArgs.all, "all", "", false,
 		"suspend all resources in that namespace")
-	suspendCmd.PersistentFlags().StringVarP(&suspendArgs.reason, "reason", "r", "suspended",
+	suspendCmd.PersistentFlags().StringVarP(&suspendArgs.reason, "reason", "r", "",
 		"set a reason for why the resource is suspended, the reason will show up under the suspend.toolkit.fluxcd.io/reason annotation")
 	rootCmd.AddCommand(suspendCmd)
 }
diff --git a/cmd/flux/suspend_alert.go b/cmd/flux/suspend_alert.go
@@ -49,7 +49,9 @@ func (obj alertAdapter) isSuspended() bool {
 
 func (obj alertAdapter) setSuspended(reason string) {
 	obj.Alert.Spec.Suspend = true
-	obj.Alert.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.Alert.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a alertListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_helmrelease.go b/cmd/flux/suspend_helmrelease.go
@@ -50,7 +50,9 @@ func (obj helmReleaseAdapter) isSuspended() bool {
 
 func (obj helmReleaseAdapter) setSuspended(reason string) {
 	obj.HelmRelease.Spec.Suspend = true
-	obj.HelmRelease.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.HelmRelease.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a helmReleaseListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_image_repository.go b/cmd/flux/suspend_image_repository.go
@@ -49,7 +49,9 @@ func (obj imageRepositoryAdapter) isSuspended() bool {
 
 func (obj imageRepositoryAdapter) setSuspended(reason string) {
 	obj.ImageRepository.Spec.Suspend = true
-	obj.ImageRepository.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.ImageRepository.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a imageRepositoryListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_image_updateauto.go b/cmd/flux/suspend_image_updateauto.go
@@ -49,7 +49,9 @@ func (update imageUpdateAutomationAdapter) isSuspended() bool {
 
 func (update imageUpdateAutomationAdapter) setSuspended(reason string) {
 	update.ImageUpdateAutomation.Spec.Suspend = true
-	update.ImageUpdateAutomation.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		update.ImageUpdateAutomation.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a imageUpdateAutomationListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_kustomization.go b/cmd/flux/suspend_kustomization.go
@@ -50,7 +50,9 @@ func (obj kustomizationAdapter) isSuspended() bool {
 
 func (obj kustomizationAdapter) setSuspended(reason string) {
 	obj.Kustomization.Spec.Suspend = true
-	obj.Kustomization.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.Kustomization.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a kustomizationListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_receiver.go b/cmd/flux/suspend_receiver.go
@@ -49,7 +49,9 @@ func (obj receiverAdapter) isSuspended() bool {
 
 func (obj receiverAdapter) setSuspended(reason string) {
 	obj.Receiver.Spec.Suspend = true
-	obj.Receiver.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.Receiver.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a receiverListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_source_bucket.go b/cmd/flux/suspend_source_bucket.go
@@ -49,7 +49,9 @@ func (obj bucketAdapter) isSuspended() bool {
 
 func (obj bucketAdapter) setSuspended(reason string) {
 	obj.Bucket.Spec.Suspend = true
-	obj.Bucket.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.Bucket.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a bucketListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_source_chart.go b/cmd/flux/suspend_source_chart.go
@@ -49,7 +49,9 @@ func (obj helmChartAdapter) isSuspended() bool {
 
 func (obj helmChartAdapter) setSuspended(reason string) {
 	obj.HelmChart.Spec.Suspend = true
-	obj.HelmChart.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.HelmChart.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a helmChartListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_source_git.go b/cmd/flux/suspend_source_git.go
@@ -49,7 +49,9 @@ func (obj gitRepositoryAdapter) isSuspended() bool {
 
 func (obj gitRepositoryAdapter) setSuspended(reason string) {
 	obj.GitRepository.Spec.Suspend = true
-	obj.GitRepository.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.GitRepository.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a gitRepositoryListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_source_helm.go b/cmd/flux/suspend_source_helm.go
@@ -49,7 +49,9 @@ func (obj helmRepositoryAdapter) isSuspended() bool {
 
 func (obj helmRepositoryAdapter) setSuspended(reason string) {
 	obj.HelmRepository.Spec.Suspend = true
-	obj.HelmRepository.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.HelmRepository.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a helmRepositoryListAdapter) item(i int) suspendable {
diff --git a/cmd/flux/suspend_source_oci.go b/cmd/flux/suspend_source_oci.go
@@ -49,7 +49,9 @@ func (obj ociRepositoryAdapter) isSuspended() bool {
 
 func (obj ociRepositoryAdapter) setSuspended(reason string) {
 	obj.OCIRepository.Spec.Suspend = true
-	obj.OCIRepository.Annotations[SuspendReasonAnnotation] = reason
+	if reason != "" {
+		obj.OCIRepository.Annotations[SuspendReasonAnnotation] = reason
+	}
 }
 
 func (a ociRepositoryListAdapter) item(i int) suspendable {

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ var suspendArgs SuspendFlags`
`43`	`43`	`func init() {`
`44`	`44`	`suspendCmd.PersistentFlags().BoolVarP(&suspendArgs.all, "all", "", false,`
`45`	`45`	`"suspend all resources in that namespace")`
`46`		`- suspendCmd.PersistentFlags().StringVarP(&suspendArgs.reason, "reason", "r", "suspended",`
	`46`	`+ suspendCmd.PersistentFlags().StringVarP(&suspendArgs.reason, "reason", "r", "",`
`47`	`47`	`"set a reason for why the resource is suspended, the reason will show up under the suspend.toolkit.fluxcd.io/reason annotation")`
`48`	`48`	`rootCmd.AddCommand(suspendCmd)`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (obj alertAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (obj alertAdapter) setSuspended(reason string) {`
`51`	`51`	`obj.Alert.Spec.Suspend = true`
`52`		`- obj.Alert.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ obj.Alert.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a alertListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,9 @@ func (obj helmReleaseAdapter) isSuspended() bool {`
`50`	`50`
`51`	`51`	`func (obj helmReleaseAdapter) setSuspended(reason string) {`
`52`	`52`	`obj.HelmRelease.Spec.Suspend = true`
`53`		`- obj.HelmRelease.Annotations[SuspendReasonAnnotation] = reason`
	`53`	`+ if reason != "" {`
	`54`	`+ obj.HelmRelease.Annotations[SuspendReasonAnnotation] = reason`
	`55`	`+ }`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`func (a helmReleaseListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (obj imageRepositoryAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (obj imageRepositoryAdapter) setSuspended(reason string) {`
`51`	`51`	`obj.ImageRepository.Spec.Suspend = true`
`52`		`- obj.ImageRepository.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ obj.ImageRepository.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a imageRepositoryListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (update imageUpdateAutomationAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (update imageUpdateAutomationAdapter) setSuspended(reason string) {`
`51`	`51`	`update.ImageUpdateAutomation.Spec.Suspend = true`
`52`		`- update.ImageUpdateAutomation.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ update.ImageUpdateAutomation.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a imageUpdateAutomationListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,9 @@ func (obj kustomizationAdapter) isSuspended() bool {`
`50`	`50`
`51`	`51`	`func (obj kustomizationAdapter) setSuspended(reason string) {`
`52`	`52`	`obj.Kustomization.Spec.Suspend = true`
`53`		`- obj.Kustomization.Annotations[SuspendReasonAnnotation] = reason`
	`53`	`+ if reason != "" {`
	`54`	`+ obj.Kustomization.Annotations[SuspendReasonAnnotation] = reason`
	`55`	`+ }`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`func (a kustomizationListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (obj receiverAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (obj receiverAdapter) setSuspended(reason string) {`
`51`	`51`	`obj.Receiver.Spec.Suspend = true`
`52`		`- obj.Receiver.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ obj.Receiver.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a receiverListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (obj bucketAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (obj bucketAdapter) setSuspended(reason string) {`
`51`	`51`	`obj.Bucket.Spec.Suspend = true`
`52`		`- obj.Bucket.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ obj.Bucket.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a bucketListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (obj helmChartAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (obj helmChartAdapter) setSuspended(reason string) {`
`51`	`51`	`obj.HelmChart.Spec.Suspend = true`
`52`		`- obj.HelmChart.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ obj.HelmChart.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a helmChartListAdapter) item(i int) suspendable {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ func (obj gitRepositoryAdapter) isSuspended() bool {`
`49`	`49`
`50`	`50`	`func (obj gitRepositoryAdapter) setSuspended(reason string) {`
`51`	`51`	`obj.GitRepository.Spec.Suspend = true`
`52`		`- obj.GitRepository.Annotations[SuspendReasonAnnotation] = reason`
	`52`	`+ if reason != "" {`
	`53`	`+ obj.GitRepository.Annotations[SuspendReasonAnnotation] = reason`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`func (a gitRepositoryListAdapter) item(i int) suspendable {`