System Requirements
Need Cloud? While any customer can deploy IQ Server to the cloud, Sonatype also offers a managed cloud option. Visit our sales page here to learn more.
Already a Sonatype Lifecycle Cloud customer? Check out documentation specific to that product here.
Overview
The IQ Server is typically deployed on dedicated hardware. More specific hardware requirements are ultimately a function of the deployment architecture, the primary usage patterns, and the scale of deployment. With these influencing factors in mind, what follows here should be understood as guidelines. Your actual requirements may be different.
Development, test, or evaluation deployments can be scaled smaller than these recommendations and will continue to function, though performance degradation may be observed.
Installation Requirements
| Item | Description |
|---|---|
CPU and RAM | We recommend at least 8 CPU cores and 16 GB of RAM. A minimum of 6GB of process space should be available to the IQ Server. Additional RAM will improve the performance due to decreased disk caching. Deployments with 100 applications or more should be prepared to increase OS resources to 16 CPU cores and 32 GB of RAM. Examples: Dual Intel Xeon E5620 with 2.4Ghz, 12M Cache, 5.86 GT/s QPI, Turbo, HT See more on Estimating Heap Sizes. |
Database | Nexus IQ server is preinstalled with an in-memory H2 database suitable for deployments with less than 100 applications. For larger instances (>10GB), IQ Server should be configured to use an external PostgreSQL database or a PostgreSQL-compatible service on a low latency network. PostgreSQL
|
Disk | We recommend starting with 500 GB to 1 TB of free disk space. Storage requirements range with the number of applications and the frequency of reports being generated. Use Data Retention and Purging to keep resources requirements within this range. H2: The IQ Server's internal H2 database is I/O intensive and disk speed will considerably affect performance. We recommend using local drives or SAN usage. Usage of network mapped storage via NFS or GlusterFS is not supported. Consider the I/O load when running in a virtual environment and avoid running other services on the same host. PostgreSQL: IQ Server deployments configured for PostgreSQL may use network storage via NFSv4.1 or similar e.g. AWS EFS. NFS example: -o vers=4.2, noatime, nodiratime, rsize=1048576, wsize=1048576, timeo=600, retrans=2 |
Operating Systems |
|
User Account | It is recommended that an unprivileged service account be created if running the IQ Server as a daemon. |
Ports | The IQ Server requires the following network access. Inbound ( configurable ):
Outbound:
|
Supported Java Versions | IQ Server or IQ CLI release 89 and newer: Latest available Java 8 and 11 are supported. Versions of Java 11 older than 11.0.3 are known to have incompatibility issues and should not be used. IQ Server or IQ CLI release 88 and older: Latest available Java 8 is supported. OpenJDK 8 is officially supported since IQ Server release 63 and newer. Larger Java heap sizes will increase performance and stability. For initial deployments, set the maximum heap size to half of the capacity of your OS RAM with |
Cloud Installation Requirements
For Amazon EC2 - Secure Cloud Services
| Item | Description |
|---|---|
| EC2 Instance Type | m5d.2xlarge |
| JVM parameters | -Xms24G -Xmx24G -XX:+UseG1GC |
| Database | Postgres dbms running on a AWS RDS instance (Postgres RDS instance is of the type db.m5.4xlarge, version 10.20, gp2 type) |
Browser Requirements
Sonatype IQ Server supports the latest version of your OS supported browser at the time of release date.
| Browser | Version |
|---|---|
| Edge | "Release" |
| Firefox |
|
| Chrome | "Stable" |
| Safari (on OSX) |
|
For best experience:
- Enable JavaScript for all web browsers.
- Configure your browser settings to allow notifications from Sonatype sites. You will receive browser notifications when your authenticated session is about to expire and prevent unintended logouts. To learn more about configuring session timeout values for IQ Server, refer to Configuration REST API.
REST API Requirements
The IQ Server REST APIs are versioned. As a best practice, we recommend using the latest version of the IQ Server in addition to the latest version of the REST APIs. This ensures your system will take advantage of the latest features and improvements.
However, we also realize that users of previous versions need to maintain this compatibility even when there is an update. For this reason, we do provide support for previous versions based on the criteria below.
Supported API Versions:
- Sonatype CLM 1.12 and earlier - Only Supports REST API v1
- Sonatype CLM 1.13 and later - Supports both REST API v1 and v2
- IQ Server 1.17 to 1.22 - Recommend usage of v2 REST API only.
- IQ Server 1.23 and later - Only Supports REST API v2.
Identifying the version of the API is simple. Below we have provided an example using the REST API for retrieval of an organization ID:
http://localhost:8070/api/v2/organizations
As you can see, the v2 located just after api indicates the version of the API. If you find that the API version you are using is not documented, and would like information on upgrading to the latest version you can contact our support team for assistance.