Skip to content

[docs] configuration v2 release candidate #17647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
8359b38
Change initial deployment doc
mregrock Jan 10, 2025
f2ff370
Remove update_config.md from Disk Subsystem Management
mregrock Feb 10, 2025
1de3f57
Docs distconf overview change (#14511)
mregrock Feb 17, 2025
4811fc3
[docs] further refactoring of DevOps docs (#14589)
blinkov Feb 21, 2025
2a0835d
Add node init command to doc (#14975)
mregrock Feb 28, 2025
fcb3c99
Maintenance some refactor
mregrock Mar 10, 2025
7c4bf49
Fix build
mregrock Mar 10, 2025
05db4d0
Merge with authtorization doc PR(#12710) (#15365)
mregrock Mar 12, 2025
f37d267
Add migration doc (#14381)
mregrock Mar 20, 2025
cb5c308
Fix review
mregrock Mar 20, 2025
64968a3
Merge branch 'docs-distconf' into docs-distconf-manual
mregrock Mar 20, 2025
fb202ed
merge main and fix build
blinkov Mar 21, 2025
5e31ecd
Merge branch 'main' of github.com:ydb-platform/ydb into docs-distconf…
blinkov Apr 24, 2025
ab9254b
Some refactor in maintenance/manual (#15504)
mregrock Mar 25, 2025
d3b07ea
ToC refactor (#16638)
mregrock Apr 14, 2025
dc1d375
Migration doc (#17383)
mregrock Apr 21, 2025
72619fc
Small fix
mregrock Apr 21, 2025
b7b0ece
a lot of minor textual changes
blinkov Apr 24, 2025
044c4c3
Squashed commit of the following:
blinkov Apr 24, 2025
fd87a30
adjust ydb-cli reference after merge
blinkov Apr 24, 2025
dab5088
more textual fixes and cross-links
blinkov Apr 25, 2025
daf813c
Rewrite overview and contributor docs for v2 + some minor changes
blinkov Apr 25, 2025
be032cc
fixes from review
blinkov Apr 28, 2025
8e9397c
remove unused file
blinkov Apr 28, 2025
563f5ea
more review fixes
blinkov Apr 28, 2025
2310bd1
more review fixes
blinkov Apr 28, 2025
2614e1e
merge main
blinkov Apr 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,4 @@ junk/

# YDB CLI configuration file location is `~/ydb/config/config.yaml`
config/config.yaml
path.bash.inc
265 changes: 85 additions & 180 deletions ydb/deploy/yaml_config_examples/block-4-2.yaml
Original file line number Diff line number Diff line change
@@ -1,185 +1,90 @@
# YDB configuration options and their values
# are described in documentaion https://ydb.tech/en/docs/deploy/configuration/config

# static erasure is the parameter that
# describes the fault tolerance mode of the
# cluster. See docs for more details https://ydb.tech/en/docs/deploy/configuration/config#domains-blob
static_erasure: block-4-2
host_configs: # the list of available host configurations in the cluster.
- drive:
- path: /dev/disk/by-partlabel/ydb_disk_ssd_01 # path of the first disk in the host configration.
type: SSD # kind of the disk: available kinds are SSD, NVME or HDD
- path: /dev/disk/by-partlabel/ydb_disk_ssd_02
type: SSD
host_config_id: 1 # the unique id of the host config
hosts:
- host: ydb-node-zone-a-1.local # storage node DNS name
host_config_id: 1 # numeric host configuration template identifier.
walle_location: # this parameter describes where host is located.
body: 1 # string representing a host serial number.
data_center: 'zone-a' # string representing the datacenter / availability zone where the host is located.
# if cluster is deployed using mirror-3-dc fault tolerance mode, all hosts must be distributed
# across 3 datacenters.
rack: '1' # string representing a rack identifier where the host is located.
# if cluster is deployed using block-4-2 erasure, all hosts should be distrubited
# accross at least 8 racks.
- host: ydb-node-zone-a-2.local
host_config_id: 1
walle_location:
body: 2
data_center: 'zone-a'
rack: '2'
- host: ydb-node-zone-a-3.local
host_config_id: 1
walle_location:
body: 3
data_center: 'zone-a'
rack: '3'
metadata:
kind: MainConfig
cluster: ""
version: 0
config:
yaml_config_enabled: true
erasure: block-4-2 # erasue is the parameter that describes
# the fault tolerance mode of the cluster.
# See docs for more details https://ydb.tech/en/docs/deploy/configuration/config#domains-blob
fail_domain_type: disk
self_management_config: # automatic management of static resources (static group, state storage, etc)
enabled: true
default_disk_type: SSD # default disk type used for group creation of both kinds
host_configs: # the list of available host configurations in the cluster.
- drive:
- path: /dev/disk/by-partlabel/ydb_disk_ssd_01 # path of the first disk in the host configration.
type: SSD # kind of the disk: available kinds are SSD, NVME or HDD
- path: /dev/disk/by-partlabel/ydb_disk_ssd_02
type: SSD
host_config_id: 1 # the unique id of the host config
hosts:
- host: ydb-node-zone-a-1.local # storage node DNS name
host_config_id: 1 # numeric host configuration template identifier.
location: # this parameter describes where host is located.
body: 1 # string representing a host serial number.
data_center: 'zone-a' # string representing the datacenter / availability zone where the host is located.
# if cluster is deployed using mirror-3-dc fault tolerance mode, all hosts must be distributed
# across 3 datacenters.
rack: '1' # string representing a rack identifier where the host is located.
# if cluster is deployed using block-4-2 erasure, all hosts should be distrubited
# accross at least 8 racks.
- host: ydb-node-zone-a-2.local
host_config_id: 1
location:
body: 2
data_center: 'zone-a'
rack: '2'
- host: ydb-node-zone-a-3.local
host_config_id: 1
location:
body: 3
data_center: 'zone-a'
rack: '3'

- host: ydb-node-zone-a-4.local
host_config_id: 1
walle_location:
body: 4
data_center: 'zone-a'
rack: '4'
- host: ydb-node-zone-a-5.local
host_config_id: 1
walle_location:
body: 5
data_center: 'zone-a'
rack: '5'
- host: ydb-node-zone-a-6.local
host_config_id: 1
walle_location:
body: 6
data_center: 'zone-a'
rack: '6'
- host: ydb-node-zone-a-4.local
host_config_id: 1
location:
body: 4
data_center: 'zone-a'
rack: '4'
- host: ydb-node-zone-a-5.local
host_config_id: 1
location:
body: 5
data_center: 'zone-a'
rack: '5'
- host: ydb-node-zone-a-6.local
host_config_id: 1
location:
body: 6
data_center: 'zone-a'
rack: '6'

- host: ydb-node-zone-a-7.local
host_config_id: 1
walle_location:
body: 7
data_center: 'zone-a'
rack: '7'
- host: ydb-node-zone-a-8.local
host_config_id: 1
walle_location:
body: 8
data_center: 'zone-a'
rack: '8'

domains_config:
domain:
# There can be only one root domain in a cluster. Domain name prefixes all scheme objects names, e.g. full name of a table table1 in database db1
# in a cluster with domains_config.domain.name parameter set to Root would be equal to /Root/db1/table1
- name: Root
storage_pool_types:
- kind: ssd
pool_config:
box_id: 1
# fault tolerance mode name - none, block-4-2, or mirror-3-dc.
# See docs for more details https://ydb.tech/en/docs/deploy/configuration/config#domains-blob
erasure_species: block-4-2
kind: ssd
pdisk_filter:
- property:
- type: SSD # device type to match host_configs.drive.type
vdisk_kind: Default
state_storage:
- ring:
node: [1, 2, 3, 4, 5, 6, 7, 8]
nto_select: 5
ssid: 1
table_service_config:
sql_version: 1
actor_system_config: # the configuration of the actor system which descibes how cores of the instance are distributed
executor: # accross different types of workloads in the instance.
- name: System # system executor of the actor system. in this executor YDB launches system type of workloads, like system tablets
# and reads from storage.
threads: 2 # the number of threads allocated to system executor.
type: BASIC
- name: User # user executor of the actor system. In this executor YDB launches user workloads, like datashard activities,
# queries and rpc calls.
threads: 3 # the number of threads allocated to user executor.
type: BASIC
- name: Batch # user executor of the actor system. In this executor YDB launches batch operations, like scan queries, table
# compactions, background compactions.
threads: 2 # the number of threads allocated to the batch executor.
type: BASIC
- name: IO # the io executor. In this executor launches sync operations and writes logs.
threads: 1
time_per_mailbox_micro_secs: 100
type: IO
- name: IC # the interconnect executor which YDB uses for network communications accross different nodes of the cluster.
spin_threshold: 10
threads: 1 # the number of threads allocated to the interconnect executor.
time_per_mailbox_micro_secs: 100
type: BASIC
scheduler:
progress_threshold: 10000
resolution: 256
spin_threshold: 0
blob_storage_config: # configuration of static blobstorage group.
# YDB uses this group to store system tablets' data, like SchemeShard
service_set:
groups:
- erasure_species: block-4-2 # fault tolerance mode name for the static group
rings: # in block-4-2 must have exactly 1 ring or availability zone.
- fail_domains:
- vdisk_locations: # fail domains of the static group describe where each vdisk of the static group should be located.
- node_id: "ydb-node-zone-a-1.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-2.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-3.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-4.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-5.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-6.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-7.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
- vdisk_locations:
- node_id: "ydb-node-zone-a-8.local"
pdisk_category: SSD
path: /dev/disk/by-partlabel/ydb_disk_ssd_01
channel_profile_config:
profile:
- channel:
- erasure_species: block-4-2
pdisk_category: 1
storage_pool_kind: ssd
- erasure_species: block-4-2
pdisk_category: 1
storage_pool_kind: ssd
- erasure_species: block-4-2
pdisk_category: 1
storage_pool_kind: ssd
profile_id: 0
interconnect_config:
start_tcp: true
encryption_mode: OPTIONAL
path_to_certificate_file: "/opt/ydb/certs/node.crt"
path_to_private_key_file: "/opt/ydb/certs/node.key"
path_to_ca_file: "/opt/ydb/certs/ca.crt"
grpc_config:
cert: "/opt/ydb/certs/node.crt"
key: "/opt/ydb/certs/node.key"
ca: "/opt/ydb/certs/ca.crt"
services_enabled:
- legacy
- host: ydb-node-zone-a-7.local
host_config_id: 1
location:
body: 7
data_center: 'zone-a'
rack: '7'
- host: ydb-node-zone-a-8.local
host_config_id: 1
location:
body: 8
data_center: 'zone-a'
rack: '8'
interconnect_config:
start_tcp: true
encryption_mode: OPTIONAL
path_to_certificate_file: "/opt/ydb/certs/node.crt"
path_to_private_key_file: "/opt/ydb/certs/node.key"
path_to_ca_file: "/opt/ydb/certs/ca.crt"
grpc_config:
cert: "/opt/ydb/certs/node.crt"
key: "/opt/ydb/certs/node.key"
ca: "/opt/ydb/certs/ca.crt"
services_enabled:
- legacy
Loading