From d26fbc1a0ca94871b4c1a46619ab1c1e82d71c1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=93=D1=80=D0=B8=D0=B3=D0=BE=D1=80=D0=B8=D0=B9=20=D0=A1?= =?UTF-8?q?=D0=B0=D1=84=D1=80=D0=BE=D0=BD=D0=BE=D0=B2?= Date: Fri, 31 Jul 2026 11:52:27 +0000 Subject: [PATCH] Update README.md --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/README.md b/README.md index d5ed534..712d84e 100644 --- a/README.md +++ b/README.md @@ -366,6 +366,71 @@ go version

(К началу)

+## Файл конфигурации + +Основным и единственным файлом конфигурации субд futriix является Файл `config.toml`, который используется только при первом запуске кластера для инициализации базовых параметров. Он содержит все настройки СУБД: + +* **[cluster]** — параметры кластеризации (IP, порты, Raft, таймауты) + +* **[storage]** — настройки хранилища (размер страницы, ограничения) + +* **[wal]** — журнал предзаписи (сегменты, синхронизация) + +* **[mvcc]** — многоверсионность (версии, TTL) + +* **[saga]** — распределённые транзакции + +* **[replication]** — репликация данных + +* **[backpressure]** — защита от перегрузок + +* и другие секции для всех подсистем, подробно о которых можно узнать ознакомившись с содержанием файла **"config.toml"** + +
+
+ + +> [!IMPORTANT] +> **Важно: После первого запуска файл config.toml больше не используется для чтения — вся конфигурация управляется через Raft!!!** + +
+
+ + +### Конфигурация в кластере Raft + +После первого запуска все изменения конфигурации хранятся в Raft-логе, а не в локальном файле: + +```sh +Raft-лог (raft_data/) +├── команды изменения конфигурации +├── снапшоты состояния +└── история всех изменений с версиями +``` + +**Преимущества выбранного подхода:** + +* Единая конфигурация на всех узлах кластера +* Изменения применяются синхронно через Raft-консенсус +* Возможность отката к предыдущей версии +* История всех изменений с указанием автора + +
+
+ +**Способы изменения:** + + * `REPL` — config set cluster.heartbeat_timeout_ms 2000 + + * `HTTP API` — POST /api/v1/config + + * `CLI` — futriix config set --key=... --value=... + + * `Подписка` — компоненты могут отслеживать изменения в реальном времени + +

(К началу)

+ + ## Быстрый старт Быстрый старт — это краткое руководство для тех, кто хочет сразу попробовать **futriix** в деле. Здесь вы найдёте минимально необходимые команды для установки, запуска и первого взаимодействия с СУБД. Мы намеренно опустили тонкости настройки, чтобы вы могли оценить основные возможности без погружения в документацию. Полный список параметров и режимов работы описан в следующих разделах.