De volgende settings van de BrpProxy kunnen worden aangepast:
Standaard is de BrpProxy geconfigureerd om bevragingen door te sturen naar de mock van de BRP API Personen Web API GBA variant.
De Downstream configuratie van de BrpProxy moet worden aangepast om bevragingen door te sturen naar een andere instantie van de BRP API Personen Web API GBA variant.
De volgende environment variabelen moet worden opgenomen in de configuratie van de BrpProxy in het docker compose bestand:
In het volgende voorbeeld is de BrpProxy geconfigureerd om bevragingen door te sturen naar de proef omgeving van de BRP API Personen Web API GBA variant
brpproxy:
container_name: brpproxy
image: ghcr.io/brp-api/haal-centraal-brp-bevragen-proxy:latest
environment:
- ASPNETCORE_ENVIRONMENT=Release
- ASPNETCORE_URLS=http://+:5000
- Routes__0__DownstreamScheme=https
- Routes__0__DownstreamHostAndPorts__0__Host=proefomgeving-gba.haalcentraal.nl
- Routes__0__DownstreamHostAndPorts__0__Port=443
ports:
- "5001:5000"
networks:
- brp-api-network
Een andere mogelijkheid is om de routering configuratie te definieren in een json bestand en met behulp van een Volume te monteren aan een container instantie.
In het volgende voorbeeld is de configuratie van de routering naar de proef omgeving van de BRP API Personen Web API GBA variant gespecificeerd. Dit configuratie bestand is ook te vinden in de BRP API Personen GitHub repository.
{
"Routes": [
{
"UpstreamPathTemplate": "/haalcentraal/api/brp/personen",
"DownstreamPathTemplate": "/haalcentraal/api/brp/personen",
"DownstreamScheme": "https",
"DownstreamHostAndPorts": [
{
"Host": "proefomgeving-gba.haalcentraal.nl",
"Port": "443"
}
]
}
]
}
Het configuratie bestand wordt vervolgens met behulp van een volume gemonteerd aan een BrpProxy instantie. In onderstaand voorbeeld wordt het ocelot.json bestand in de src/config/BrpProxy/configuration map gemonteerd aan een BrpProxy instantie.
brpproxy:
container_name: brpproxy
image: iswish/haal-centraal-brp-bevragen-proxy:latest
environment:
- ASPNETCORE_ENVIRONMENT=Release
- ASPNETCORE_URLS=http://+:5000
ports:
- "5001:5000"
volumes:
- ./src/config/BrpProxy/configuration/ocelot.json:/app/configuration/ocelot.json
De volgende environment variabelen moet worden opgenomen in de configuratie van de BrpProxy in het brpproxy deployment bestand:
In het volgende voorbeeld is de BrpProxy geconfigureerd om bevragingen door te sturen naar de proef omgeving van de BRP API Personen Web API GBA variant
containers:
- name: brpproxy
image: iswish/haal-centraal-brp-bevragen-proxy:latest
env:
- name: ASPNETCORE_ENVIRONMENT
value: Release
- name: ASPNETCORE_URLS
value: http://+:5000
- name: Routes__0__DownstreamScheme
value: https
- name: Routes__0__DownstreamHostAndPorts__0__Host
value: proefomgeving-gba.haalcentraal.nl
- name: Routes__0__DownstreamHostAndPorts__0__Port
value: "443"
ports:
- name: http-brpproxy
containerPort: 5000
Een andere mogelijkheid is om de routering configuratie te definieren in een json bestand en met behulp van een volume mount te monteren aan een container instantie.
In het volgende voorbeeld is de configuratie van de routering naar de proef omgeving van de BRP API Personen Web API GBA variant gespecificeerd. Dit configuratie bestand is ook te vinden in de BRP API Personen GitHub repository.
{
"Routes": [
{
"UpstreamPathTemplate": "/haalcentraal/api/brp/personen",
"DownstreamPathTemplate": "/haalcentraal/api/brp/personen",
"DownstreamScheme": "https",
"DownstreamHostAndPorts": [
{
"Host": "proefomgeving-gba.haalcentraal.nl",
"Port": "443"
}
]
}
]
}
Het configuratie bestand wordt vervolgens met behulp van een volume mount gemonteerd aan een BrpProxy instantie. In onderstaand voorbeeld wordt het ocelot.json bestand in de src/config/BrpProxy/configuration map gemonteerd aan een BrpProxy instantie.
containers:
- name: brpproxy
image: iswish/haal-centraal-brp-bevragen-proxy:latest
env:
- name: ASPNETCORE_ENVIRONMENT
value: Release
- name: ASPNETCORE_URLS
value: http://+:5000
ports:
- name: http-brpproxy
containerPort: 5000
volumeMounts:
- name: brpproxy-routing-configuration
mountPath: /app/configuration
volumes:
- name: brpproxy-routing-configuration
hostPath:
path: <host-path>/Haal-Centraal-BRP-bevragen/src/config/BrpProxy/configuration
waarbij host-path gelijk is aan
Standaard is de BrpProxy geconfigureerd met Log level Warning. Bij deze Log level wordt alleen ongeldige bevragingen (bevraging die resulteren in een 4XX en 5XX HTTP status response) gelogd.
Om alle bevragingen (inclusief de request body) te loggen moet de Log level op Information worden gezet. Dit wordt gedaan met behulp van de Serilog__MinimumLevel__Override__BrpProxy environment variabele.
In de volgend voorbeelden is de Log level gezet op Information
Docker Compose variant:
brpproxy:
container_name: brpproxy
image: iswish/haal-centraal-brp-bevragen-proxy:latest
environment:
- ASPNETCORE_ENVIRONMENT=Release
- ASPNETCORE_URLS=http://+:5000
- Serilog__MinimumLevel__Override__BrpProxy=Information
ports:
- "5001:5000"
Kubernetes variant
containers:
- name: brpproxy
image: iswish/haal-centraal-brp-bevragen-proxy:latest
env:
- name: ASPNETCORE_ENVIRONMENT
value: Release
- name: ASPNETCORE_URLS
value: http://+:5000
- name: Serilog__MinimumLevel__Override__BrpProxy
value: Information
ports:
- name: http-brpproxy
containerPort: 5000
Bij Log level Information worden de waarden van gevoelige parameters in de request body gemaskeerd gelogd. Voor debug doeleinden kan het nodig zijn om de waarden van gevoelige parameters niet gemaskeerd te loggen. Dit kan worden gedaan door de Log level op Debug te zetten.
De logs zijn standaard te vinden in de Logs tab blad van de BrpProxy container. Optioneel kunnen de logs ook worden weggeschreven naar een Seq server en/of naar een log bestand volgens de Elastic Common Schema specificatie.
De Seq__ServerUrl environment variabele moeten worden gebruikt om log regels weg te schrijven naar een Seq server. Met het docker compose bestand in de BRP API Personen repository wordt standaard ook een Seq server opgestart waar de BrpProxy zijn log regels wegschrijft.
Met behulp van de Ecs__Path environment variabele wordt het volledig pad van het log bestand opgegeven waar log regels volgens de Elastic Common Schema specificatie worden weggeschreven.
De BrpProxy maakt gebruik van OpenTelemetry om de start en eind tijden van aanroepen weg te schrijven. De BrpProxy gebruikt de standaard configuratie settings van Jaeger om traces te schrijven naar een Jaeger server met behulp van de OpenTelemetry Protocol (OTLP).
Een Jaeger server wordt standaard opgestart wanneer het docker compose bestand in de BRP API Personen repository wordt gebruikt om de BrpProxy te draaien. De traces kunnen dan worden bekeken via de Jaeger UI die is te benaderen op http://localhost:16686.
De Jaeger__OtlpEndpoint environment variabele kan worden gebruikt om de OTLP endpoint waar de BrpProxy naar schrijft te wijzigen.