diff --git a/cmd/flux/resume_alert.go b/cmd/flux/resume_alert.go index 7ed29221..add89dd2 100644 --- a/cmd/flux/resume_alert.go +++ b/cmd/flux/resume_alert.go @@ -49,8 +49,8 @@ func (obj alertAdapter) getObservedGeneration() int64 { func (obj alertAdapter) setUnsuspended() { obj.Alert.Spec.Suspend = false - if _, ok := obj.Alert.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.Alert.Annotations, SuspendReasonAnnotation) + if _, ok := obj.Alert.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.Alert.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_helmrelease.go b/cmd/flux/resume_helmrelease.go index 6acbd2b3..cd475d03 100644 --- a/cmd/flux/resume_helmrelease.go +++ b/cmd/flux/resume_helmrelease.go @@ -52,8 +52,8 @@ func (obj helmReleaseAdapter) getObservedGeneration() int64 { func (obj helmReleaseAdapter) setUnsuspended() { obj.HelmRelease.Spec.Suspend = false - if _, ok := obj.HelmRelease.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.HelmRelease.Annotations, SuspendReasonAnnotation) + if _, ok := obj.HelmRelease.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.HelmRelease.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_image_repository.go b/cmd/flux/resume_image_repository.go index b1e49364..add2a172 100644 --- a/cmd/flux/resume_image_repository.go +++ b/cmd/flux/resume_image_repository.go @@ -48,8 +48,8 @@ func (obj imageRepositoryAdapter) getObservedGeneration() int64 { func (obj imageRepositoryAdapter) setUnsuspended() { obj.ImageRepository.Spec.Suspend = false - if _, ok := obj.ImageRepository.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.ImageRepository.Annotations, SuspendReasonAnnotation) + if _, ok := obj.ImageRepository.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.ImageRepository.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_image_updateauto.go b/cmd/flux/resume_image_updateauto.go index d0131c98..561df490 100644 --- a/cmd/flux/resume_image_updateauto.go +++ b/cmd/flux/resume_image_updateauto.go @@ -44,8 +44,8 @@ func init() { func (obj imageUpdateAutomationAdapter) setUnsuspended() { obj.ImageUpdateAutomation.Spec.Suspend = false - if _, ok := obj.ImageUpdateAutomation.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.ImageUpdateAutomation.Annotations, SuspendReasonAnnotation) + if _, ok := obj.ImageUpdateAutomation.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.ImageUpdateAutomation.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_kustomization.go b/cmd/flux/resume_kustomization.go index ab8ed7dc..23f231df 100644 --- a/cmd/flux/resume_kustomization.go +++ b/cmd/flux/resume_kustomization.go @@ -52,8 +52,8 @@ func (obj kustomizationAdapter) getObservedGeneration() int64 { func (obj kustomizationAdapter) setUnsuspended() { obj.Kustomization.Spec.Suspend = false - if _, ok := obj.Kustomization.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.Kustomization.Annotations, SuspendReasonAnnotation) + if _, ok := obj.Kustomization.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.Kustomization.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_receiver.go b/cmd/flux/resume_receiver.go index 1659c6bf..c13c25f9 100644 --- a/cmd/flux/resume_receiver.go +++ b/cmd/flux/resume_receiver.go @@ -49,8 +49,8 @@ func (obj receiverAdapter) getObservedGeneration() int64 { func (obj receiverAdapter) setUnsuspended() { obj.Receiver.Spec.Suspend = false - if _, ok := obj.Receiver.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.Receiver.Annotations, SuspendReasonAnnotation) + if _, ok := obj.Receiver.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.Receiver.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_source_bucket.go b/cmd/flux/resume_source_bucket.go index de0ec2b6..dd2ba4da 100644 --- a/cmd/flux/resume_source_bucket.go +++ b/cmd/flux/resume_source_bucket.go @@ -48,8 +48,8 @@ func (obj bucketAdapter) getObservedGeneration() int64 { func (obj bucketAdapter) setUnsuspended() { obj.Bucket.Spec.Suspend = false - if _, ok := obj.Bucket.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.Bucket.Annotations, SuspendReasonAnnotation) + if _, ok := obj.Bucket.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.Bucket.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_source_chart.go b/cmd/flux/resume_source_chart.go index beb3ed97..245c3445 100644 --- a/cmd/flux/resume_source_chart.go +++ b/cmd/flux/resume_source_chart.go @@ -50,8 +50,8 @@ func (obj helmChartAdapter) getObservedGeneration() int64 { func (obj helmChartAdapter) setUnsuspended() { obj.HelmChart.Spec.Suspend = false - if _, ok := obj.HelmChart.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.HelmChart.Annotations, SuspendReasonAnnotation) + if _, ok := obj.HelmChart.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.HelmChart.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_source_git.go b/cmd/flux/resume_source_git.go index 23289870..120a0937 100644 --- a/cmd/flux/resume_source_git.go +++ b/cmd/flux/resume_source_git.go @@ -48,8 +48,8 @@ func (obj gitRepositoryAdapter) getObservedGeneration() int64 { func (obj gitRepositoryAdapter) setUnsuspended() { obj.GitRepository.Spec.Suspend = false - if _, ok := obj.GitRepository.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.GitRepository.Annotations, SuspendReasonAnnotation) + if _, ok := obj.GitRepository.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.GitRepository.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_source_helm.go b/cmd/flux/resume_source_helm.go index 54531cb8..7d10aed5 100644 --- a/cmd/flux/resume_source_helm.go +++ b/cmd/flux/resume_source_helm.go @@ -48,8 +48,8 @@ func (obj helmRepositoryAdapter) getObservedGeneration() int64 { func (obj helmRepositoryAdapter) setUnsuspended() { obj.HelmRepository.Spec.Suspend = false - if _, ok := obj.HelmRepository.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.HelmRepository.Annotations, SuspendReasonAnnotation) + if _, ok := obj.HelmRepository.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.HelmRepository.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/resume_source_oci.go b/cmd/flux/resume_source_oci.go index db40ec05..b724feb6 100644 --- a/cmd/flux/resume_source_oci.go +++ b/cmd/flux/resume_source_oci.go @@ -48,8 +48,8 @@ func (obj ociRepositoryAdapter) getObservedGeneration() int64 { func (obj ociRepositoryAdapter) setUnsuspended() { obj.OCIRepository.Spec.Suspend = false - if _, ok := obj.OCIRepository.Annotations[SuspendReasonAnnotation]; ok { - delete(obj.OCIRepository.Annotations, SuspendReasonAnnotation) + if _, ok := obj.OCIRepository.Annotations[SuspendMessageAnnotation]; ok { + delete(obj.OCIRepository.Annotations, SuspendMessageAnnotation) } } diff --git a/cmd/flux/suspend.go b/cmd/flux/suspend.go index 54b45fef..ad4d745b 100644 --- a/cmd/flux/suspend.go +++ b/cmd/flux/suspend.go @@ -34,8 +34,8 @@ var suspendCmd = &cobra.Command{ } type SuspendFlags struct { - all bool - reason string + all bool + message string } var suspendArgs SuspendFlags @@ -43,8 +43,8 @@ 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", "", - "set a reason for why the resource is suspended, the reason will show up under the suspend.toolkit.fluxcd.io/reason annotation") + suspendCmd.PersistentFlags().StringVarP(&suspendArgs.message, "message", "m", "", + "set a message for the resource being suspended (stored in the suspend.toolkit.fluxcd.io/message annotation)") rootCmd.AddCommand(suspendCmd) } @@ -52,7 +52,7 @@ type suspendable interface { adapter copyable isSuspended() bool - setSuspended(reason string) + setSuspended(message string) } type suspendCommand struct { @@ -133,7 +133,7 @@ func (suspend suspendCommand) patch(ctx context.Context, kubeClient client.WithW obj := suspend.list.item(i) patch := client.MergeFrom(obj.deepCopyClientObject()) - obj.setSuspended(suspendArgs.reason) + obj.setSuspended(suspendArgs.message) if err := kubeClient.Patch(ctx, obj.asClientObject(), patch); err != nil { return err } @@ -144,5 +144,5 @@ func (suspend suspendCommand) patch(ctx context.Context, kubeClient client.WithW return nil } -// SuspendReasonAnnotation is the metadata key used to store the reason for resource suspension -const SuspendReasonAnnotation string = "suspend.toolkit.fluxcd.io/reason" +// SuspendMessageAnnotation is the metadata key used to store a message related to resource suspension +const SuspendMessageAnnotation string = "suspend.toolkit.fluxcd.io/message" diff --git a/cmd/flux/suspend_alert.go b/cmd/flux/suspend_alert.go index be750c9f..c0251d54 100644 --- a/cmd/flux/suspend_alert.go +++ b/cmd/flux/suspend_alert.go @@ -47,10 +47,10 @@ func (obj alertAdapter) isSuspended() bool { return obj.Alert.Spec.Suspend } -func (obj alertAdapter) setSuspended(reason string) { +func (obj alertAdapter) setSuspended(message string) { obj.Alert.Spec.Suspend = true - if reason != "" { - obj.Alert.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.Alert.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_helmrelease.go b/cmd/flux/suspend_helmrelease.go index 8bfd3731..5675da79 100644 --- a/cmd/flux/suspend_helmrelease.go +++ b/cmd/flux/suspend_helmrelease.go @@ -48,10 +48,10 @@ func (obj helmReleaseAdapter) isSuspended() bool { return obj.HelmRelease.Spec.Suspend } -func (obj helmReleaseAdapter) setSuspended(reason string) { +func (obj helmReleaseAdapter) setSuspended(message string) { obj.HelmRelease.Spec.Suspend = true - if reason != "" { - obj.HelmRelease.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.HelmRelease.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_image_repository.go b/cmd/flux/suspend_image_repository.go index 83cdd127..56b2a775 100644 --- a/cmd/flux/suspend_image_repository.go +++ b/cmd/flux/suspend_image_repository.go @@ -47,10 +47,10 @@ func (obj imageRepositoryAdapter) isSuspended() bool { return obj.ImageRepository.Spec.Suspend } -func (obj imageRepositoryAdapter) setSuspended(reason string) { +func (obj imageRepositoryAdapter) setSuspended(message string) { obj.ImageRepository.Spec.Suspend = true - if reason != "" { - obj.ImageRepository.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.ImageRepository.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_image_updateauto.go b/cmd/flux/suspend_image_updateauto.go index 89295b5b..bde79667 100644 --- a/cmd/flux/suspend_image_updateauto.go +++ b/cmd/flux/suspend_image_updateauto.go @@ -47,10 +47,10 @@ func (update imageUpdateAutomationAdapter) isSuspended() bool { return update.ImageUpdateAutomation.Spec.Suspend } -func (update imageUpdateAutomationAdapter) setSuspended(reason string) { +func (update imageUpdateAutomationAdapter) setSuspended(message string) { update.ImageUpdateAutomation.Spec.Suspend = true - if reason != "" { - update.ImageUpdateAutomation.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + update.ImageUpdateAutomation.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_kustomization.go b/cmd/flux/suspend_kustomization.go index b0ec1b8b..74bd78d5 100644 --- a/cmd/flux/suspend_kustomization.go +++ b/cmd/flux/suspend_kustomization.go @@ -48,10 +48,10 @@ func (obj kustomizationAdapter) isSuspended() bool { return obj.Kustomization.Spec.Suspend } -func (obj kustomizationAdapter) setSuspended(reason string) { +func (obj kustomizationAdapter) setSuspended(message string) { obj.Kustomization.Spec.Suspend = true - if reason != "" { - obj.Kustomization.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.Kustomization.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_receiver.go b/cmd/flux/suspend_receiver.go index 57ceb1d0..445c5ac7 100644 --- a/cmd/flux/suspend_receiver.go +++ b/cmd/flux/suspend_receiver.go @@ -47,10 +47,10 @@ func (obj receiverAdapter) isSuspended() bool { return obj.Receiver.Spec.Suspend } -func (obj receiverAdapter) setSuspended(reason string) { +func (obj receiverAdapter) setSuspended(message string) { obj.Receiver.Spec.Suspend = true - if reason != "" { - obj.Receiver.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.Receiver.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_source_bucket.go b/cmd/flux/suspend_source_bucket.go index 55eef2c4..afd963ab 100644 --- a/cmd/flux/suspend_source_bucket.go +++ b/cmd/flux/suspend_source_bucket.go @@ -47,10 +47,10 @@ func (obj bucketAdapter) isSuspended() bool { return obj.Bucket.Spec.Suspend } -func (obj bucketAdapter) setSuspended(reason string) { +func (obj bucketAdapter) setSuspended(message string) { obj.Bucket.Spec.Suspend = true - if reason != "" { - obj.Bucket.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.Bucket.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_source_chart.go b/cmd/flux/suspend_source_chart.go index f8d471ed..64a3005e 100644 --- a/cmd/flux/suspend_source_chart.go +++ b/cmd/flux/suspend_source_chart.go @@ -47,10 +47,10 @@ func (obj helmChartAdapter) isSuspended() bool { return obj.HelmChart.Spec.Suspend } -func (obj helmChartAdapter) setSuspended(reason string) { +func (obj helmChartAdapter) setSuspended(message string) { obj.HelmChart.Spec.Suspend = true - if reason != "" { - obj.HelmChart.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.HelmChart.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_source_git.go b/cmd/flux/suspend_source_git.go index f379ab8e..a60164d7 100644 --- a/cmd/flux/suspend_source_git.go +++ b/cmd/flux/suspend_source_git.go @@ -47,10 +47,10 @@ func (obj gitRepositoryAdapter) isSuspended() bool { return obj.GitRepository.Spec.Suspend } -func (obj gitRepositoryAdapter) setSuspended(reason string) { +func (obj gitRepositoryAdapter) setSuspended(message string) { obj.GitRepository.Spec.Suspend = true - if reason != "" { - obj.GitRepository.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.GitRepository.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_source_helm.go b/cmd/flux/suspend_source_helm.go index 56e883ed..282ddd97 100644 --- a/cmd/flux/suspend_source_helm.go +++ b/cmd/flux/suspend_source_helm.go @@ -47,10 +47,10 @@ func (obj helmRepositoryAdapter) isSuspended() bool { return obj.HelmRepository.Spec.Suspend } -func (obj helmRepositoryAdapter) setSuspended(reason string) { +func (obj helmRepositoryAdapter) setSuspended(message string) { obj.HelmRepository.Spec.Suspend = true - if reason != "" { - obj.HelmRepository.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.HelmRepository.Annotations[SuspendMessageAnnotation] = message } } diff --git a/cmd/flux/suspend_source_oci.go b/cmd/flux/suspend_source_oci.go index 07fa2a4f..acf0057b 100644 --- a/cmd/flux/suspend_source_oci.go +++ b/cmd/flux/suspend_source_oci.go @@ -47,10 +47,10 @@ func (obj ociRepositoryAdapter) isSuspended() bool { return obj.OCIRepository.Spec.Suspend } -func (obj ociRepositoryAdapter) setSuspended(reason string) { +func (obj ociRepositoryAdapter) setSuspended(message string) { obj.OCIRepository.Spec.Suspend = true - if reason != "" { - obj.OCIRepository.Annotations[SuspendReasonAnnotation] = reason + if message != "" { + obj.OCIRepository.Annotations[SuspendMessageAnnotation] = message } }