Nexus Repository Google Cloud Storage Blobstore

CircleCI Build Status Maven Central Join the chat at https://gitter.im/sonatype/nexus-developers

This project adds Google Cloud Object Storage backed blobstores to Sonatype Nexus Repository 3 and later. It allows Nexus Repository to store the components and assets in Google Cloud instead of a local filesystem.

Which Version do I use?

For the best experience, you should upgrade your Nexus Repository Manager and Google Cloud Blobstore plugin to the latest versions.

Nexus Repository Manager 3 Version Google Cloud Storage Blobstore Version
3.23 Get 0.13.0
3.22 Get 0.12.0
3.21 Get 0.11.0
3.20 Get 0.10.2
3.19 Get 0.9.2
3.18 Get 0.8.0
3.17 Get 0.7.1
3.16 Get 0.6.1
3.15 0.4.0
3.13, 3.14 0.3.0
3.11, 3.12 0.2.0

Deploying the Plugin

Google Cloud Services and IAM Roles

This plugin uses the following Google Cloud Platform services:

Firestore usage is exclusively in Datastore mode; you must configure the project for your Repository Manager deployment to use "Firestore in Datastore mode".

To use this plugin (or execute the integration tests), you will need a service account with the following scopes:

Optionally, add the following for Cloud Logging:

The blobstore will create the storage bucket with the 'Multi-Regional' storage class.

Google Cloud Storage Authentication

Per the Google Cloud documentation:

  1. Generate a JSON Service Account key
  2. Store this file on the filesystem with appropriate permissions for the user running Nexus to read it.
  3. (optional, but recommended) Set the GOOGLE_APPLICATION_CREDENTIALS environment variable for the user running Nexus:
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/key.json

Installing

After downloading the kar from Maven Central (links above), copy the kar file to the deploy directory in your Nexus Repository Manager install:

cp nexus-blobstore-google-cloud-*-bundle.kar /path/to/your/nxrm3/install/deploy

Configuration

A restart of Nexus Repository Manager is required to complete the installation process.

Log in as admin and create a new blobstore, selecting 'Google Cloud Storage' as the type.

If you did not set the environment variable in Step 3 above, specify the absolute path to the JSON Service Account key file.

Parallel Multipart Upload

In version 0.10.0 and later, the plugin is capable of uploading content to the Google Cloud Storage bucket using multiple concurrent threads. In 0.12.0, this feature is disabled by default; see the corresponding design document.

Contributing to Plugin Development

Contribution Guidelines

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

Requirements

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

Building from Source

To build the project and generate the bundle use Maven:

mvn clean package

Optional: review the additional documentation to configure and run integration tests.

A docker-compose file is provided to ease setting up a local NXRM instance to test.

  1. docker swarm init
  2. docker volume create nexus3-data
  3. docker secret create google_application_credentials /path/to/your/google/iam/key.json
  4. docker-compose up

You can also use the docker-compose file with docker service, like so:

docker stack deploy -c docker-compose.yml sonatype

(Using docker stack assumes you've built the container with docker build -t nexus3-google . or run docker-compose up at least once).

Last manual option: you can install the local development build in any NXRM install with:

cp target/*-bundle.kar /path/to/your/nxrm3/install/deploy

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:

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: