Nexus Repository S3 Blobstores

This project adds S3 backed blobstores to Sonatype Nexus Repository 3. It allows Nexus Repository to store the components and assets in Amazon AWS S3 instead of a local filesystem.

Contribution Guidelines

Go read our contribution guidelines to get a bit more familiar with how we would like things to flow.

Requirements

• Apache Maven 3.3.3+
• Java 8+
• Network access to https://repository.sonatype.org/content/groups/sonatype-public-grid

Also, there is a good amount of information available at Bundle Development

Building

To build the project and generate the bundle use Maven

mvn clean install

If everything checks out, the nexus-blobstore-s3 bundle should be available in the target folder

Installing

See install.sh. This copies the nexus-blobstore-s3 jar file to the right place and updates the configuration files. Use at your own risk.

Alternatively, copy nexus-blobstore-s3-*.jar and the AWS SDK bundle jar into the nexus/deploy subdirectory.

Start the bundle from the Nexus Repository console:

bundle:list | grep nexus-blobstore-s3
bundle:start <bundleNumber>

Configuration

Log in as admin and create a new blobstore, selecting S3 as the type. Enter the bucket name as the path. You need valid AWS credentials in ~/.aws/credentials.

Now you can create repositories with your new S3 blobstore. The UI isn't quite done -- for now, enter the bucket name as the path.

Todo

Still to do: proper configuration screen that allows AWS credentials to be entered (requires upstream changes). See the config-ui branch in git.

The Fine Print

It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)

Remember:

• Use this contribution at the risk tolerance that you have
• Do NOT file Sonatype support tickets related to S3 support
• DO file issues here on GitHub, so that the community can pitch in

Phew, that was easier than I thought. Last but not least of all:

Have fun creating and using this plugin and the Nexus platform, we are glad to have you here!

Getting help

Looking to contribute to our code but need some help? There's a few ways to get information:

• Chat with us on Gitter
• Check out the Nexus3 tag on Stack Overflow
• Check out the Nexus Repository User List