tnc1997/azure-app-configuration-emulator

Azure App Configuration模拟器

!https://img.shields.io/docker/pulls/tnc1997/azure-app-configuration-emulator?link=https%3A%2F%2Fhub.docker.com%2Fr%2Ftnc1997%2Fazure-app-configuration-emulator !https://img.shields.io/docker/stars/tnc1997/azure-app-configuration-emulator?link=https%3A%2F%2Fhub.docker.com%2Fr%2Ftnc1997%2Fazure-app-configuration-emulator

请注意：Azure App Configuration模拟器是非官方的，且未获得微软认可。

开始使用

shell
docker pull tnc1997/azure-app-configuration-emulator
docker run -p 8080:8080 tnc1997/azure-app-configuration-emulator

认证

模拟器支持HMAC认证和Microsoft Entra ID认证。

HMAC

可通过环境变量Authentication__Schemes__Hmac__Credential和Authentication__Schemes__Hmac__Secret分别覆盖凭证和密钥。

yaml
services:
  azure-app-configuration-emulator:
    environment:
      - Authentication__Schemes__Hmac__Credential=xyz
      - Authentication__Schemes__Hmac__Secret=c2VjcmV0
    image: tnc1997/azure-app-configuration-emulator

.NET

客户端可使用模拟器的连接字符串进行请求认证。

csharp
using Azure.Data.AppConfiguration;

var connectionString = Environment.GetEnvironmentVariable("ConnectionStrings__AzureAppConfiguration");
var client = new ConfigurationClient(connectionString);

var setting = new ConfigurationSetting("AzureAppConfigurationEmulator", "Hello World");
await client.SetConfigurationSettingAsync(setting);

yaml
services:
  azure-app-configuration-emulator:
    image: tnc1997/azure-app-configuration-emulator
  console-application:
    build:
      context: .
      dockerfile: ./ConsoleApplication/Dockerfile
    depends_on:
      - azure-app-configuration-emulator
    environment:
      - ConnectionStrings__AzureAppConfiguration=Endpoint=http://azure-app-configuration-emulator:8080;Id=abcd;Secret=c2VjcmV0;

Postman

可使用以下脚本生成认证相关头信息：

javascript
const credential = "abcd";
const secret = "c2VjcmV0";

const date = new Date().toUTCString();
const contentHash = CryptoJS.SHA256(CryptoJS.enc.Utf8.parse(pm.request.body.toString())).toString(CryptoJS.enc.Base64);

const signedHeaders = "x-ms-date;Host;x-ms-content-sha256";
const stringToSign = `${pm.request.method}\n${pm.request.url.getPathWithQuery()}\n${date};${pm.request.url.getRemote()};${contentHash}`;
const signature = CryptoJS.HmacSHA256(CryptoJS.enc.Utf8.parse(stringToSign), CryptoJS.enc.Base64.parse(secret)).toString(CryptoJS.enc.Base64);

pm.request.headers.upsert(`x-ms-date: ${date}`);
pm.request.headers.upsert(`x-ms-content-sha256: ${contentHash}`);
pm.request.headers.upsert(`Authorization: HMAC-SHA256 Credential=${credential}&SignedHeaders=${signedHeaders}&Signature=${signature}`);

Microsoft Entra ID

Microsoft Entra ID认证允许使用托管标识模拟基于Azure的生产环境。

https://github.com/nagyesta/assumed-identity%E6%98%AF%E4%B8%80%E4%B8%AA%E7%AE%80%E5%8D%95%E7%9A%84%E6%B5%8B%E8%AF%95%E6%9B%BF%E8%BA%AB%EF%BC%8C%E6%A8%A1%E6%8B%9FAzure%E5%AE%9E%E4%BE%8B%E5%85%83%E6%95%B0%E6%8D%AE%E6%9C%8D%E5%8A%A1(IMDS)%E5%A4%84%E7%90%86%E6%89%98%E7%AE%A1%E6%A0%87%E8%AF%86%E4%BB%A4%E7%89%8C%E7%9A%84%E6%96%B9%E5%BC%8F%E3%80%82

必须通过环境变量Authentication__Schemes__MicrosoftEntraId__MetadataAddress设置元数据地址。

yaml
services:
  assumed-identity:
    image: nagyesta/assumed-identity
  azure-app-configuration-emulator:
    depends_on:
      - assumed-identity
    environment:
      - ASPNETCORE_HTTP_PORTS=8080
      - ASPNETCORE_HTTPS_PORTS=8081
      - Authentication__Schemes__MicrosoftEntraId__MetadataAddress=http://assumed-identity/metadata/identity/.well-known/openid-configuration
      - Authentication__Schemes__MicrosoftEntraId__RequireHttpsMetadata=false
      - Kestrel__Certificates__Default__Path=/usr/local/share/azureappconfigurationemulator/emulator.crt
      - Kestrel__Certificates__Default__KeyPath=/usr/local/share/azureappconfigurationemulator/emulator.key
    image: tnc1997/azure-app-configuration-emulator
    volumes:
      - ./emulator.crt:/usr/local/share/azureappconfigurationemulator/emulator.crt:ro
      - ./emulator.key:/usr/local/share/azureappconfigurationemulator/emulator.key:ro

.NET

客户端可使用托管标识进行请求认证。

csharp
using Azure.Data.AppConfiguration;
using Azure.Identity;

var endpoint = Environment.GetEnvironmentVariable("Endpoints__AzureAppConfiguration");
var credential = new ManagedIdentityCredential();
var client = new ConfigurationClient(new Uri(endpoint), credential);

var setting = new ConfigurationSetting("AzureAppConfigurationEmulator", "Hello World");
await client.SetConfigurationSettingAsync(setting);

yaml
services:
  assumed-identity:
    image: nagyesta/assumed-identity
  azure-app-configuration-emulator:
    depends_on:
      - assumed-identity
    environment:
      - ASPNETCORE_HTTP_PORTS=8080
      - ASPNETCORE_HTTPS_PORTS=8081
      - Authentication__Schemes__MicrosoftEntraId__MetadataAddress=http://assumed-identity/metadata/identity/.well-known/openid-configuration
      - Authentication__Schemes__MicrosoftEntraId__RequireHttpsMetadata=false
      - Kestrel__Certificates__Default__Path=/usr/local/share/azureappconfigurationemulator/emulator.crt
      - Kestrel__Certificates__Default__KeyPath=/usr/local/share/azureappconfigurationemulator/emulator.key
    image: tnc1997/azure-app-configuration-emulator
    volumes:
      - ./emulator.crt:/usr/local/share/azureappconfigurationemulator/emulator.crt:ro
      - ./emulator.key:/usr/local/share/azureappconfigurationemulator/emulator.key:ro
  console-application:
    build:
      context: .
      dockerfile: ./ConsoleApplication/Dockerfile
    depends_on:
      - assumed-identity
      - azure-app-configuration-emulator
    entrypoint: /bin/sh -c "update-ca-certificates && dotnet ConsoleApplication.dll"
    environment:
      - Endpoints__AzureAppConfiguration=https://azure-app-configuration-emulator:8081
    volumes:
      - ./emulator.crt:/usr/local/share/ca-certificates/emulator.crt:ro

兼容性

模拟器兼容以下操作：

键值

键

标签

锁

修订版

数据

模拟器使用SQLite数据库存储配置设置。

可通过卷实现会话间数据持久化：

yaml
services:
  azure-app-configuration-emulator:
    image: tnc1997/azure-app-configuration-emulator
    volumes:
      - azure-app-configuration-emulator:/var/lib/azureappconfigurationemulator
volumes:
  azure-app-configuration-emulator:

可通过环境变量ConnectionStrings__DefaultConnection覆盖数据库连接字符串：

yaml
services:
  azure-app-configuration-emulator:
    environment:
      - ConnectionStrings__DefaultConnection=Data Source=/var/lib/azureappconfigurationemulator/emulator.db
    image: tnc1997/azure-app-configuration-emulator

可将预填充数据的数据库挂载到容器，但需确保数据库具有所需架构：

yaml
services:
  azure-app-configuration-emulator:
    image: tnc1997/azure-app-configuration-emulator
    volumes:
      - ./emulator.db:/var/lib/azureappconfigurationemulator/emulator.db

消息传递

模拟器与Azure Event Grid集成，当配置设置被删除或修改时，使用Event Grid事件架构发布事件。

可通过环境变量Messaging__EventGridTopics__xyz__Endpoint和Messaging__EventGridTopics__xyz__Credential__Key分别设置Event Grid主题的端点和密钥，其中xyz为任意名称。

yaml
services:
  azure-app-configuration-emulator:
    environment:
      - Messaging__EventGridTopics__Contoso__Credential__Key=a2V5
      - Messaging__EventGridTopics__Contoso__Endpoint=https://contoso.uksouth-1.eventgrid.azure.net/api/events
    image: tnc1997/azure-app-configuration-emulator

可观测性

模拟器集成OpenTelemetry以提供指标和跟踪。

可通过环境变量OTEL_EXPORTER_OTLP_ENDPOINT覆盖OpenTelemetry协议(OTLP)导出器的端点：

yaml
services:
  azure-app-configuration-emulator:
    depends_on:
      - opentelemetry-collector
    environment:
      - OTEL_EXPORTER_OTLP_ENDPOINT=http://opentelemetry-collector:4317
    image: tnc1997/azure-app-configuration-emulator
  opentelemetry-collector:
    image: otel/opentelemetry-collector-contrib

SSL / TLS

模拟器可配置为使用自签名证书通过HTTPS提供请求服务。

shell
openssl req -x509 -out ./emulator.crt -keyout ./emulator.key -newkey rsa:2048 -nodes -sha256 -subj '/CN=azure-app-configuration-emulator' -addext 'subjectAltName=DNS:azure-app-configuration-emulator'

必须通过环境变量ASPNETCORE_HTTPS_PORTS设置HTTPS端口。

必须通过环境变量Kestrel__Certificates__Default__Path和Kestrel__Certificates__Default__KeyPath分别设置证书和密钥的路径。

证书和密钥必须挂载到容器中上述设置的路径。

yaml
services:
  azure-app-configuration-emulator:
    environment:
      - ASPNETCORE_HTTP_PORTS=8080
      - ASPNETCORE_HTTPS_PORTS=8081
      - Kestrel__Certificates__Default__Path=/usr/local/share/azureappconfigurationemulator/emulator.crt
      - Kestrel__Certificates__Default__KeyPath=/usr/local/share/azureappconfigurationemulator/emulator.key
    image: tnc1997/azure-app-configuration-emulator
    volumes:
      - ./emulator.crt:/usr/local/share/azureappconfigurationemulator/emulator.crt:ro
      - ./emulator.key:/usr/local/share/azureappconfigurationemulator/emulator.key:ro

Testcontainers

模拟器与Testcontainers集成，便于对使用Azure App Configuration的应用进行集成测试。

csharp
var container = new ContainerBuilder()
    .WithImage("tnc1997/azure-app-configuration-emulator:1.0")
    .WithPortBinding(8080, true)
    .WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged("Now listening on"))
    .Build();

await container.StartAsync();

var client = new ConfigurationClient($"Endpoint={new UriBuilder(Uri.UriSchemeHttp, container.Hostname, container.GetMappedPublicPort(8080))};Id=abcd;Secret=c2VjcmV0");

await client.SetConfigurationSettingAsync(nameof(ConfigurationSetting.Key), nameof(ConfigurationSetting.Value));

var response = await client.GetConfigurationSettingAsync(nameof(ConfigurationSetting.Key));

即将推出 https://github.com/testcontainers/testcontainers-dotnet/issues/1198

csharp
var container = new AzureAppConfigurationBuilder().Build();

await container.StartAsync();

var client = new ConfigurationClient(container.GetConnectionString());

await client.SetConfigurationSettingAsync(nameof(ConfigurationSetting.Key), nameof(ConfigurationSetting.Value));

var response = await client.GetConfigurationSettingAsync(nameof(ConfigurationSetting.Key));