search

grafana / oncall

Developer-friendly incident response with brilliant Slack integration
GNU Affero General Public License v3.0
3.43k stars 276 forks source link

Remove live settings (ie. Env Variables UI) #4540

Open joeyorlando opened 3 months ago

joeyorlando commented 3 months ago

What would you like to see!

I've combed through the issues/bug reports here in the repo and it feels like this page leads to more confusion than it is helpful. This isn't an exhaustive list but here are a few bug reports I came across:

In short, for OSS deployments of Grafana OnCall, we should have only one way of configuring things, via environment variables.

Deliverables

  1. remove live settings functionality (API routes + UI) and ensure that Grafana OnCall is configurable via environment variables
  2. add a table in our public documentation on all of the environment variables we currently have and what they are used for (this would close https://github.com/grafana/oncall/issues/4497)

NOTES

We may want to consider releasing this change as a part of v2.0.0 as it's possible this would be a breaking change (ex. user was using live settings, would need to manually migrate their live settings values to environment variables in their deployment).

Product Area

Alert Flow & Configuration

Anything else to add?

No response

github-actions[bot] commented 3 months ago

The current version of Grafana OnCall, at the time this issue was opened, is v1.7.1. If your issue pertains to an older version of Grafana OnCall, please be sure to list it in the PR description. Thank you :smile:!

joeyorlando commented 3 months ago

See this Slack thread for some more discussion/ideas

One thing to note is that the Env Variables page can give useful info when things are not configured properly. We should probably surface these warnings somewhere (ex. logging on startup or some other endpoint)

Konstantinov-Innokentii commented 3 months ago

@joeyorlando WDYT about keeping the page, but use it only for validation without ability to edit things?

joeyorlando commented 3 months ago

@Konstantinov-Innokentii I think that could make sense 👍 (@mderynck had a similar idea). We'd probably need some design input from @raphael-batte here.