Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 3.24 KB

README.md

File metadata and controls

56 lines (37 loc) · 3.24 KB
Raw

Rollcall


A solution for managing data releases, indices, and aliases for Elasticsearch.

Under Development

CircleCI

Introduction

The purpose of Rollcall is to assist those projects which make use of Elasticsearch as a primary data store to drive rich facet search and powerful search APIs.

Specifically, for the types of data models that require sharding of the domain to support incremental updates, real time updates, testing, and data versioning, there is a need for a comprehensive solution for managing index aliases in an automated fashion.

Rollcall solves the very specific problem of applying aliases to indexes in a way that makes sense for a sharded domain.

Motivating Example

Suppose you are building a search API for patient demographic information across many different clinics and sites and you have decided to store the information as documents in Elasticsearch to make use of the powerful text search and performant aggregations.

Knowing that new clinics will be making data available, others will be making updates to their data at various times, and others will be withdrawing their data, you have decided to shard your domain around the concept of clinic. As such, your Extract-Transform-Load (ETL) pipeline will be producing an Elasticsearch index per clinic.

Example with three clinics:

demographic_entity_cl_clinicA_re_0
demographic_entity_cl_clinicB_re_0
demographic_entity_cl_clinicC_re_0

For your search API to search across all three indices seamlessly, you create a single index alias for all 3 studies.

alias: demographic
indices: 
    - demographic_entity_cl_clinicA_re_0
    - demographic_entity_cl_clinicB_re_0
    - demographic_entity_cl_clinicC_re_0

Now suppose we want to onboard a new clinic clinicD and make an update to an existing one ClinicB. We now have to start doing some acrobatics in terms of knowing which index needs an alias removed, which ones need one added, and which ones are untouched. This problem quickly becomes untenable for a human as the number of indices grows.

This problem is what Rollcall helps solve by introducing concepts like data releases, rollbacks, and redactions in an opinionated way.

Index Naming

The thing that Rollcall is opinionated about is the way indices are named. So opinionated in fact that it uses a grammer file to describe the index naming grammer.

It can be found here: IndexName.g4

Using one of the indices from the motivating example, demographic_entity_cl_clinicA_re_0 this is what a parse tree looks like: Parse Tree

This opinionated way of naming indices allows us to define semantics about the terms in a name which Rollcall uses to manage data releases. It is thanks to this that the index names and aliases are themselves the source of truth and state of the system rather than an external 3rd party acting as a datastore for state and truth.