Manage Workspace Index Configuration

Introduction¶

This section introduces how to manage workspace index configurations in the backend administration.

Description¶

Guance supports storage engines such as Opensearch, Elasticsearch, and Doris. Next, we will explain how to manage workspace index configurations for environments configured with these storage engines.

Default Index Configuration for New Workspaces¶

This applies when we initially deploy the system. For any subsequently added workspaces that require custom global index configurations, you can follow this procedure. In the forethought-core namespace, modify the core ConfigMap by adding the following content:

WorkspaceDefaultesIndexSettings:
  number_of_shards: 1                       
  rollover_max_size: 30   
  number_of_replicas: 1 
  hot_retention: 24

Configuration Item	Description	Default Value	Recommended Value
number_of_shards	Number of primary shards for the index	1	Consistent with the data nodes of the Opensearch cluster, keep default for Doris
rollover_max_size	Size of a single shard	30	30
number_of_replicas	Whether to enable index replicas	1	It is recommended to enable if there is sufficient disk space
hot_retention	Duration for retaining hot data	24	Can be set to a longer retention period if disk space is sufficient; this setting does not take effect if ES does not have a hot-warm-cold architecture

After completing the addition, restart all services under the forethought-core namespace.

Updating Default Index Configuration for Existing Workspaces¶

Log in to the backend management page as an admin user (you can find the backend management URL in the top-right corner of the launcher, copy the address corresponding to "management"). Find the workspace whose default retention policy you want to modify, click on Index Configuration, enter the index page, and click Configure to configure indexes for different storage contents.

Storage Engine: Opensearch or Elasticsearch¶

When configuring a workspace with a storage engine of Opensearch or Elasticsearch, the following configuration items can be modified:

Configuration Item	Description	Default Value	Recommended Value
Primary Shards	Number of primary shards for the index	1	Consistent with the data nodes of the Opensearch cluster
Shard Size	Size of a single shard	30	30
Enable Replicas	Whether to enable index replicas	No	Default is 1 replica when enabled; it is recommended to enable if there is sufficient disk space
Hot Data Retention	Duration for retaining hot data	0	Keep default (this setting does not take effect if ES does not have a hot-warm-cold architecture)
Advanced Settings	Additional advanced settings for the index	No	Keep default

Storage Engine: Doris¶

When configuring a workspace with a storage engine of Doris, the following configuration items can be modified:

Configuration Item	Description	Default Value	Recommended Value
Enable Replicas	Whether to enable replicas	No	It is recommended to enable if there is sufficient disk space
Hot Data Retention	Duration for retaining hot data on disk; data exceeding this retention period will be migrated to object storage	24	Can be set to a longer retention period if disk space is sufficient