Cluster configuration parameters
The cluster configuration is specified in a YAML file that is passed in the --yaml-config parameter when starting cluster nodes. This article describes the main configuration sections and provides links to detailed documentation for each section.
Each configuration section serves a specific purpose in setting up the YDB cluster, from hardware resource allocation to security settings and feature flags. The configuration is organized into logical groups corresponding to various aspects of cluster management and operation.
Configuration sections
The following configuration sections are available, listed in alphabetical order:
| Section | Required | Description |
|---|---|---|
| actor_system_config | Yes | Distribution of CPU resources across actor system pools |
| auth_config | No | Authentication and authorization settings |
| aws_client_config | No | AWS client default settings |
| blob_storage_config | No | Static cluster group configuration for system tablets |
| bridge_config | No | Configuration of the bridge mode |
| client_certificate_authorization | No | Authentication using client certificates |
| cms_config | No | Cluster Management System (CMS) configuration |
| domains_config | No | Cluster domain configuration, including Blob Storage and State Storage |
| feature_flags | No | Feature flags to enable or disable certain YDB capabilities |
| healthcheck_config | No | Thresholds and timeouts for the Health Check service |
| hive_config | No | Tablet launch configuration |
| host_configs | No | Typical host configurations for cluster nodes |
| hosts | Yes | Static cluster node configuration |
| kafka_proxy_config | No | Configuration of Kafka Proxy |
| log_config | No | Logging configuration and parameters |
| memory_controller_config | No | Memory allocation and limits for database components |
| monitoring_config | No | Parameters of YDB Monitoring |
| node_broker_config | No | Stable node name configuration |
| query_service_config | No | Configuration of external sources for federated queries |
| resource_broker_config | No | Resource broker for controlling CPU and memory consumption |
| security_config | No | Security configuration settings |
| self_management_config | No | Distributed configuration V2 and automatic cluster component management settings |
| system_tablet_backup_config | No | System tablet backup configuration |
| table_service_config | No | Query execution configuration settings |
| tli_config | No | Diagnostics parameters for transaction lock invalidation (TLI) |
| tls | No | TLS configuration for secure connections |
Practical recommendations
This documentation section provides a complete description of available settings, while practical recommendations on what and when to configure can be found in the following places:
- As part of the initial YDB cluster deployment:
- Ansible
- Kubernetes
- Manually
- As part of troubleshooting
- As part of security hardening
Cluster configuration examples
Sample cluster configurations for deployment can be found in the repository. Review them before deploying the cluster.