feat: add disableProvenance option to GrafanaAlertRuleGroupSpec

[chenlujjj]

To resolve issue #1710

[CLAassistant]

All committers have signed the CLA.

[theSuess]

Thanks for the quick PR! From the previous discussion, I think we can call the option editable. The terraform provider is auto-generated, which comes with the quirk of having hard to understand fields. Since we can simplify this for the user by calling it editable instead, I'd do that.

What's the take of the other maintainers on this?

[chenlujjj]

@theSuess Thanks for the advice, I've updated the code

[theSuess]

I tested this against the newest Grafana version, and it does not work as the header does not actually use the value but just checks for presence of any value.

Which version did you test against?

[chenlujjj]

@theSuess Actually I didn't run e2e test, I thought it's a straightforward change. I'll follow the contribute guide to run the test and fix it.

[theSuess]

Not sure if the e2e tests will catch this (since they can only introspect the kubernetes resources) but some manual testing should be enough

[chenlujjj]

Hello @theSuess , I've updated the code and run manual test in my local env, here are the test results:

• No editable field or editable: true, the rule group can be edited or deleted in UI
• editable: false, the rule group cannot be edited or deleted in UI

One thing worthy note is that the editable can be changed from true to false, but cannot from false to true, in which case the request will return 500:

logger=context userId=1 orgId=1 uname=root t=2024-10-24T07:13:58.237291685Z level=error msg="cannot change provenance from 'api' to ''" error="cannot change provenance from 'api' to ''" remote_addr=172.18.0.1 traceID=
logger=context userId=1 orgId=1 uname=root t=2024-10-24T07:13:58.237353217Z level=error msg="Request Completed" method=PUT path=/api/v1/provisioning/alert-rules/ce1tedpihg0lca status=500 remote_addr=172.18.0.1 time_ms=11 duration=11.370494ms size=68 referer= handler=/api/v1/provisioning/alert-rules/:UID status_source=server

[Baarsgaard]

The error on enabling editing seems quite bad.
Ideally, if the editable field changes, the operator would delete and apply the AlertRuleGroup to ensure desired state is achieved.
Or alternatively make the field immutable, preventing edits?

[theSuess]

I'd go with the immutable field, it's conceptually easier and is more robust - thanks for continuing to work on this!

[chenlujjj]

+1 for making the field immutable

[chenlujjj]

Manually tested in local environment, the immutability works:

❯ k apply -f testalertgroup.yaml
The GrafanaAlertRuleGroup "group2" is invalid: spec.editable: Invalid value: "boolean": Editable field is immutable

[theSuess]

I've changed the wording a bit and renamed a variable for clarity - thanks for working on this!