Managing YDB configuration

This section contains commands for managing the YDB cluster configuration.

• Apply the dynconfig.yaml configuration to the cluster:

  ydb admin cluster config replace -f dynconfig.yaml
  

• Check if it is possible to apply the configuration dynconfig.yaml to the cluster (check all validators, the configuration version in the yaml file must be 1 higher than the cluster configuration version, the cluster name must match):

  ydb admin cluster config replace -f dynconfig.yaml --dry-run
  

• Apply the dynconfig.yaml configuration to the cluster, ignoring version and cluster checks (the version and cluster values will be overwritten with correct values):

  ydb admin cluster config replace -f dynconfig.yaml --force
  

• Fetch the main cluster configuration:

  ydb admin cluster config fetch
  

• Generate all possible final configurations for dynconfig.yaml:

  ydb admin cluster config resolve --all -f dynconfig.yaml
  

• Generate the final configuration for dynconfig.yaml with the tenant=/Root/test and canary=true labels:

  ydb admin cluster config resolve -f dynconfig.yaml --label tenant=/Root/test --label canary=true
  

• Generate the final configuration for dynconfig.yaml for labels from node 100:

  ydb admin cluster config resolve -f dynconfig.yaml --node-id 100
  

• Generate a dynamic configuration file, based on a static configuration on the cluster:

  ydb admin cluster config genereate
  

• Initialize a directory with the configuration, using the path to the configuration file:

  ydb admin node config init --config-dir <path_to_directory> --from-config <path_to_configuration_file>
  

• Initialize a directory with the configuration, using the configuration from the cluster:

  ydb admin node config init --config-dir <path_to_directory> --seed-node <cluster_node_endpoint>
  

Managing temporary configuration

This section contains commands for managing temporary configurations.

• Fetch all temporary configurations from the cluster:

  ydb admin volatile-config fetch --all --output-directory <dir>
  

• Fetch the temporary configuration with id 1 from the cluster:

  ydb admin volatile-config fetch --id 1
  

• Apply the volatile.yaml temporary configuration to the cluster:

  ydb admin volatile-config add -f volatile.yaml
  

• Delete temporary configurations with ids 1 and 3 on the cluster:

  ydb admin volatile-config drop --id 1 --id 3
  

• Delete all temporary configurations on the cluster:

  ydb admin volatile-config drop --all
  

Parameters

• -f, --filename <filename.yaml> — read input from a file, - for STDIN. For commands that accept multiple files (e.g., resolve), you can specify it multiple times, the file type will be determined by the metadata field
• --output-directory <dir> — dump/resolve files to a directory
• --strip-metadata — remove the metadata field from the output
• --all — extends the output of commands to the entire configuration (see advanced configuration)
• --allow-unknown-fields — allows ignoring unknown fields in the configuration

Scenarios

Update the main cluster configuration

# Fetch the cluster configuration
ydb admin cluster config fetch > dynconfig.yaml
# Edit the configuration with your favorite editor
vim dynconfig.yaml
# Apply the configuration dynconfig.yaml to the cluster
ydb admin cluster config replace -f dynconfig.yaml

Similarly, in one line:

ydb admin cluster config fetch | yq '.config.actor_system_config.scheduler.resolution = 128' | ydb admin cluster config replace -f -

Command output:

OK

View the configuration for a specific set of labels

ydb admin cluster config resolve --remote --label tenant=/Root/db1 --label canary=true

Command output:

---
label_sets:
- dynamic:
    type: COMMON
    value: true
config:
  actor_system_config:
    use_auto_config: true
    node_type: COMPUTE
    cpu_count: 4

View the configuration for a specific node

ydb admin cluster config resolve --remote --node-id <node_id>

Command output:

---
label_sets:
- dynamic:
    type: COMMON
    value: true
config:
  actor_system_config:
    use_auto_config: true
    node_type: COMPUTE
    cpu_count: 4

Save all configurations locally

ydb admin cluster config fetch --all --output-directory <configs_dir>
ls <configs_dir>

Command output:

dynconfig.yaml volatile_1.yaml volatile_3.yaml

View all configurations locally

ydb admin cluster config fetch --all

Command output:

---
metadata:
  kind: main
  cluster: unknown
  version: 1
config:
  actor_system_config:
    use_auto_config: true
    node_type: COMPUTE
    cpu_count: 4
allowed_labels: {}
selector_config: []
---
metadata:
  kind: volatile
  cluster: unknown
  version: 1
  id: 1
# some comment example
selectors:
- description: test
  selector:
    tenant: /Root/db1
  config:
    actor_system_config: !inherit
      use_auto_config: true
      cpu_count: 12

View the final configuration for a specific node from the locally saved original configuration

ydb admin cluster config resolve -k <configs_dir> --node-id <node_id>

Command output:

---
label_sets:
- dynamic:
    type: COMMON
    value: true
config:
  actor_system_config:
    use_auto_config: true
    node_type: COMPUTE
    cpu_count: 4