Skip to main content

Set Up the Nexus One UI Search Index

Note

The Nexus One UI is currently a Preview feature; functionality and user experience are not in their finalized state. The configuration steps outlined here are required in self-hosted deployments while Nexus One UI is in Preview and will be simplified or eliminated in future IQ versions.

The new Nexus One UI reads from a dedicated OpenSearch search index. In self-hosted deployments, users cannot switch to the Nexus One UI until an administrator configures a connection and builds the OpenSearch index. Note that this setup is only required in self-hosted deployments. In cloud deployments, Sonatype already provides this index.

Requirements

  • An external PostgreSQL database. The new Nexus One UI is not currently supported on the embedded H2 database.

  • An OpenSearch server that IQ Server can reach, using either an http or aws connection.

    Note

    The Nexus One UI uses its own independent OpenSearch connection. Even if you are already using OpenSearch for Advanced Search, you will still need to configure a separate connection in your config.yml for the Nexus One UI.

  • A Lifecycle license. The Nexus One UI is not currently available for Firewall-only, SBOM Manager-only, or Developer-only subscriptions.

  • The Edit System Configuration permission.

Configuring the Nexus One UI Preview Option

Before an administrator has created an OpenSearch index, all administrator users will see a note at the top of the user interface that will prompt you to navigate to the setup screen and configure the index. You can also access this screen by the gear icon (system preferences) in the top-right of the header and choosing Nexus One UI Settings.

The setup page shows a Search Index tile with three numbered steps, each reporting its own status, and a Settings tile that turns Nexus One UI on and off.

Step 1 - config.yml

Add a new nexusOne connection block to your IQ Server config.yml.

If you are using a self-managed OpenSearch instance, your block will look like the following:

nexusOne:
  connection:
    type: http
    uri: https://opensearch.example.com:9200
    username: . . .
    password: . . .

If you are using an AWS OpenSearch service, your block will look like the following:

nexusOne:
  connection:
    type: aws
    domain: https://my-domain.us-east-1.es.amazonaws.com:443
    region: us-east-1

AWS credentials are resolved using the standard AWS SDK default credentials chain: environment variables, system properties, ~/.aws/credentials, ECS container credentials, or EC2 instance profiles

Step 2 - Connection

IQ Server checks the connection and reports Connected, Failed, or Not tested.

If it fails, verify the connection settings in config.yml, that the network is up, and that authentication succeeds; then, reload the page to run the check again.

If an index was built previously and the connection is later lost, step 2 reports that the existing index cannot be used until the connection is restored.

Step 3 - Index

With steps 1 and 2 passing, Build index becomes available. Building is a resource-intensive process; start it when your instance can absorb the load.

While the build runs, the step shows who started it and when, and offers the option to Cancel build. The classic UI is unaffected and remains available while the build runs.

When the first build finishes, the Nexus One UI is enabled automatically and becomes available to all users. There is no separate activation step.

If the build fails, use the button on step 3 to start it again.

Enabling/Disabling the Nexus One UI Option

A Settings tile at the bottom of the Nexus One UI Settings page shows whether Nexus One UI is enabled as well as a button for enabling/disabling it.

  • Disabling the Nexus One UI returns all users to Classic UI and stops the search index from updating.

  • Re-enabling uses the last built index as-is. Changes made while Nexus One was off are not caught up; re-index to make it current.

  • Re-indexing requires Nexus One to be enabled. If it is off, the page tells you to enable it in Settings first.

Re-indexing

Re-indexing is not routine maintenance; most installations never need it.

A re-index runs in the background while the existing index keeps serving users, then switches over automatically when it completes. Both indexes are kept current during the rebuild, so users do not see stale results and Nexus One UI stays available throughout.

Re-index when:

  • A build failed and nothing is serving.

  • You restored an OpenSearch connection that had been lost.

  • You re-enabled Nexus One UI after a period with it turned off and want the index to be current.

If a re-index fails, the previously built index keeps serving and Nexus One UI stays available. The page reports the failed run while showing the index as still active.

Troubleshooting

If data in the Nexus One UI appears to be out of sync, such as when a newly created application takes more than a few seconds to appear in search results, follow these steps:

  1. On the Nexus One UI Settings page, select Re-index.

  2. After the re-index completes, verify that the data appears in the Nexus One UI search results.

  3. If the data is still out of sync, contact Sonatype Support.