Documentation Nexus IQ Server 1.26

Our documentation site has moved. For the most current version, please see http://help.sonatype.com

3.2. Installation Requirements

Each Nexus tool has a specific set of installation requirements, which are gathered here for reference.

  • IQ Server
  • Nexus IQ CLI
  • Nexus IQ for Bamboo
  • Sonatype CLM for Eclipse
  • IQ for IDEA
  • Nexus IQ for Hudson/Jenkins 1.x
  • Sonatype CLM for Maven
  • IQ for Nexus Repository Manager
  • Sonatype CLM for SonarQube

3.2.1. IQ Server

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, a general recommendation is provided as a starting point.

Development, test or evaluation deployments can be scaled smaller than the recommendations and will continue to function, while performance degradation may be observed.

CPU and RAM

We recommend a processor with at least 8 CPU cores and 8GB of RAM for initial setup. 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.

As an example a IQ Server deployment at Sonatype is using a Dual Intel Xeon E5620 with 2.4Ghz, 12M Cache, 5.86 GT/s QPI, Turbo, HT.

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.

[Tip]

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 therefore recommend to use local drives or SAN usage. Usage of network mapped storage via NFS or similar is not recommended. 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.

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 1.7 to 1.8 and JRE 1.7 to 1.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.
Ports

The following ports are used for communication and should be addressed according to your network firewall configuration.

8070
Used by all IQ Server clients to access the IQ Server. This port is configurable.
8071
Used by the local host or other IT monitoring tools for monitoring and operating functions. This port is optional and configurable. If omitted port 8081 will be used.
443
Used by the IQ Server to securely access Sonatype Data Services. This port is not configurable.
Java
Oracle Java 1.7 to 1.8 64 bit

3.2.2. IQ Server Web Application

Browser

In all cases JavaScript must be enabled for the chosen browser.

Internet Explorer
  • IE 9
  • IE 10
  • IE 11
Firefox
Chrome
“Stable”
Safari (On OSX)
  • 5.1.9 corresponding to OS X 10.6
  • 6.0.4 corresponding to OS X 10.7 and 10.8
  • 7.1 corresponding to OS 10.9

3.2.3. REST API Versioning

The IQ Server REST APIs are versioned. As a best practice we recommend using the latest version of the IQ Server and 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.

3.2.4. Nexus IQ CLI

The Nexus IQ CLI requires Java to be installed on the machine running the application, supports version 1.6 to 1.8.

3.2.5. Sonatype CLM for Eclipse Requirements

General Requirements , Eclipse
3.6 (Helios) to 4.6 (Neon)
m2e
(currently supports 1.0 - 1.7.0)
Java
Oracle Java 7 update 6 or newer (7u6+)

Browser Requirements:

In most cases the Eclipse plugin will render browser content using its own browser widget based on JavaFX.

Where JavaFX is not available the plugin will use the system browser. To properly render content the minimum requirement is Internet Explorer (IE) 9, or another modern browser such as Chrome / Firefox.

[Note]

Sonatype CLM functionality is not supported for those running Sonatype CLM for Eclipse with Internet Explorer 8.

[Warning]

These requirements assume an installation of the currently released version of the Eclipse plugin and the compatible IQ Server. Before picking a version please verify compatibility.

3.2.6. IQ for IDEA Requirements

General Requirements , IntelliJ IDEA
  • 14.1.x
  • 15.0.4 - 15.x
  • 2016.1.1 - 2016.x
Java
Oracle Java 7 or newer with JavaFX

3.2.7. Nexus IQ for Bamboo Requirements

Bamboo
5.5.0 to 5.14.4.1
Java
1.7 to 1.8

3.2.8. Sonatype CLM for Hudson / Jenkins Requirements

Hudson
  • 2.2.1
  • 3.0.0
  • 3.1.2
Jenkins
  • 1.447.2
  • 1.532.1 (LTS)
  • 1.550
  • 2.32.1 (LTS)
Java
1.6 to 1.8

3.2.9. Sonatype CLM for Maven Requirements

Maven
2.1 to 3.3.9
Java
1.6 to 1.8

3.2.10. Sonatype CLM for Nexus Pro Requirements

Sonatype CLM for Nexus is a part of the Nexus CLM Edition, and does not require installation of an specialized components. However, the CLM capabilities do require a user have at least Internet Explorer 9 or any other modern browser.

For information on Nexus requirements please see the support article detailing Sonatype Nexus System Requirement and the prerequisites section of the Nexus Book.

3.2.11. Sonatype CLM for SonarQube Requirements

SonarQube
  • 3.7.4
  • 4.3.2
  • 4.4
  • 4.5.6 (LTS)
  • 5.0
  • 5.1
  • 5.2
  • 5.3
  • 5.4
  • 5.5
  • 5.6
[Note]

SonarQube has removed dashboards as of version 6.2

Java
1.6 to 1.8

3.2.12. JIRA Notifications Requirements

JIRA
6.3 to 7.x