BRP API Bewoning Proxy configuratie

De volgende settings van de BRP API Bewoning Proxy kunnen worden aangepast:

• Routering
• Logging
• mTLS

Routering

Standaard is de BRP API Bewoning Proxy geconfigureerd om bevragingen door te sturen naar de mock van de BRP API Bewoning Web API GBA variant.

De Downstream configuratie van de BRP API Bewoning Proxy moet worden aangepast om bevragingen door te sturen naar een andere instantie van de BRP API Bewoning Web API GBA variant.

Wijzigen van de Downstream configuratie van de Proxy (Docker Compose variant)

De volgende environment variabelen moet worden opgenomen in de configuratie van de Proxy in het docker compose bestand:

• Routes__0__DownstreamScheme. Het communicatieprotocol dat moet worden gebruikt voor het aanroepen van de BRP API Bewoning Web API GBA variant
• Routes__0__DownstreamHostAndPorts__0__Host. De host naam van de aan te roepen BRP API Bewoning Web API GBA variant
• Routes__0__DownstreamHostAndPorts__0__Port. De port nummer van de aan te roepen BRP API Bewoning Web API GBA variant

In het volgende voorbeeld is de Proxy geconfigureerd om bevragingen door te sturen naar de proef omgeving van de BRP API Bewoning Web API GBA variant

  bewoningproxy:
    container_name: bewoningproxy
    image: ghcr.io/brp-api/haal-centraal-bewoning-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:
      - "5003:5000"
    networks:
      - bewoningen-api-network

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 Bewoning Web API GBA variant gespecificeerd. Dit configuratie bestand is ook te vinden in de BRP API Bewoning GitHub repository.

{
  "Routes": [
    {
      "UpstreamPathTemplate": "/haalcentraal/api/bewoning/bewoningen",
      "DownstreamPathTemplate": "/haalcentraal/api/bewoning/bewoningen",
      "DownstreamScheme": "https",
      "DownstreamHostAndPorts": [
        {
          "Host": "proefomgeving-gba.haalcentraal.nl",
          "Port": "443"
        }
      ]
    }
  ]
}

Het configuratie bestand wordt vervolgens met behulp van een volume mount gemonteerd aan een BRP API Bewoning Proxy instantie. In onderstaand voorbeeld wordt het ocelot.json bestand in de src/config/BewoningProxy/configuration map gemonteerd aan een BRP API Bewoning Proxy instantie.

  bewoningproxy:
    container_name: bewoningproxy
    image: ghcr.io/brp-api/haal-centraal-bewoning-bevragen-proxy:latest
    environment:
      - ASPNETCORE_ENVIRONMENT=Release
      - ASPNETCORE_URLS=http://+:5000
    ports:
      - "5003:5000"
    volumes:
      - ./src/config/BewoningProxy/configuration/ocelot.json:/app/configuration/ocelot.json
    networks:
      - bewoningen-api-network

Wijzigen van de Downstream configuratie van de Proxy (Kubernetes variant)

De volgende environment variabelen moet worden opgenomen in de configuratie van de Proxy in het bewoning proxy deployment bestand:

• Routes__0__DownstreamScheme. Het communicatieprotocol dat moet worden gebruikt voor het aanroepen van de BRP API Bewoning Web API GBA variant
• Routes__0__DownstreamHostAndPorts__0__Host. De host naam van de aan te roepen BRP API Bewoning Web API GBA variant
• Routes__0__DownstreamHostAndPorts__0__Port. De port nummer van de aan te roepen BRP API Bewoning Web API GBA variant

In het volgende voorbeeld is de Proxy geconfigureerd om bevragingen door te sturen naar de proef omgeving van de BRP API Bewoning Web API GBA variant

      containers:
        - name: bewoningproxy
          image: ghcr.io/brp-api/haal-centraal-bewoning-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
              containerPort: 5000