Feature Request: Service Fabric configuration source

Question

Feature Request: Service Fabric configuration source

Closed this issue 5 years ago · 18 comments

Just wondering if the configuration source implementation for Service Fabric could be included in this repo and published as a separate package. If so, I could prepare a PR from the one I did in aspnet/Configuration#642

Answer 1 · 2017-04-25T23:52:26.000Z

@DixonDs Definitely, this would be great to have. It's been a fairly popular way of consuming SF config in ASP.NET Core services. Looking at your other PR, there are a few additional things we'd want to have to fully support SF config packages:

Ability to consume configuration settings from multiple configuration packages. Services can have an arbitrary number of config packages, each with their own settings.xml. The key in the Data dictionary would then be something like this: ConfigPackageName/SectionName/ParameterName
Parameters in settings.xml may be encrypted. This should support reading both encrypted and plaintext values.
The config provider should be able to consume events when the config package is updated.
Unit tests

@MikeWasson wrote up a great blog post on this with some sample code that does 2 and 3 - I would recommend taking a look at that for sure.

Answer 2 · 2017-10-03T16:00:36.000Z

@DixonDs Just checking if you have any plans for submitting a PR for this?

Answer 3 · 2017-10-03T18:56:53.000Z

@amanbha no, at least not anytime soon, I guess.

Answer 4 · 2018-04-21T07:33:28.000Z

any update for this feature request?

Answer 5 · 2018-04-21T15:06:32.000Z

@chuanboz At this point this is low in priority because of other high priority work items for ServiceFabric team. You can use the code in the PR mentioned in the first post of the issue, feel free to send us.a PR with the changes for the merge back.

Answer 6 · 2018-04-23T17:39:43.000Z

sure, I will try to provide a PR that address the 4 points @vturecek mentioned. I will start to work on this now and try to get it by the end of May.

Answer 7 · 2018-04-24T17:40:49.000Z

@vturecek， regarding "Parameters in settings.xml may be encrypted. This should support reading both encrypted and plaintext values."

I see the sample from @MikeWasson handle the encrypted string as follow

Data[$"{section.Name}:{param.Name}"] = param.IsEncrypted ? param.DecryptValue().ToUnsecureString() : param.Value;

that seems violate the security guidelines. A typical safety guideline is to keep them encrypted in memory, and then decrypt (briefly) at time of use.

so I would suggest to treat encrypted and plain text value the same in ServiceFabricConfigurationProvider, and give guideline to the config user to decrypt them at the time of their usage briefly to mitigate the security risk.

Answer 8 · 2018-04-25T04:55:43.000Z

One more thing while I am looking at implement this, I see the Settings.xml format has some limitation that it only support section/parameter 2 levels, if use Json file as the configuration file then it adds much flexibility.

As Service Fabric also supports Data Packages which could be any format, one possibility I see, would be to also add the Json file format to this configuration source using Data Package, with the file name supplied by the caller. Any feedback for that?

Answer 9 · 2018-04-25T07:36:19.000Z

@chuanboz As far as I remember, normally implementations flatten the configuration sources with multiple levels using ":" as the delimiter.See https://github.com/aspnet/Configuration/blob/dc6fbde39f532bf154ee1eb02d8be08a0a1605e4/src/Config.Abstractions/ConfigurationPath.cs and its usages in implementations. So basically it allows emulating multiple levels in configuration sources like environment variables, for instance.

Answer 10 · 2018-04-25T15:07:26.000Z

@chuanboz Having it in Config package in settings.xml allows it to be overwritten at application creation time by application parameters.

Answer 11 · 2018-04-25T19:54:56.000Z

I've created a new issue #52 to describe the Json configuration scenario requirement.
@DixonDs, thanks for reference ":" support, I see that could make the hierarchy settings work in parameter but that seems like a hack and kind of ugly than the nature Json file experience.

@amanbha, the built-in override experience is not that ideally for us, see detail that I describe in issue #52 .

for now I will use this issue here for the Settings.xml support and will send PR soon.

Answer 12 · 2018-09-20T20:13:20.000Z

@chuanboz Is the PR up? I have written code which does this I can send the PR if you haven't started working on it and I can incorporate feedback you have based on your learnings.

Answer 13 · 2018-09-20T20:53:17.000Z

the PR is here: #58
there are open issue raised by Aman I haven't had time to resolve yet.

Answer 14 · 2018-09-21T00:05:17.000Z

I've updated the PR #58 to address the issue raised by Aman. @RamjotSingh , can you also take a look of the PR and see if that will also work for your scenario?

Answer 15 · 2018-10-16T23:26:07.000Z

@amanbha , I see version 3.2.187 of Microsoft.ServiceFabric.AspNetCore.* is released 15 days ago, but that does not include this new Microsoft.ServiceFabric.AspNetCore.Configuration package, is there any further work needed to get Microsoft.ServiceFabric.AspNetCore.Configuration package released?

Answer 16 · 2018-10-16T23:28:28.000Z

also, which github repo shall I use to fire a document issue to get the usage of this new configuration package publically documented in https://docs.microsoft.com?

Answer 17 · 2018-10-16T23:30:00.000Z

@chuanboz 3.2.*187 was just a cumulative release and only contained bug fixes. Our current release (3.3 sdk) is already in lockdown, so it will be part of 3.4 sdk release. I will see if I can make a one off release for this package, once 3,4 is out. For documentation, please send email to @amanbha and @vturecek

Answer 18 · 2019-04-04T16:25:07.000Z

Its released on nuget.org
https://www.nuget.org/packages/Microsoft.ServiceFabric.AspNetCore.Configuration/