This guide lists some of the supported advanced parameters that allow you to configure your Managed Databases (also called Cloud Databases) for OpenSearch according to your use cases.
Requirements
- a Public Cloud project in your OVHcloud account
- a database running on your OVHcloud Managed Databases (this guide can help you to meet this requirement)
- access to your OVHcloud Control Panel or the OVHcloud API
Instructions
NOTE: The management of advanced parameters is not supported via Terraform.
Using the OVHcloud Control Panel
Please refer to this guide to learn how to change your advanced parameters from the OVHcloud Control Panel.
Using API
Please refer to this guide to learn how to change your advanced parameters from the OVHcloud API.
Advanced parameters for OpenSearch
Below is a summary of some configuration options available for the OpenSearch service. You can find a complete list of configuration options via OVHcloud API.
| Parameter | opensearch.action_auto_create_index_enabled |
| Value type | boolean |
| Minimum | |
| Maximum | |
| Description | Explicitly allow or block automatic creation of indices. Defaults to true. |
| Parameter | opensearch.cluster_max_shards_per_node |
| Value type | long |
| Minimum | 100 |
| Maximum | 10000 |
| Description | Controls the number of shards allowed in the cluster per data node. |
| Parameter | opensearch.cluster_routing_allocation_node_concurrent_recoveries |
| Value type | long |
| Minimum | 2 |
| Maximum | 16 |
| Description | The number of concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2. |
| Parameter | opensearch.http_max_content_length |
| Value type | long |
| Minimum | 1 |
| Maximum | 2147483647 |
| Description | Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. |
| Parameter | opensearch.http_max_header_size |
| Value type | long |
| Minimum | 1024 |
| Maximum | 262144 |
| Description | The max size of allowed headers, in bytes. |
| Parameter | opensearch.http_max_initial_line_length |
| Value type | long |
| Minimum | 1024 |
| Maximum | 65536 |
| Description | The max length of an HTTP URL, in bytes. |
| Parameter | opensearch.indices_memory_index_buffer_size |
| Value type | long |
| Minimum | 3 |
| Maximum | 40 |
| Description | Percentage value. The default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but cause performance issues for query performance. |
| Parameter | opensearch.indices_queries_cache_size |
| Value type | long |
| Minimum | 3 |
| Maximum | 40 |
| Description | Percentage value. The default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionalities. |
| Parameter | opensearch.indices_query_bool_max_clause_count |
| Value type | long |
| Minimum | 64 |
| Maximum | 4096 |
| Description | The maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value. |
| Parameter | opensearch.indices_recovery_max_bytes_per_sec |
| Value type | long |
| Minimum | 40 |
| Maximum | 400 |
| Description | Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40 MB. |
| Parameter | opensearch.indices_recovery_max_concurrent_file_chunks |
| Value type | long |
| Minimum | 2 |
| Maximum | 5 |
| Description | The number of file chunks sent in parallel for each recovery. Defaults to 2. |
| Parameter | opensearch.override_main_response_version |
| Value type | boolean |
| Minimum | |
| Maximum | |
| Description | Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. The default is false. |
| Parameter | opensearch.script_max_compilations_rate |
| Value type | string |
| Minimum | |
| Maximum | |
| Description | Script compilation circuit breaker limits the number of inline script compilations within a period of time. The default is use-context. |
| Parameter | opensearch.thread_pool_analyze_queue_size |
| Value type | long |
| Minimum | 10 |
| Maximum | 2000 |
| Description | Size for the thread pool queue. |
| Parameter | opensearch.thread_pool_analyze_size |
| Value type | long |
| Minimum | 1 |
| Maximum | 128 |
| Description | Size for the thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
| Parameter | opensearch.thread_pool_force_merge_size |
| Value type | long |
| Minimum | 1 |
| Maximum | 128 |
| Description | Size for the thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
| Parameter | opensearch.thread_pool_get_queue_size |
| Value type | long |
| Minimum | 10 |
| Maximum | 2000 |
| Description | Size for the thread pool queue. |
| Parameter | opensearch.thread_pool_get_size |
| Value type | long |
| Minimum | 1 |
| Maximum | 128 |
| Description | Size for the thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
| Parameter | opensearch.thread_pool_search_queue_size |
| Value type | long |
| Minimum | 10 |
| Maximum | 2000 |
| Description | Size for the thread pool queue. |
| Parameter | opensearch.thread_pool_search_size |
| Value type | long |
| Minimum | 1 |
| Maximum | 128 |
| Description | Size for the thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
| Parameter | opensearch.thread_pool_search_throttled_queue_size |
| Value type | long |
| Minimum | 10 |
| Maximum | 2000 |
| Description | Size for the thread pool queue. |
| Parameter | opensearch.thread_pool_search_throttled_size |
| Value type | long |
| Minimum | 1 |
| Maximum | 128 |
| Description | Size for the thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
| Parameter | opensearch.thread_pool_write_queue_size |
| Value type | long |
| Minimum | 10 |
| Maximum | 2000 |
| Description | Size for the thread pool queue. |
| Parameter | opensearch.thread_pool_write_size |
| Value type | long |
| Minimum | 1 |
| Maximum | 128 |
| Description | Size for the thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. |
Go further
For more information and tutorials, please see our other Cloud Databases support guides or explore the guides for other OVHcloud products and services.