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 Nexus 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 | For initial deployments, we recommend a processor with at least 8 CPU cores and 8GB of RAM. A minimum of 6GB of process space should be available to the IQ Server. Additional RAM can improve the performance due to decreased disk caching. Example: Dual Intel Xeon E5620 with 2.4Ghz, 12M Cache, 5.86 GT/s QPI, Turbo, HT. Users with more than 100 applications should be prepared to increase OS resources to 16 CPU cores and 16 GB of RAM. If your application count is exponentially larger, reach out to Support and your Customer Service rep to pinpoint your system resources requirements. |
Disk | Storage requirements range with the number of applications projected to use the IQ Server. 500 GB to 1 TB of free disk space should provide more than adequate resources. Monitoring disk-space usage will help you gauge the storage needs in your actual deployment and react to growing demands in time. The IQ Server is an I/O intensive application and disk speed will affect the performance of the IQ Server considerably. We recommend using local drives or SAN usage. Usage of network mapped storage via NFS or similar e.g. AWS EFS, GlusterFS is not supported. It is important to consider the I/O load when running IQ Server in a virtual machine, especially when other virtual machines on the same host are running other I/O intensive applications e.g. the Nexus Repository Manager. |
Database | Nexus IQ server comes with a preinstalled in-memory H2 database suitable for deployment instances consisting of less than 100 application scans on a regular basis. For larger instances, IQ Server can be configured to use an external PostgreSQL database (10.7 or newer, min. 8 CPUs/32GB RAM) on a low latency network. |
Operating System | Generally, any machine that can run a supported Sun/Oracle Java version should work. Refer to the Oracle documentation for specifics: Oracle JDK 8 and JRE 8 Certified System Configurations. The most widely used operating system for the IQ Server is Linux and therefore customers should consider it the best-tested platform. |
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:
|
Java | IQ Server or IQ CLI versions 88 and older: Latest available Java 8 is supported. IQ Server or IQ CLI versions 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. OpenJDK is officially supported since December 2018, IQ Server release 55. Prior to IQ Server release 63, the IQ Server used to check if the used JVM is supported. This check does not work for certain OpenJDK versions/flavors. You can disable this check by adding -Dclm.disableJreCheck=true to the command used to start the IQ Server. 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 |
Browser Requirements
Our general policy is to support the most recent modern browser version for your supported OS at the time of the IQ release date.
| Browser | Version |
|---|---|
| Edge | "Release" |
| Firefox |
|
| Chrome | "Stable" |
| Safari (on OSX) |
|
JavaScript must be enabled for the chosen browser.
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.