[Bug]: Avoid inotify limit in WebAPI container on Kubernetes

[YaSuenag]

Contact Details

No response

What happened?

We are using WebAPI container on Kubernetes with Helm chart, then we saw a error which explained in following URL.
https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/docker/?view=aspnetcore-8.0

We think it is better to set DOTNET_HOSTBUILDER__RELOADCONFIGONCHANGE environment variable as the article said because we cannot update appsettings.json - it is mounted as subPath.

In general, reload config might be useful if WebAPI runs on the OS (not coantainer). So I will modify Helm chart to add environment variables for WebAPI container if you agree. What do you think?

client

WebAPI (Default)

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[vaughanknight]

@danuw - we discussed in the #530 meeting that this probably should be an ADR, as it can be done via code or configuration and it would be good to have the flexibility of both, with appsettings.json not having in flight updates being possible for production systems by default.

[YaSuenag]

Before proposing ADR, I'd like to sort out the solution.

According to Microsoft Learn and discussion on GitHub, we have two approach for this issue:

1. Load JSON manually via AddJsonFile with reloadOnChange: false
2. Set DOTNET_HOSTBUILDER__RELOADCONFIGONCHANGE=false as an environment variable

We have following code in Program.cs:

carbon-aware-sdk/src/CarbonAware.WebApi/src/Program.cs

Line 18 in 4f5dbd2

var builder = WebApplication.CreateBuilder(args);

According to Microsoft Learn, WebApplication.CreateBuilder() loads appsettings.json implicitly, so we have no chance to apply 1 (reloadOnChange: false), thus we have to apply 2 (DOTNET_HOSTBUILDER__RELOADCONFIGONCHANGE).

Hence I think it is the best solution to set DOTNET_HOSTBUILDER__RELOADCONFIGONCHANGE if need, and I want to modify Helm Chart that the user can be add this environment variable if want. For Docker users, they just add -e DOTNET_HOSTBUILDER__RELOADCONFIGONCHANGE=false to their docker run.

@vaughanknight @danuw What do you think?
I will create PR for Helm Chart without ADR if you agree.

[YaSuenag]

Suggested fix: YaSuenag@d2ff48e