⚠️ This repository has been superceeded by nla-blacklight_common. All new development is happening in that repository. ⚠️

blacklight-solrcloud-repository

A Blacklight repository to connect with a collection on a ZooKeeper managed SolrCloud cluster.

The main ideas for this gem come from the rsolr-cloud gem. Unfortunately that gem seems abandoned and depends on RSolr v1, whilst Blacklight uses RSolr v2.

Usage

This repository requires the following ENV variables be defined in the Blacklight/Arclight application:

• ZK_HOST - ZooKeeper connection string
• SOLR_COLLECTION - name of the Solr collection

Installation

Add this line to your Blacklight/ArcLight application's Gemfile, replacing [choose a tag] with a release tag.

gem "blacklight-solrcloud-repository", git: "https://github.com/nla/blacklight-solrcloud-repository", tag: '[choose a tag]'

And then execute:

$ bundle install

Contributing

✏️ This repository uses conventional commits and commit messages are used to generate CHANGELOG.md and release body entries.

The most important prefixes you should have in mind are:

• fix: which represents bug fixes, and correlates to a SemVer patch.
• feat: which represents a new feature, and correlates to a SemVer minor.
• feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Releases are automated via GitHub workflows. See more in the "Releases" section below.

Setup

bin/setup will configure Bundler to install gems into the vendor/bundle directory and install all dependencies.

⚠️ Installing gems into `vendor/bundle` serves to isolate the versions of gems used in this project from other Ruby projects on your development machine.

Containers

🚨 Specs are executed against a local SolrCloud cluster. You will need Podman to create a container for this cluster using the docker-compose.yml file in the solr directory.

In order to run this cluster successfully, you'll need a Podman machine with at least 4GB of memory and 6GB of disk space.

The Podman machine created below will be initialised with 2 CPUs and 6GB of memory and disk space.

podman machine init --cpus 2 --disk-size 6144 --memory 6144      # initialise a Podman machine
podman machine start                                             # start the Podman machine
podman-compose -f ./solr/docker-compose.yml up -d          # spin up a ZK + SolrCloud cluster
podman-compose -f ./solr/docker-compose.yml down --volumes # pull down the ZK + SolrCloud cluster

Testing

There is a bin/ci script that will create/teardown the cluster, run specs, perform linting and security analysis.

You can otherwise run each command in that script individually if you wish.

Releases

Releases are automated via the release.yml GitHub workflow. This uses Google's release-please action to create pull requests when changes are pushed to main. It will bump the version automatically and create a release when the pull request is merged. Read more about how release-please works.

🚨 CHANGELOG.md is automatically created/updated for each release based on the commit messages.

License

The gem is available as open source under the terms of the Apache 2 License.