Skip to main content
Delphix

Masking Engine Configuration Best Practices (KBA1822)

 

This article details the Best Practice for Masking Engine Configuration. 

Document Scope 

Detailed in this document are: 

  • Rule Set Configuration.
  • Masking Job configuration. 
  • Windows SFTP Server.

 

Masking Engine Platfrom Requirements

The masking engine is supported on a number of different virtual server platforms, such as: 

  • VMware Virtual Platform
  • AWS EC2 Platform
  • Azure Platform

The requirements listed below are for VMware but applies also to the other platforms (though sizing options might be specific for each platform).

  • Virtual CPUs: (minimum) 8v CPUs
  • Virtual Memory:
    • (minimum): 16GB vRAM
    • (recommeded): 32GB vRAM
  • System Disk Storage:
    • 300GB

Warning

Warning:

Do not allocate all memory to the Delphix Masking Engine

Never allocate all available physical memory to the Delphix VM. You must set aside memory for the ESX Server to perform hypervisor activities before you assign memory to Delphix and other VMs. The default ESX minimum free memory requirement is 6% of total RAM. When free memory falls below 6%, ESX starts swapping out the Delphix guest OS. We recommend leaving about 8-10% free to avoid swapping

For example, when running on an ESX Host with 512GB of physical memory, allocate no more than 470GB (92%) to the Delphix VM (and all other VMs on that host).

 

Warning

Warning:

Always configure the Masking Engine as a Masking Engine.

Do never run it in the Combined configuration (Masking Engine running on an active Virtualization Engine).

This configuration is unsupported. 

Memory Requirements

The minimum memory configuration for the Masking Engine is 16 GB, however, more memory could be needed.

How much memory is needed depends on:

  • Virtualization Platform: 10%
  • The Engine:
    • OS: 2 GB
    • Masking Engine (ME): (default) 1 GB
    • Room to move (extra): 1 GB
  • Masking Job (Max):
    • The Max memory for each job running at the same time.
       

The amount of RAM needed is, therefore:

(OS + ME + Extra + Sum(Max for each Job running)) * 1.1

Example:

  • Three jobs: Max = 4GB, 4GB and 8 GB
(2 GB + 1 GB + 1 GB + (4 GB + 4 GB + 8 GB)) * 1.1 = 22 GB

Warning

Warning:

If Java fails to allocate memory it will either report an error message, crash and could see the masking stack being restarted (and with that all running jobs).

To ensure that this is not happening, Max memory needs to be used in the estimates. 

 

 


Related Articles

The following articles may provide more information or related information to this article: