MERSELSDK.Core.Configuration 0.1.0-preview.20260710002836

MERSELSDK.Core.Configuration

Genel Bakış

MERSELSDK.Core.Configuration modülü, .NET uygulamaları için merkezi ve güvenli konfigürasyon ile gizli bilgi (secret) yönetimi sağlar. Consul ve Vault ile entegre çalışır, tenant ve servis bazlı yapılandırma sunar. Fluent API ve Builder Pattern ile kolay ve okunabilir bir kullanım sağlar.

Özellikler

• Consul ve Vault ile merkezi konfigürasyon ve secret yönetimi
• Tenant ve servis bazlı yapılandırma desteği
• Otomatik değişiklik algılama ve yeniden yükleme (reload on change)
• Ortam değişkenleriyle kolay konfigürasyon
• Fluent API ile kolay ve okunabilir kullanım
• Token otomatik yenileme desteği (Vault için)
• Opsiyonel veya zorunlu (required) ayar desteği

Kurulum

NuGet üzerinden ekleyin:

dotnet add package MERSELSDK.Core.Configuration

Gerekli ek bağımlılıklar:

• Winton.Extensions.Configuration.Consul
• VaultSharp.Extensions.Configuration
• Ardalis.GuardClauses

DI Entegrasyonu

Program.cs dosyanızda aşağıdaki gibi servisleri kaydedin:

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;

builder.Services.AddConsulConfigurationBuilder(builder.Configuration, builder.Configuration);
builder.Services.AddVaultSecretBuilder(builder.Configuration, builder.Configuration);

Kullanım

Consul ile Konfigürasyon Yönetimi

var configurationBuilder = new ConfigurationBuilder();

var consulConfigBuilder = new ConsulConfigurationBuilder(configurationBuilder)
    .SetHost("http://localhost:8500")
    .SetServiceName("MyService")
    .SetTenant("default")
    .SetToken("my-consul-token")
    .SetConfigurationKey("appsettings.json")
    .EnableReloadOnChange();

consulConfigBuilder.Build();
var configuration = configurationBuilder.Build();

Vault ile Secret Yönetimi

var configurationBuilder = new ConfigurationBuilder();

var vaultSecretBuilder = new VaultSecretBuilder(configurationBuilder)
    .SetHost("https://vault.example.com")
    .SetToken("my-vault-token")
    .SetServiceName("MyService")
    .SetTenant("default")
    .SetSecretKey("database")
    .EnableReloadOnChange()
    .EnableTokenAutoRenew(); // Token otomatik yenileme

vaultSecretBuilder.Build();
var configuration = configurationBuilder.Build();

Ortam Değişkenleri ile Kullanım

Aşağıdaki ortam değişkenlerini tanımlayabilirsiniz:

• Consul için: CONSUL_HOST, SERVICE_NAME, TENANT, CONSUL_TOKEN
• Vault için: VAULT_HOST, SERVICE_NAME, TENANT, VAULT_TOKEN

var configurationBuilder = new ConfigurationBuilder();
var consulConfigBuilder = new ConsulConfigurationBuilder(configurationBuilder)
    .SetConfigurationKey("appsettings.json")
    .EnableReloadOnChange();

consulConfigBuilder.Build();
var configuration = configurationBuilder.Build();

Ana Sınıflar ve Arayüzler

• ConsulConfigurationBuilder: Consul ile konfigürasyon yönetimi için builder sınıfı.
• VaultSecretBuilder: Vault ile secret yönetimi için builder sınıfı.
• IConsulConfiguration: Consul konfigürasyonları için arayüz.
• IVaultSecret: Vault secretları için arayüz.
• ConsulConfigurationManagerOptions: Consul yapılandırma seçenekleri.
• VaultSecretManagerOptions: Vault yapılandırma seçenekleri.

Gelişmiş Özellikler

• Token Otomatik Yenileme: Vault token'ınızın süresi dolmadan otomatik olarak yenilenmesini sağlayabilirsiniz.
• Opsiyonel Konfigürasyon: Konfigürasyonun opsiyonel veya zorunlu olup olmadığını belirleyebilirsiniz.
• Multi-Tenant Desteği: Her tenant için ayrı konfigürasyon ve secret yönetimi.

Örnek Proje Kullanımı

DI Container'da Vault Secrets Ayarlaması

Aşağıdaki extension metodu kullanarak Vault secretlarını kolayca ayarlayabilirsiniz:

public static void AddVaultSecrets(this IServiceCollection services, IConfiguration configuration, IConfigurationBuilder configurationBuilder, string environment)
{
    services.AddVaultSecretBuilder(configuration, configurationBuilder);

    var vaultSecretBuilder = services.BuildServiceProvider().GetService<VaultSecretBuilder>();

    //Vault'un tokeninin otomatik yenilenmesi ayarı
    vaultSecretBuilder.EnableTokenAutoRenew();

    vaultSecretBuilder.SetSecretKey("elastic-apm").Build();
}

Kullanım: Program.cs veya DependecyInjection.cs dosyanızda bu extension'ı çağırın:

builder.Services.AddVaultSecrets(builder.Configuration, builder.Configuration, environment);

Bu yöntem:

• Vault'tan elastic-apm secretını çeker
• Vault token'ının otomatik yenilenme özelliğini aktif eder
• Secrecleri uygulama konfigürasyonuna ekler

Tip Bazlı Secret ve Konfigürasyon Binding

Vault: SetSecretKey ve SetSecret<T>

• vaultSecretBuilder.SetSecretKey("sentry").Build();

  • Vault'tan "sentry" anahtarı altındaki secret'ı çeker ve konfigürasyona ekler.
  • Bu yöntemle secret'ı string anahtar ile manuel olarak belirtirsin.

• vaultSecretBuilder.SetSecret<StorageOptionsSecret>().Build();

  • StorageOptionsSecret adında bir sınıfın (veya record'un) Vault'tan otomatik olarak çekilmesini sağlar.
  • SetSecret<T>() fonksiyonu, generic tipin adını otomatik olarak Vault anahtarı olarak kullanır (örn. storage-options).
  • Ayrıca, ilgili secret'ı otomatik olarak DI container'a bind eder ve IOptions<StorageOptionsSecret> olarak enjekte edilebilir hale getirir.
  • Bu tipin IVaultSecret arayüzünü implemente etmesi gerekir.

Vault için tip bazlı binding örneği:

public class StorageOptionsSecret : IVaultSecret
{
    public string ConnectionString { get; set; }
    public string AccessKey { get; set; }
    // ... diğer secret alanları
}

// Kullanım:
vaultSecretBuilder.SetSecret<StorageOptionsSecret>().Build();
// Artık IOptions<StorageOptionsSecret> ile tip güvenli olarak erişebilirsin.

Consul: SetConfigurationKey ve SetConfiguration<T>

• consulConfigurationBuilder.SetConfigurationKey("mersel-sdk").Build();

  • Consul'dan "mersel-sdk" anahtarı altındaki konfigürasyonu çeker ve ekler.
  • Anahtar string olarak manuel verilir.

• consulConfigurationBuilder.SetConfiguration<EndpointnConfiguration>().Build();

  • EndpointnConfiguration adında bir sınıfın Consul'dan otomatik olarak çekilmesini sağlar.
  • SetConfiguration<T>() fonksiyonu, generic tipin adını otomatik olarak Consul anahtarı olarak kullanır (örn. e-transformation-configuration).
  • Ayrıca, ilgili konfigürasyonu otomatik olarak DI container'a bind eder ve IOptions<EndpointnConfiguration> olarak enjekte edilebilir hale getirir.
  • Bu tipin IConsulConfiguration arayüzünü implemente etmesi gerekir.

Consul için tip bazlı binding örneği:

public class EndpointnConfiguration : IConsulConfiguration
{
    public string Endpoint { get; set; }
    public int Timeout { get; set; }
    // ... diğer konfigürasyon alanları
}

// Kullanım:
consulConfigurationBuilder.SetConfiguration<EndpointnConfiguration>().Build();
// Artık IOptions<EndpointnConfiguration> ile tip güvenli olarak erişebilirsin.

Nasıl Çalışır?

• SetSecret<T> ve SetConfiguration<T> fonksiyonları, tip adını otomatik olarak Vault/Consul anahtarı olarak kullanır (Kebab-case'e çevirir).
• Ayrıca, ilgili tipin konfigürasyonunu/secret'ını DI container'a IOptions<T> olarak ekler.
• Bu sayede, uygulamanın herhangi bir yerinde tip güvenli olarak IOptions<T> ile erişim sağlanır.
• Eğer farklı bir anahtar veya farklı bir section kullanılacaksa, overload'lar ile bu özelleştirilebilir:
  • SetSecret<T>(string secretKey)
  • SetSecret<T>(string secretKey, string section)
  • SetConfiguration<T>(string consulKey)
  • SetConfiguration<T>(string consulKey, string section)

Tip Bazlı Kullanım

Vault için:

// Secret'ı doğrudan anahtar ile ekleme:
vaultSecretBuilder.SetSecretKey("sentry").Build();

// Tip bazlı secret binding:
vaultSecretBuilder.SetSecret<StorageOptionsSecret>().Build();
// Artık IOptions<StorageOptionsSecret> ile tip güvenli olarak erişebilirsin.

Consul için:

// Konfigürasyonu doğrudan anahtar ile ekleme:
consulConfigurationBuilder.SetConfigurationKey("mersel-sdk").Build();

// Tip bazlı konfigürasyon binding:
consulConfigurationBuilder.SetConfiguration<EndpointnConfiguration>().Build();
// Artık IOptions<EndpointnConfiguration> ile tip güvenli olarak erişebilirsin.

Not: Tip bazlı binding için ilgili tiplerin IVaultSecret veya IConsulConfiguration arayüzünü implemente etmesi gerekir.

Katkıda Bulunma

Katkı sağlamak için issue veya pull request açabilirsiniz.

Lisans

MIT Lisansı ile lisanslanmıştır.