Segmentation Configuration
This section explains how to configure segmentation in Kyvos Manager to create and manage multiple segments and allocate cluster resources (such as Query Engines or disk space) across these segments.
The segmentation feature enables you to define dedicated resources for mission-critical functions.
Note
From Kyvos 2023.3 onwards, you can see the last performed Segmentation Configuration operation details, including progress status and start time, by clicking the i icon located next to the Revert button. To view more comprehensive details, simply click the View Details link, which will take you to the Operations page where you can view the operation information in detail.
You can create multiple segments and divide the system resources (such as Query Engines or disk space) among these segments.
For a resource-based segment, each node can have multiple instances of Query Engines. Also, each instance can have multiple disks attached to it. In this case, all the Query Engines participate in querying. You can only configure resources like disks.
For Query Engine-based segments, Query Engines are divided into different segments. Each query can have multiple disks associated with it, and you can configure a particular disk along with capacity in percentage while designing the segment.
All the available Query Engines must be linked to a specific segment under the cluster name >Kyvos and Ecosystem> Query Engine Segments.
Creating Segments
You can create resource-based and Query Engine-based segments.
To create a segment, perform the following steps.
Points to remember
Consider the following points while creating or deleting segments.
By default, all the query engines are assigned to the Default Segment.
For Query Engine based segments, there must be at least one Query Engine assigned to each segment, and the same query engine CANNOT be assigned to multiple segments.
You can also create a Resource based segment by defining the resource allocation for all the Query Engines in that segment. Through this, you can allocate resources to each query engine in the segment for Cuboid Replication, Extended Cuboid Block Cache, and Metadata.
For Resource based segments, there must be at least one Query Engine assigned to each segment, and the same query engine CAN be assigned to multiple segments.
Deleting a segment will move all the Query Engines under it to the Default segment.
Migrating the role of any Query Engine will remove it from the segment(s) under which it is allocated.
Query Engine Segmentation
From Kyvos 2026.5 onwards, query engine segmentation is supported. This feature allows you to group Query Engines into dedicated segments and map Semantic Models to those segments, helping isolate workloads and improve query performance consistency.
The sections below describe how to create and delete Query Engine segments, as well as how to map Semantic Models to these segments.
Create a Query Engine Segment
Follow below steps to create and configure a Query Engine segment.
Note
Only Kyvos admins can configure segments.
Open Kyvos Manager.
From the hamburger menu, navigate to: Kyvos and Ecosystem > Query Engine Segments
In the Segment Name field, enter a name for the segment.
Click the three-dot icon () next to the Select Query Engines option.
From the list of available Query Engines, select the Query Engines to include in the segment. Query Engines that are not mapped to any segment will automatically become part of the Default Segment.
To use the global memory configuration for query engines, disable the Configure Memory toggle. Else, to define custom memory settings for the segment, enable the toggle and configure settings such as max heap memory, analytical store max memory, etc. for the segment. You can also specify Kyvos Java Options in the Additional Java Options field. If not configured, the default Kyvos Java Options will be applied. All Query Engines mapped to the segment will use the configured memory settings.
Note
Segment-level memory settings override the global memory configuration for that segment.
Click Add Segment in the upper-right corner to add the segment to the list of segments created.
Click Save and enter your password to apply the configuration.
Restart Kyvos application services for the segment to become active.
Delete a Query Engine Segment
To delete a segment:
Hover over the segment name.
Click the three-dot icon on the right side of the segment.
Select Delete.
Map Semantic Models to Query Engine Segments
After Query Engine segments are configured by the administrator, Kyvos users can map Semantic Models to segments by following these steps:
Open Kyvos.
From the hamburger menu, navigate to: Setup > Resource Allocation
The page displays all configured Query Engine segments.
To map a Semantic Model to a segment, drag and drop the Semantic Model onto the desired segment box (Segment-1 or DefaultSegment in the image above).
To unmap a Semantic Model from a segment, drag and drop the Semantic Model outside the segment area onto the blank canvas.
Important Notes
These points cover key aspects to keep in mind while using Query Engine Segmentation:
Segment names must be unique across the deployment.
On Segment deletion, mapped Semantic Models are remapped to the Default Segment.
A Segment (except Default Segment) must have at least one Query Engine.
A Default Segment exists as a system-level construct and cannot be deleted.
All Semantic Models not explicitly mapped to any named Segment are routed to the Default Segment.
Unprocessed Semantic Models can also be mapped to Segments.