Skip to main content
Version: 96.1

System requirements

Dependencies​

Factor Platform is provided as either a single Docker container or a JAR file (Java 25+).

Factor Platform has two external dependencies:

  • (Optional) A primary Kafka cluster with topics that store snapshot, metrics and an audit log.
  • A PostgreSQL database (>=14) that stores Platform-specific configuration (such as Lineage metadata)

Memory and CPU​

We recommend 8GB memory and 2 CPU for a production installation but encourage you to experiment with constraining resources as much as possible.

Factor Platform requires minimum heap of 512MB to start running, 2GB should be suitable for small / dev environments.

Factor Platform runs on both the amd64 and arm64 platforms.

Memory constraints​

Our Docker container starts the JAR file with initial and max memory constraints set to 80% of the resources provided to the container.

CMD java -XX:InitialRAMPercentage=80 -XX:MaxRAMPercentage=80 -jar /opt/factorhouse/lib/factor-platform.jar

Make sure you to set the memory available to the container on startup (-m4G in this case):

docker run -p 3000:3000 -m4G --env-file ./platform.env factorhouse/platform:latest

If running in Kubernetes ensure that your pod resources are set. Preferably run with pod QOS class guaranteed by setting both the min and max memory and CPU to the same desired values.

When using the JAR file directly ensure you set suitable memory constraints with -Xmx and -Xms:

BOOTSTRAP="your-bootstrap-url" java -Xms4G -Xmx4G -jar ./factor-platform-latest.jar

Failing to set memory constraints may cause Factor Platform to consume more memory than required.

Disk space​

Factor Platform does not use local disk so does not require any particular storage beyond configuration.

Network​

Factor Platform must be installed in proximity to your resources as network latency can impact the ability to snapshot and compute telemetry.

Multi-Region Multi-Cluster installations are not officially supported, though we are aware users have configured such installations with some success.

Database​

You need a database to use Factor Platform. Currently, the only supported database is PostgreSQL (>=14).

See the Configuration section for more details including instructions on how to prepare your database for use with Factor Platform.