grafana / oncall

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

No Documentation on full list of variables to deploy OnCall with #4497

Open justinhauer opened 6 months ago

justinhauer commented 6 months ago

What would you like to see!

Feature Request Ask 1: Comprehensive documentation regarding environment variables

I'm looking for a full list, in one spot, of all the potential environment variables ones can pass to OnCall during a deployment, like here: https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/. For users looking to deploy OnCall in an environment other than k8s with a helm chart, the current documentation is fragmented at best and leaves the user to either guess or sift through many files within this project to determine how to configure resources to work with OnCall.

Example: I deploy Grafana + OnCall in another container orchestrator, ECS as an example. While a vanilla deployment of the container is straight forward, if I want to offload Redis and rabbitMQ component to the amazon managed services, this needs to be spelled out more.

Product Area

Other

Anything else to add?

Helm is great for k8s, unfortunately running k8s is a somewhat large dependency to all of the instruction sets.

github-actions[bot] commented 6 months ago

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

justinhauer commented 6 months ago

@joeyorlando since I've caught your attention before, have I missed something in the docs generally outlining env vars for a container deployment?

joeyorlando commented 5 months ago

@justinhauer there isn't at the moment (AFAIK), but this is something I might pick up in the near future and improve

sbourell commented 3 months ago

Hi @justinhauer After searching for hours on the web, I think your are the only one that seems to deploy OnCall on AWS ECS :D

I am trying to deploy it to ECS too because we don't use k8s and like you I had to dig deep to manage to find informations, but I am stuck with the oncall-engine that don't want to start.

redis, db-migration and celery are ok, but when it comes to the engine, I am stuck with this error: uswgi -s/--socket option is missing and stdin is not a socket

Do you encountered the same error when you deployed it?

Thank you for your help

justinhauer commented 3 months ago

While I haven't deployed it yet, it's definitely a network issue, there might be a config option you're missing or you don't have a port open that the application expects to be open. I would inspect the helm chart, and also your security groups. The helm chart would help you interpolate what you need to either change in your ecs task definition, or the security groups. If it's something else though, let me know because I'm interested!