Configuration V1

Warning

This article describes working with YDB clusters using configuration V1. Configuration V1 was the main way to configure clusters managed by YDB versions below v25.1. Starting from version v25.1, YDB supports configuration V2, which is the recommended way to configure YDB clusters with version v25.1 and above. For clusters using configuration V2, the instructions in this article are not applicable.

If your cluster has already been updated to version v25.1 or above but still uses configuration V1, it is recommended to plan migration to configuration V2, as support for configuration V1 will be discontinued in future versions of YDB.

This section of the YDB documentation describes Configuration V1, which is the main way to configure YDB clusters deployed using YDB versions below v25.1.

Configuration V1 is a two-level YDB cluster configuration system consisting of static configuration and dynamic configuration:

  1. Static configuration: a YAML format file that is located locally on each static node and used when starting the ydbd server process. This configuration contains, among other things, static group and State Storage settings.

  2. Dynamic configuration: a YAML format file that is an extended version of static configuration. It is loaded via CLI and reliably stored in the Console tablet, which then distributes the configuration to all dynamic cluster nodes. Using dynamic configuration is optional.

You can learn more about Configuration V1 in the Configuration V1 Overview section.

Starting from version v25.1, YDB supports Configuration V2, a unified approach to configuration in a single file format. When using Configuration V2, automatic configuration of static group and State Storage becomes possible. When deploying new clusters on YDB version v25.1 and above, it is recommended to use Configuration V2.

Main materials: