Changing Configurations via CMS

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.

Note

This method of changing configuration is deprecated. The recommended configuration method for V1 is described in the cluster dynamic configuration section.

Get Current Settings

The following command will get current settings for the cluster or tenant.

ydbd -s <endpoint> admin console configs load --out-dir <config-folder>
ydbd -s <endpoint> admin console configs load --out-dir <config-folder> --tenant <tenant-name>

Update Settings

First, you need to download the required config as indicated above, then you need to prepare a protobuf file with a change request.

Actions {
  AddConfigItem {
    ConfigItem {
      Cookie: "<cookie>"
      UsageScope {
        TenantAndNodeTypeFilter {
          Tenant: "<tenant-name>"
        }
      }
      Config {
          <config-name> {
              <full-config>
          }
      }
    }
  }
}

The UsageScope field is optional and is needed to apply settings for a specific tenant.

ydbd -s <endpoint> admin console configs update <protobuf-file>