X-Road icon indicating copy to clipboard operation
X-Road copied to clipboard

As a Product Owner I want that the memory allocated for Proxy component will be automatically adjusted at init phase of Security Server to correlate the amount of RAM memory to optimize the performance

Open raits opened this issue 2 years ago • 0 comments

By default, the Proxy component is using heap memory at a minimum 100Mb and at a maximum 150Mb (-Xms100m -Xmx150m). This is too small for a virtual machine/server that has more memory than 1G RAM. By setting the Proxy's memory too small, it is limiting the performance of the Security Server in most cases.

The amount of RAM memory should be used as a base factor when deciding the amount of memory allocated for the Proxy component.

During the implementation of this ticket, the automatic detection of RAM memory and automatic Proxy memory allocation will be done.

Basic recommend settings for Proxy (and Signer) memory based on the amount of RAM are published at: https://nordic-institute.atlassian.net/wiki/display/XRDKB/Recommended+Memory+Allocation+for+Proxy

The JIRA ticket this issue was created from can be found here: https://nordic-institute.atlassian.net/browse/XRDDEV-55

Acceptance criteria:

  • [ ] Proxy memory allocation will be automatically decided by Security Server software based on the amount of RAM.
  • [ ] Users can override automatic memory allocation manually.
  • [ ] Automatic memory allocation can not be less than a defined minimum value, and it cannot be more than a defined maximum value.
  • [ ] Minimum and maximum values are hard coded in the software.
  • [ ] All installed extensions (e.g., operational monitoring) and their memory requirements must be taken into account when dynamic memory allocation for the Proxy is implemented.
  • [ ] The Security Server user manual is updated with information on how the automatic allocations work and how to override them.
    • [ ] https://github.com/nordic-institute/X-Road/blob/develop/doc/Manuals/ig-ss_x-road_v6_security_server_installation_guide.md
    • [ ] https://github.com/nordic-institute/X-Road/blob/develop/doc/Manuals/ig-ss_x-road_v6_security_server_installation_guide_for_rhel.md
    • [ ] https://github.com/nordic-institute/X-Road/blob/develop/doc/Manuals/ug-ss_x-road_6_security_server_user_guide.md

raits avatar Sep 22 '22 07:09 raits