admin cluster config generate

With the admin cluster config generate command, you can generate a dynamic configuration file based on the static configuration file on the YDB cluster.
The dynamic configuration uses the format of an extended static configuration; the command automates the conversion process.

General command syntax:

ydb [global options...] admin cluster config generate
  • global options — Global parameters.

View the description of the dynamic configuration generation command:

ydb admin cluster config generate --help

Examples

Generate the dynamic configuration based on the static configuration:

ydb admin cluster config generate > config.yaml

After executing this command, the config.yaml file will contain a YAML document in the following format:

metadata:
  kind: MainConfig
  cluster: ""
  version: 0
config:
  <static cluster configuration>

Using the Generated Dynamic Configuration

After generating the dynamic configuration, you can perform the following steps:

  1. Add configuration parameters to the dynamic configuration file.
  2. Apply the dynamic configuration to the cluster using the admin cluster config replace command.