Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 2.61 KB

README.md

File metadata and controls

35 lines (26 loc) · 2.61 KB
Raw

FINT FLYT INSTANCE GATEWAY TEMPLATE

Overview

This template serves as a skeleton gateway with example code for creating specific instance-gateways in FINT Flyt. Its primary function is to handle POST requests containing data, which is then processed and published to other microservices through Kafka inside the FINT Flyt infrastructure.

Getting Started

To use this template, you need to customize it according to your specific requirements. Follow the steps below to configure and deploy your instance of the gateway.

Rename sourceApplication

The sourceApplication represents the data source sending information to this gateway (e.g., egrunnerverv, acos, rf13.50, etc.). Rename it throughout the project to reflect your specific source application.

  • Example: Rename fint-flyt-mysourceapplication-instance-gateway to fint-flyt-rf1350-instance-gateway.

Kustomize Configuration

Adjust the following setting in the base/flais.yaml: fint.flyt.resource-server.security.api.external.authorized-client-ids:

  • Set the sourceApplicationId provided by fint-flyt-authorization-service (the value should be an integer).
  • it ensures that requests coming from a specific client-id will only be allowed in if the ID is what fint-flyt-authorization-service says it should be.
  • this ID will be passed through FINT Flyt to ensure the data package received by this gateway belongs to the given SourceApplication

Application Configuration

Configure the application settings in src/main/resources/application-local-staging.yaml:

  • server.port:
  • When testing locally, select server port 81xx where xx is the sourceApplicationId (with leading zero) e.g. if sourceApplicationId is 3, the port would be 8103
  • also change fint.flyt.resource-server.security.api.external.authorized-client-ids here

Processing instances

You need to create an InstanceProcessor for each instance model that is to be processed. This is done using InstanceProcessorFactoryService. See example code in InstanceProcessorConfiguration. When creating an InstanceProcessor, you need to provide an implementation of InstanceMapper. The mapper is used to convert the incoming model to the internal InstanceObject model in Fint Flyt. See example code in IncomingInstanceMappingService.

Additional Documentation

For more detailed instructions on setting up and deploying your instance of the FINT FLYT gateway, refer to the documentation: https://fintlabs.atlassian.net/wiki/spaces/FINTKB/pages/379355169/FINT+Flyt+Arkitektur+event+driven

This is also where you document the SourceApplication (data models, requests, endpoints etc)