vidakovic commented on code in PR #2644: URL: https://github.com/apache/fineract/pull/2644#discussion_r992021293
########## fineract-doc/src/docs/en/chapters/architecture/api-performance.adoc: ########## @@ -0,0 +1,115 @@ += Introducing Performance Enhancing Read/Write/Batch API Operation Separation + +Fineract is introducing performance enhancing read/write/batch API operation +separation. + +Now, Fineract has three different instance types: + +* Read instance +* Write instance +* Batch instance + +In cases where Fineract has to deal with high load, it can cause a performance +problem for a single Fineract instance. To overcome this problem, Fineract +instances can be started in different instance types for better scalability and +performance in a multi-instance environment: + +Detailed documentation on instance types can be found in this document: +https://github.com/apache/fineract/blob/develop/fineract-doc/src/docs/en/chapters/deployment/instance-type.adoc + +The linked document also explains deployment steps and specifications. + += Background + +Instances, where we're planning to deploy Fineract to a highly-available setup +with the highest-throughput because we can scale individual parts of it. + +Reading data happens much more often than actually writing data so the ability +to do this type of deployment will greatly improve what we can achieve in terms +of performance. + +Also, with the separation in place, we could utilize read-replica databases as +well where write and batch instances connect to a master DB and the read +instances connect to read-replicas therefore reducing the load on the database +as well. + +All three instances come with different types of restrictions in terms of what +they are capable of. For example a read instance is going to be only capable of +serving read (GET) APIs. Write APIs will be able to serve both read and write +APIs. Batch instance is only able to serve batch job related APIs and run the +batch jobs themselves. + += Context + +== Instance types + +**Read instance** only accepts `GET` request. Optionally, there are +database connection details for this mode. + +**Write instance** accepts `GET/POST/PUT/DELETE` requests. It uses the +original database connection details. + +**BATCH instance** accepts `POST` request related to run jobs. It will start the +Quartz scheduler at startup time and run the batch jobs. + +== Modes + +* Full mode (default) +* Read mode +* Write mode +* Batch mode + += Setup + +== Environment Variables + +Using environment variables, the three instance types performance enhancing Review Comment: Please no manual line breaks... see also other parts of the doc -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
