Skip to main content

IQ Server High Availability Installation

Sonatype IQ Server High Availability (HA) enables you to recover from failures or disruptions to the underlying host infrastructure with minimal downtime.

  • Sonatype IQ Server High Availability (HA) is tested and verified with the technologies and deployment models identified in this documentation. Equivalent technologies and platforms may also work. The Sonatype IQ AWS cloud-native HA reference architecture uses Amazon Elastic Container Service (Amazon ECS) with AWS Fargate.

  • Deploy and test in a staging environment before deploying to production.

Choose an HA Deployment Model

IQ Server HA supports multiple deployment models. Select the model that matches your infrastructure and operational requirements.

Manual Self-Hosted HA Deployment

Use this model when you deploy IQ Server nodes directly on virtual machines, bare-metal hosts, or Amazon Elastic Compute Cloud (Amazon EC2) instances. You manage the shared PostgreSQL database, shared file system, and load balancer. Kubernetes is not required.

See Manual Self-Hosted High Availability IQ Server Deployment.

AWS Cloud-Native HA Deployment

Use this model when you deploy the Sonatype IQ AWS cloud-native HA reference architecture on Amazon ECS using AWS Fargate. The M, L, and XL HA profiles use the infra-aws-ha Terraform configuration.

Review and adapt the reference architecture to meet your organization’s workload, networking, security, compliance, availability, cost, and operational requirements.

See Sonatype Platform AWS Reference Architectures.

Kubernetes-Based HA Deployment

Use this model when you deploy IQ Server with the IQ Server HA Helm chart on Amazon EKS or an on-premises Kubernetes cluster. Amazon EKS is one supported deployment model; it does not replace the manual self-hosted or AWS Fargate models.

See Install IQ Server High Availability on Amazon EKS or Install IQ Server High Availability on an On-Premises Kubernetes Cluster.

Common HA Requirements

The following requirements apply to all IQ Server HA deployment models unless the deployment-specific guidance states otherwise.

  1. PostgreSQL database (10.7 or higher) or PostgreSQL-compatible service

    Note

    IQ Server reads the database password only at startup. Database authentication methods that rely on short-lived access tokens or external proxy layers (for example, Microsoft Entra ID or Cloud SQL Auth Proxy) are not supported for IQ HA. If such methods are used, token expiration may require restarting IQ with updated credentials.

  2. Each node meeting IQ Server's system requirements.

  3. Shared network storage

    1. (IQ HA supports NFSv4 and AWS EFS storage options)

    Note

    When Sonatype IQ Server is deployed in a High Availability (HA) configuration, the SCM source-control directory must be configured on shared storage that is accessible by all IQ Server HA nodes. Local (node-specific) storage is not supported.

  4. A load balancer

Additional Kubernetes-Based HA Requirements

The following additional requirements apply when you deploy IQ Server HA using the IQ Server HA Helm chart.

  1. The most recent version of the IQ Server HA Helm chart; instructions are found in the Helm chart README file.

  2. A Kubernetes cluster to run the IQ HA Helm chart:

    1. Amazon EKS for AWS deployments.

    2. Kubernetes cluster for on-premises deployments.