Skip to content

Expected Elasticsearch cluster size estimate [rake task]

Problem to solve

Customers setting up the Elasticsearch Integration for Advanced Global Search in self-managed instances often are unsure how big their cluster will need to be and as a consequence may be unsure if they can run the cluster.

Intended users

User experience goal

Proposal

In the Elasticsearch integration page we could display an estimate of the amount of storage you will need. Since we expect around 0.31 * repo size and since we can easily calculate total repo size from project statistics table we can simple do the calculation and display it in the admin UI.

We may want to give some headroom so perhaps calculating 0.5 * repo size and saying "your cluster should be at least this big" will be a good way to convey the information.

Further details

Permissions and Security

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references

Release Notes

Many customers have asked about storage requirements for planning their Elasticsearch cluster when enabling Advanced Search in their GitLab instances.

In order to make this readily accessible, we have added a rake command in 13.10 which can do the calculation referencing the total of all repos and multiplies by .5 to give an estimated size that is needed for the Elasticsearch cluster.

https://docs.gitlab.com/ee/integration/elasticsearch.html#system-requirements

Screenshot_2021-02-18_at_13.17.47

Edited by Dmitry Gruzd