NexusToArtifactory - A tool designed to ease migration from Sonatype Nexus to JFrog Artifactory.
Python Groovy
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

NexusToArtifactory

This tool is designed to ease the transition from Sonatype Nexus to JFrog Artifactory. It provides a simple wizard-like interface that allows you to easily configure and run a migration of repositories, artifacts, users, and settings from a Nexus instance to an Artifactory instance.

Currently, the following data can be migrated:

  • local (hosted), remote (proxy), and virtual (group) repositories
    • note that Bower repositories are not yet supported
  • artifacts stored in local (hosted) repositories
  • users, groups (roles), and permissions (privileges)
  • LDAP configurations

Installation

This tool accesses the Nexus instance directly by reading the Nexus files from the disk. Therefore, the tool should be installed on the computer running the Nexus instance, or on a computer with access to the filesystem that the Nexus instance is installed on.

First, install the latest version of Python 2. Then, download or clone this repository.

Windows Installation

This tool's interface uses the ncurses library, which is standard in Linux and MacOS, but not readily available in Windows. Instead, the tool can use the PDCurses library as an alternative. This means that Windows users must also have the latest version of PDCurses to run the tool.

Alternatively, Windows users may avoid installing any dependencies by downloading the self-contained exe file.

Usage

To run the tool, run ./NexusToArtifactory.py.

If using the included Windows exe file, instead run NexusToArtifactory.exe.

Main Menu Screenshot

All options can be accessed by typing the appropriate key on the keyboard. The following options are available:

  • i Initial Setup - Connect to the Nexus and Artifactory instances. This allows the tool to scan both, and come up with a default configuration for migration. This configuration can then be modified via the other options.
  • r Repository Migration Setup - Allows you to specify which repositories should and should not be migrated. Also, allows you to modify any repository to some degree (changing the name, description, layout, etc). These changes only affect the current configuration, and will take effect on the Artifactory instance when the migration is run (the Nexus instance does not change).
  • u Security Migration Setup - Migration options for security data, such as users, groups, permissions, and LDAP configurations.
  • s Save Config JSON File - Allows you to save the current configuration to a JSON file. This way, you can close the tool and come back to it later, or you can save the current state of the migration to revert back to at a future time.
  • l Load Config JSON File - Allows you to load a JSON file containing a configuration.
  • v Verify Configuration - Rescan the Nexus and Artifactory instances, and reapply the current configuration. This should be used to check for incompatibilities after the Nexus instance has been modified.
  • x Run Migration - Run the migration.
  • h Help - Pressing another key after this one displays context-sensitive help for that option.
  • q Exit - Quit the tool.

The first step is to connect to the Nexus and Artifactory instances, so type i to open the Initial Setup menu.

Setup Menu Screenshot

The following options are available:

  • n Nexus Data Directory - The local filesystem path, where the Nexus instance is installed. This is generally a sonatype-work/nexus/ folder. This path can be either a relative or absolute file path. If the path doesn't exist, or if it doesn't contain a valid Nexus install, this option will be hilighted in red.
  • a Artifactory URL - The URL of the Artifactory instance. If the given URL is not a valid Artifactory instance, this option will be hilighted in red.
  • u Artifactory Username - The username of an admin user on the given Artifactory instance.
  • p Artifactory Password - The password of the admin user. Unless both the username and password are correct, they will both be hilighted in red.
  • h Help - Pressing another key after this one displays context-sensitive help for that option.
  • q Back - Go back to the main menu.

When a Nexus 3 path is specified, three new options will appear below it, allowing you to input the Nexus URL, username, and password. This is because Nexus 3 does not make all of its data available on the filesystem like Nexus 2 does, so the tool must connect to the instance to retrieve some of the information.

Setup Menu Screenshot With Filled Options

Once the Nexus and Artifactory instances have both been successfully connected, type q to go back to the main menu.

Main Menu Screenshot With Error

By this point, the tool has generated an initial configuration for the migration, and all the settings have been set accordingly, but sometimes the default settings need to be modified further. If there are any settings that need to be changed, the corresponding option will be marked with a red !. These must be cleared before running the migration.

In the screenshot above, there is an error in the Repository Migration Setup menu, so type r to enter that menu.

Repo Menu Screenshot With Error

The following options are available:

  • 1 releases (maven) - Typing a number key toggles whether to migrate the associated repository. The plus sign appears when the repository is to be migrated. This option also displays the package type, as well as whether the repository is a (local), [remote], <shadow>, or {virtual}. If there are a lot of repositories to show, they can be paged through using the left and right arrow keys.
  • f Search Filter - Filter the repository list, displaying only repositories that match part of the filter string. This allows for easier browsing and editing of large lists of repositories.
  • m Mass Edit - Allows editing of many repositories at once. Any fields set in the mass edit menu will overwrite existing values on all repositories that match the current search filter.
  • e Edit Repository - Typing e followed by a number allows you to edit the associated repository.
  • h Help - Pressing another key after this one displays context-sensitive help for that option.
  • q Back - Go back to the main menu.

The error turns out to be in the central-m1 repository, so type e and then 6 to edit that one.

Repo Edit Screenshot With Error

The following options are available:

  • Repo Name (Nexus) - The repository's name on the Nexus instance. Not editable.
  • n Repo Name (Artifactory) - The repository's name on the Artifactory instance. Defaults to the Nexus repository name.
  • m Migrate This Repo - Whether to migrate this repository. This is the same as typing the associated number in the repository list menu.
  • Repo Class - Whether the repository is local, remote, shadow, or virtual. Not editable.
  • Repo Type - The repository's package type. Not editable.
  • d Repo Description - The repository description. Defaults to the "display name" of the repository on the Nexus instance.
  • l Repo Layout - The layout of the repository. Defaults to the default layout for the repository's package type.
  • r Handles Releases - Whether this repository handles releases. Local and remote repositories only.
  • s Handles Snapshots - Whether this repository handles snapshots. Local and remote repositories only.
  • p Suppresses Pom Consistency Checks - Whether this repository disables checking for inconsistencies with pom files before allowing artifacts to be deployed. Local and remote repositories only.
  • x Max Unique Snapshots - The maximum number of unique snapshot versions. Local and remote repositories only.
  • b Maven Snapshot Version Behavior - The behavior of snapshots in this repository. Local repositories only.
  • u Remote URL - The URL of the repository this one proxies. Remote repositories only.
  • h Help - Pressing another key after this one displays context-sensitive help for that option.
  • q Back - Go back to the repository list menu.

The error shows that the repository's class, shadow, is invalid. There are a handful of reasons that an initial configuration might not be valid:

  • A Nexus repository, user, or role (group) has a name that would be invalid in Artifactory.

  • A Nexus "shadow repository" is marked for migration. These cannot be migrated, as Artifactory does not have an equivalent concept.

  • The anonymous user is marked for migration. This is a special user in Artifactory, and attempting to migrate it can break things.

  • The default user password is not set. Passwords in Nexus are hashed, and so are impossible to migrate. The solution this tool uses is to set all user passwords to the same default password, and then expire all of them, so the user is forced to enter a new password when they first log in. This behavior can be overridden on a per-user basis by setting the password field for each user directly.

  • A user marked as an administrator does not have the password field set. For security reasons, the tool will not allow an admin user to be set with an expired default password. All admin passwords must be entered manually.

  • A user not marked as an administrator has administrator privileges. In Nexus, there are many special built-in privileges that allow access to various aspects of the Nexus system. All of these privileges fall into one of three categories:

    • The privilege allows access to something that doesn't exist in Artifactory.
    • The privilege allows access that all Artifactory users already have.
    • The privilege allows access that only Artifactory admins have.

    The former two types are ignored. If a user has the third type of privilege, they must also be marked as an administrator.

Since the central-m1 repository is a shadow, it can't be migrated, so it must be unmarked. Type m to unmark it, and then type q to go back to the repository list. Alternatively, type q to go back to the list, and then type 6 to unmark the repository.

Repo Menu Screenshot

Now, the error is gone. The error has disappeared on the main menu as well, and the migration can now be run.

Options

This tool can optionally write logs to a file. This is primarily useful for debugging purposes. Logging can be configured using the following commandline options:

  • -l, --log-file: Specify a file to write logs to. If the file already exists, the log session is appended to the existing contents. If this option is not given, no logging is performed.
  • -v, --log-level: Specify the minimum log level. All logs below this level are ignored. Possible values are error, warning, info, and debug. If this option is not given, it defaults to info.

This tool can also be run programmatically, provided that a valid migration configuration JSON has already been generated. This can be configured using the following commandline options:

  • -f, --load-file: Select a config JSON file to load immediately. This can be used in interactive mode, and is equivalent to using the l option on the tool's main screen. In non-interactive mode, this option is required.
  • -n, --non-interactive: Run the tool in non-interactive mode. This loads the config JSON specified by -f, and immediately runs migration. If the config JSON was invalid or the migration had errors, the tool returns nonzero.
  • -q, --silent: By default, non-interactive mode prints logs to stdout, as well as the file optionally specified by -l. If -q is passed, no logs are printed.

Other commandline options are as follows:

  • -r, --retries: When migrating artifacts, a deploy might fail for some ephemeral reason (conflicts with in-progress metadata calculation, network issues, etc). This specifies the maximum number of times the tool will attempt to deploy each artifact before migration of that artifact fails. Default is 3.
  • -t, --threads: The number of threads used to migrate artifacts. Default is 4.
  • -s, --ssl-no-verify: Disable SSL verification. This is useful if your Artifactory and/or Nexus 3 instance uses a self-signed SSL certificate.
  • -h, --help: Print help message, which describes all of these options.

Testing

This project uses Python's unittest framework. To run the tests, you can use your favorite IDE, or run them from the command line.

To run the unit tests from the command line (requires Python 2.7):

cd nex2art/tests
python -m unittest discover -v -p "*Test.py"

Future Development

This tool is currently incomplete, and plenty of features are not yet implemented. The following is a list of features that are currently in development, and should be added to the tool soon:

  • migrate Bower repositories
  • migrate to Artifactory SaaS instances
  • migrate scheduled tasks
  • migrate other instance-wide settings (email settings, proxy settings, etc)
  • support paid Nexus features, such as custom metadata
  • modify virtual repository child lists
  • modify repository package types

Nearly everything the tool does not yet migrate can be fixed manually via the Artifactory user interface, after the migration is complete. A major exception to this is if the tool chooses the wrong package type for a repository. If a package type needs to be fixed after migration, packageType.py might help.