New to KubeDB? Please start here.

Elasticsearch Volume Expansion

This guide will give an overview on how KubeDB Ops-manager operator expand the volume of various component of Elasticsearch like:(Combined and Topology).

Before You Begin

How Volume Expansion Process Works

The following diagram shows how KubeDB Ops-manager operator expand the volumes of Elasticsearch database components. Open the image in a new tab to see the enlarged version.

  Volume Expansion process of Elasticsearch
Fig: Volume Expansion process of Elasticsearch

The Volume Expansion process consists of the following steps:

  1. At first, a user creates a Elasticsearch Custom Resource (CR).

  2. KubeDB Provisioner operator watches the Elasticsearch CR.

  3. When the operator finds a Elasticsearch CR, it creates required number of PetSets and related necessary stuff like secrets, services, etc.

  4. Each PetSet creates a Persistent Volume according to the Volume Claim Template provided in the petset configuration. This Persistent Volume will be expanded by the KubeDB Ops-manager operator.

  5. Then, in order to expand the volume of the various components (ie. Combined, Controller) of the Elasticsearch, the user creates a ElasticsearchOpsRequest CR with desired information.

  6. KubeDB Ops-manager operator watches the ElasticsearchOpsRequest CR.

  7. When it finds a ElasticsearchOpsRequest CR, it halts the Elasticsearch object which is referred from the ElasticsearchOpsRequest. So, the KubeDB Provisioner operator doesn’t perform any operations on the Elasticsearch object during the volume expansion process.

  8. Then the KubeDB Ops-manager operator will expand the persistent volume to reach the expected size defined in the ElasticsearchOpsRequest CR.

  9. After the successful Volume Expansion of the related PetSet Pods, the KubeDB Ops-manager operator updates the new volume size in the Elasticsearch object to reflect the updated state.

  10. After the successful Volume Expansion of the Elasticsearch components, the KubeDB Ops-manager operator resumes the Elasticsearch object so that the KubeDB Provisioner operator resumes its usual operations.

In the next docs, we are going to show a step-by-step guide on Volume Expansion of various Elasticsearch database components using ElasticsearchOpsRequest CRD.