Configurr.Client 0.1.0-alpha1

Configurr.Client

.NET client library for consuming configuration rendered by the Configurr Kubernetes operator.

Auto-discovers mounted ConfigMap JSON files, supports hot reload, environment variable injection, section prefixing, and health checks.

Built on Microsoft.Extensions.Configuration — works with IOptions<T>, IOptionsMonitor<T>, and all standard .NET configuration patterns.

Installation

dotnet add package Configurr.Client

Quick start

var builder = WebApplication.CreateBuilder(args);

// Auto-discovers all *.json files in /config, enables hot reload
builder.AddConfigurr();

var app = builder.Build();
app.Run();

That's it. All JSON files mounted to /config/ are loaded automatically with hot reload enabled.

Configuration options

builder.AddConfigurr(configurr =>
{
    // Change the base directory (default: /config)
    configurr.BasePath = "/etc/myapp/config";

    // Load environment variables with a prefix
    configurr.EnvVarSources.Add(new EnvVarSource { Prefix = "DB_" });

    // Enable health check endpoint
    configurr.EnableHealthCheck = true;

    // Control files explicitly instead of auto-discovery
    configurr.AutoDiscover = false;
    configurr.JsonFiles.Add(new JsonFileSource
    {
        FileName = "appsettings.Database.json",
        SectionPrefix = "Database"   // Nests all keys under "Database:*"
    });
});

All options

JsonFileSource

EnvVarSource

Health checks

When EnableHealthCheck = true, a health check named "configurr" is registered with tags configurr, config, ready.

Map it to an endpoint:

app.MapHealthChecks("/healthz/ready", new HealthCheckOptions
{
    Predicate = check => check.Tags.Contains("ready")
});

Usage with Configurr operator

The operator renders ConfigMaps that you mount into your pod:

spec:
  containers:
    - name: my-app
      volumeMounts:
        - name: db-config
          mountPath: /config/appsettings.Database.json
          subPath: appsettings.Database.json
          readOnly: true
      envFrom:
        - configMapRef:
            name: my-app-database-env
  volumes:
    - name: db-config
      configMap:
        name: my-app-database-json

Then in your application:

builder.AddConfigurr(configurr =>
{
    configurr.EnvVarSources.Add(new EnvVarSource { Prefix = "DB_" });
    configurr.EnableHealthCheck = true;
});

// Bind to strongly-typed options (supports hot reload via IOptionsMonitor)
builder.Services.Configure<DatabaseOptions>(
    builder.Configuration.GetSection("Database"));

IConfigurationBuilder overload

For non-host scenarios (e.g. tests), use the IConfigurationBuilder extension:

var config = new ConfigurationBuilder()
    .AddConfigurr(configurr =>
    {
        configurr.BasePath = "./test-config";
        configurr.AutoDiscover = true;
    })
    .Build();

Release

Releases are triggered by client/v*.*.* git tags and published to NuGet.org and GitHub Packages. See the release guide for details.

License

MIT