IBM Cloud Docs
Configuring Nexus

Configuring Nexus

Configure the Nexus Repository Manager to store build artifacts in your Nexus repository (repo).

  1. If you are configuring this tool integration as you are creating the toolchain, in the Configurable Integrations section, click Nexus.

  2. If you have a toolchain and are adding this tool integration to it, from the IBM Cloud console, click the menu icon hamburger icon and select DevOps. On the Toolchains page, click the toolchain to open its Overview page. Alternatively, on your app's Overview page, on the Continuous delivery card, click View toolchain. Then, click Overview.

    a. Click Add tool.

    b. In the Tool Integrations section, click Nexus.

  3. Type a name for this instance of the Nexus tool integration.

  4. Type the URL for the Nexus repo that you want to open when you click the Nexus card from your toolchain.

  5. Select the repository type that you want to connect to.

  6. If you selected npm registry, follow these steps:

    a. Type the email address that is associated with your registry.

    b. Type the authentication token that is associated with your registry.

    c. Type the URL for your Nexus release repo, which is your private registry on the Nexus server.

    d. Type the URL for the Mirror or Public registry that you use to combine multiple public and private npm registries. For example, this URL might be the URL of the virtual registry on your Nexus server that can access both your private registry and a cache of the npm global registry.

  7. If you selected Maven repository, follow these steps:

    a. Type the user ID that is associated with your repo.

    b. Type the password that is associated with your repo.

    c. Type the URL for your Nexus release repo, which is your private release repo on the Nexus server.

    d. Type the URL for your Nexus snapshot repo, which is your private snapshot repo on the Nexus server.

    e. Type the URL for the Mirror or Public repo that you use to combine multiple public and private Maven repos. For example, this URL might be the URL of the virtual repo on your Nexus server that can access both your private repos and a cache of the Maven central repo.

  8. Click Create Integration.

  9. From your toolchain's Overview page, on the Third-Party tools card, click the Nexus repo that you want to work with. The Nexus website opens, where you can view the contents of the repo.

  10. Optional: If you are using a toolchain on IBM Cloud Public and you want to build your app by using Nexus with npm, configure your pipeline to add an npm build job. For instructions to configure the build job, see the Configuring a Nexus npm build job in your pipeline section.

  11. Optional: If you are using a toolchain on IBM Cloud Public and you want to build your app by using Nexus with Maven, configure your pipeline to add a Maven build job. For instructions to configure the build job, see the Configuring a Nexus Maven build job in your pipeline section.

Configuring a Nexus npm build job in your pipeline

Before you configure an npm build job in your pipeline, you need a working pipeline that can use your build SCM repo as input, and you must configure Nexus for your toolchain. For instructions to configure Nexus, see the Nexus section.

Configure the Delivery Pipeline to add an npm build job:

  1. Create a stage and set the input to the appropriate SCM repo.

  2. On the stage, add a build job.

  3. Configure the build job:

    npm build job
    Figure 1. npm build job

    a. For the builder type, select npm (Artifactory or Nexus).

    b. If you configured multiple instances of the Nexus tool integration, enter the name of the Nexus tool integration that you want to configure the npm build job for.

    c. For the tool integration type, select Nexus.

    d. For the build command, enter the commands to build your npm module or publish it to your registry. This example shows the commands to either build the module or publish it.

    npm install
# or
npm publish --registry "${NPM_RELEASE_URL}"

    You can find the URL and user credentials that you used to connect to your registry in the configuration settings for the Nexus tool integration.

    e. If your build job publishes to the Nexus registry, and the format of your node module version is x.y.z-SNAPSHOT.w, select the Increment snapshot module version checkbox. The build job automatically updates the module version before it publishes to the Nexus registry. The build job selects the highest version of the module from the npm registry and the local package.json file, and increments the module version by using semver. The build job does not deliver the changes to the SCM repo.

  4. Click SAVE. Whenever your pipeline runs, this build job uses the configuration information from the Nexus tool integration to connect to your npm registry.

Configuring a Nexus Maven build job in your pipeline

Before you configure a Maven Build job in your pipeline, you need a working pipeline that can use your build SCM repo as input, and you must configure Nexus for your toolchain. For instructions to configure Nexus, see the Nexus section.

Configure the Delivery Pipeline to add a Maven Build job:

  1. Create a stage and set the input to the appropriate SCM repo.

  2. On the stage, add a build job.

  3. Configure the build job:

    Maven build job
    Figure 2. Maven build job

    a. For the builder type, select Maven (Artifactory, Nexus, SonarQube).

    b. If you configured multiple instances of the Nexus tool integration, enter the name of the Nexus tool integration that you want to configure the Maven Build job for.

    c. For the tool integration type, select Nexus.

    d. For the build command, enter the commands to build your Maven module or publish it to your snapshot registry. This example shows the commands to either build the module or publish it.

    mvn -B clean package
# or
mvn -DaltDeploymentRepository="snapshots::default::${MAVEN_SNAPSHOT_URL}" deploy

    You can find the URL and user credentials that you used to connect to your registry in the configuration settings for the Nexus tool integration.

  4. Click SAVE. Whenever your pipeline runs, this build job uses the configuration information from the Nexus tool integration to connect to your Maven repo.

Configuring Nexus by using the API

The Nexus tool integration supports the following configuration parameters that you can use with the Toolchain HTTP API and SDKs when you create, read, and update tool integrations.

You must specify the tool_type_id property in the request body with the nexus value.

Table 1. Nexus tool integration parameters
Parameter Usage Type Terraform argument Description
dashboard_url optional, updatable String server_url The URL of the Nexus server dashboard for this tool integration. In the graphical UI, the browser goes to this dashboard when you click the Nexus tool integration card.
mirror_url optional, updatable String mirror_url The URL of your Nexus virtual repo where you can view your private repos and a cache of the public repos.
name required, updatable String name The name of this tool integration.
release_url optional, updatable String release_url The URL of your Nexus release repo.
snapshot_url optional, updatable String snapshot_url The URL of your Nexus snapshot repo.
token optional, updatable Password token The password or token for authenticating with the Nexus repo. You can use a toolchain secret reference for this parameter. For more information about secret references, see Protecting your sensitive data in Continuous Delivery.
type required, updatable String type The repo type for your Nexus tool integration.
user_id optional, updatable String user_id The user ID or email address for authenticating with your Nexus repo.