Periods in ConfigMap keys get replaced by colons without any possibility of escape.

[wasabii]

dotnet-kube-client/src/KubeClient.Extensions.Configuration/ConfigMapConfigurationProvider.cs

Line 133 in 117c4f8

entry => sectionNamePrefix + entry.Key.Replace('.', ':'),

Techincally, Microsoft.Extensions.Configuration, supports key values with periods in their names. For instance, in JSON:

"Foo.Bar": {
   "Value": "Hi"
}

But there's no way to represent this pattern in a ConfigMap.

Perhaps some escaping syntax.

[tintoy]

Thanks, good catch! I think this was originally to match K8s envFrom but there’s no real need to do so. I’ll look into making the replacement configurable even if it’s just to completely enable/disable the behaviour.

[wasabii]

Well the way the dotnet parses env variables would work. That escapes : with _.

So it would be a changing change.

[tintoy]

Maybe we can wind up supporting 3 options (overloads, conceptually) when configuring the configuration provider for a specific ConfigMap:

1. Existing behaviour (the default; backward-compatible)
2. A single character to replace . with.
3. A set of mappings to replace characters (will throw if resulting replacements would be illegal).

About the only restriction here is that the resulting keys cannot contain a : because that’s the character used by the configuration system to represent sections and sub-sections.

[tintoy]

Also worth noting the section in the docs relating to : vs __ so that may be something we can consider as well:

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-8.0#non-prefixed-environment-variables

[tintoy]

Hi - can you give v2.5.7-develop.2 a try and see if that works for you?

When setting up your configuration, there is now an additional parameter you can pass (keyPathDelimiters) that specifies which characters represent delimiters in ConfigMap and Secret keys (you can pass an empty char array or Enumerable.Empty<char>() to entirely prevent the ConfigMap/Secret keys from being modified when converted to IConfiguration keys).

[tintoy]

Sorry, that was the wrong branch. Will try again 🙂

[tintoy]

Ok - can you give v2.5.0-configmap-key-escape.51 a try?