Skip to content

Commit 46c0f9f

Browse files
committed
move out cluster/
1 parent 5e2a231 commit 46c0f9f

25 files changed

+126
-156
lines changed

ydb/docs/en/core/cluster/index.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

ydb/docs/en/core/cluster/logs.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

ydb/docs/en/core/cluster/toc_i.yaml

Lines changed: 0 additions & 27 deletions
This file was deleted.

ydb/docs/en/core/cluster/toc_p.yaml

Lines changed: 0 additions & 4 deletions
This file was deleted.

ydb/docs/en/core/deploy/toc_p.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
items:
22
- name: Overview
33
href: index.md
4-
- name: Logging
5-
href: ../cluster/logs.md
6-
- name: Topology
7-
href: ../concepts/topology.md
84
- include: { mode: link, path: toc_i.yaml }

ydb/docs/en/core/devops/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ This section of {{ ydb-short-name }} documentation covers everything you need to
44

55
* **[Ansible](ansible/index.md)**: for deployments on bare metal and virtual machines.
66
* **[Kubernetes](kubernetes/index.md)**: for containerized deployments.
7-
* **[Manual](../cluster/index.md)**: generic instructions.
7+
* **[Manual](manual/index.md)**: generic instructions.
88

99
Regardless of the chosen infrastructure management method, it is recommended to familiarize yourself with [{{ ydb-short-name }} system requirements](system-requirements.md) first.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Manual {{ ydb-short-name }} cluster management overview
2+
3+
This section provides information about deploying, configuring, maintaining, monitoring, and performing diagnostics of multi-node [{{ ydb-short-name }} clusters](../../concepts/cluster/index.md).
4+
5+
Main resources:
6+
7+
* [{#T}](../../deploy/index.md).
8+
* [{#T}](../../reference/embedded-ui/index.md).
9+
* [{#T}](../../maintenance/manual/index.md).
10+
* [{#T}](../../devops/manual/system-views.md).
11+
* [{#T}](../../administration/monitoring.md).
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Logging in {{ ydb-short-name }}
2+
3+
Each {{ ydb-short-name }} component writes messages to logs at different levels. They can be used to detect severe issues or identify the root causes.
4+
5+
## Logging setup {#log_setup}
6+
7+
You can configure logging for the various components of the YDB in the [Embedded UI](../../reference/embedded-ui/logs.md#change_log_level).
8+
9+
There are currently two options for running YDB logging: manually or using systemd.
10+
11+
### Manually {#log_setup_manually}
12+
13+
YDB provides standard mechanisms for collecting logs and metrics.
14+
Logging is done to standard `stdout` and `stderr` streams and can be redirected using popular solutions.
15+
16+
### Using systemd {#log_setup_systemd}
17+
18+
Default logs are written to `journald` and can be retrieved via `journalctl -u ydbd`.
Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
items:
2-
- include:
3-
mode: link
4-
path: ../../cluster/toc_p.yaml
2+
- name: Overview
3+
href: index.md
4+
- name: Deployment
5+
include: { mode: link, path: ../../deploy/toc_p.yaml }
6+
- name: Managing a cluster's disk subsystem
7+
include: { mode: link, path: ../../maintenance/manual/toc_p.yaml }
8+
- name: Monitoring
9+
items:
10+
- name: Setting up monitoring for a local YDB cluster
11+
href: ../../administration/monitoring.md
12+
- name: Grafana dashboards
13+
href: ../../administration/grafana-dashboards.md
14+
- name: Updating YDB
15+
href: ../../administration/upgrade.md
16+
- name: Changing an actor system's configuration
17+
href: ../../maintenance/manual/change_actorsystem_configs.md
18+
- name: Updating configurations via CMS
19+
href: ../../maintenance/manual/cms.md
520
- name: System views
621
href: system-views.md
22+
- name: Logging
23+
href: logging.md

ydb/docs/en/core/devops/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# {{ ydb-short-name }} system requirements and recommendations
22

3-
This section provides recommendations for deploying {{ ydb-short-name }} clusters that are relevant regardless of the chosen deployment method ([Ansible](./ansible/index.md), [Kubernetes](./kubernetes/index.md), or [manual](../cluster/index.md)).
3+
This section provides recommendations for deploying {{ ydb-short-name }} clusters that are relevant regardless of the chosen deployment method ([Ansible](./ansible/index.md), [Kubernetes](./kubernetes/index.md), or [manual](./manual/index.md)).
44

55
## Hardware configuration {#hardware}
66

ydb/docs/en/core/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In this guide, you will install a single-node local [{{ ydb-short-name }} cluster](concepts/databases.md#cluster) and execute simple queries against your [database](concepts/databases.md#database).
44

5-
Normally, {{ ydb-short-name }} stores data on multiple SSD/NVMe or HDD raw disk devices without any filesystem. However, for simplicity, this guide emulates disks in RAM or using a file in a regular filesystem. Thus, this setup is unsuitable for any production usage or even benchmarks. See the [cluster management documentation](cluster/index.md) to learn how to run {{ ydb-short-name }} in a production environment.
5+
Normally, {{ ydb-short-name }} stores data on multiple SSD/NVMe or HDD raw disk devices without any filesystem. However, for simplicity, this guide emulates disks in RAM or using a file in a regular filesystem. Thus, this setup is unsuitable for any production usage or even benchmarks. See the [documentation for DevOps Engineers](devops/index.md) to learn how to run {{ ydb-short-name }} in a production environment.
66

77
## Install and start {{ ydb-short-name }} {#install}
88

ydb/docs/en/core/security/audit-log.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ _An audit log_ is a stream that includes data about all the operations that trie
44

55
* Database: Creating, editing, and deleting databases.
66
* Directory: Creating and deleting.
7-
* Table: Creating or editing table scheme, changing the number of partitions, backup and recovery, copying and renaming, and deleting tables.
7+
* Table: Creating or editing table schema, changing the number of partitions, backup and recovery, copying and renaming, and deleting tables.
88
* Topic: Creating, editing, and deleting.
99
* ACL: Editing.
1010

@@ -18,7 +18,7 @@ You can use any of the listed destinations or their combinations.
1818

1919
If you forward the stream to a file, access to the audit log is set by file-system rights. Saving the audit log to a file is recommended for production installations.
2020

21-
Forwarding the audit log to the standard error stream (`stderr`) is recommended for test installations. Further stream processing is determined by the {{ ydb-short-name }} cluster [logging](../cluster/logs.md) settings.
21+
Forwarding the audit log to the standard error stream (`stderr`) is recommended for test installations. Further stream processing is determined by the {{ ydb-short-name }} cluster [logging](../devops/manual/logging.md) settings.
2222

2323
## Audit log events {#events}
2424

ydb/docs/redirects.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ common:
4949
to: /devops/kubernetes/initial-deployment.md
5050
- from: /cluster/system-requirements.md
5151
to: /devops/system-requirements.md
52+
- from: /cluster/index.md
53+
to: /devops/index.md
54+
- from: /cluster/logs.md
55+
to: /devops/manual/logging.md
5256

5357
# DBA-related redirects
5458
- from: /db/index.md

ydb/docs/ru/core/cluster/index.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

ydb/docs/ru/core/cluster/logs.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

ydb/docs/ru/core/cluster/toc_i.yaml

Lines changed: 0 additions & 41 deletions
This file was deleted.

ydb/docs/ru/core/cluster/toc_p.yaml

Lines changed: 0 additions & 4 deletions
This file was deleted.

ydb/docs/ru/core/deploy/toc_p.yaml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
items:
22
- name: Обзор
33
href: index.md
4-
- name: Системные требования и рекомендации
5-
href: ../devops/system-requirements.md
6-
- name: Логирование
7-
href: ../cluster/logs.md
8-
- name: Топология
9-
href: ../concepts/topology.md
104
- include: { mode: link, path: toc_i.yaml }

ydb/docs/ru/core/devops/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
* **[Ansible](ansible/index.md)**: для развертываний на физическом оборудовании и виртуальных машинах.
66
* **[Kubernetes](kubernetes/index.md)**: для развёртываний в контейнерах.
7-
* **[Вручную](../cluster/index.md)**: общие инструкции.
7+
* **[Вручную](manual/index.md)**: общие инструкции.
88

99
Вне зависимости от выбранного способа управления инфраструктурой, перед началом работы рекомендуется ознакомиться с [системными требованиями {{ ydb-short-name }}](system-requirements.md).
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Обзор управления кластером {{ ydb-short-name }} вручную
2+
3+
В этом разделе описано развертывание, конфигурирование, обслуживание, мониторинг и диагностика многоузловых [кластеров {{ ydb-short-name }}](../../concepts/cluster/index.md).
4+
5+
* [{#T}](../../deploy/index.md).
6+
* [{#T}](../../reference/embedded-ui/index.md).
7+
* [{#T}](../../maintenance/manual/index.md).
8+
* [{#T}](../../devops/manual/system-views.md).
9+
* [{#T}](../../administration/monitoring.md).
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Логирование в {{ ydb-short-name }}
2+
3+
Каждый компонент {{ ydb-short-name }} пишет сообщения разного уровня в логи (журналы). По ним можно детектировать критические проблемы или разобраться в причинах неполадок.
4+
5+
## Настройка логирования {#log_setup}
6+
7+
Настройку логирования у отдельных компонентов можно произвести во [встроенном интерфейсе](../../reference/embedded-ui/logs.md#change_log_level) {{ ydb-short-name }}.
8+
9+
На данный момент есть два варианта для запуска логирования {{ ydb-short-name }}: вручную и с использованием systemd.
10+
11+
### Вручную {#log_setup_manually}
12+
13+
Для удобства YDB предоставляет стандартные механизмы сбора логов и метрик.
14+
Логирование осуществляется в стандартные каналы `stdout` и `stderr` и может быть перенаправлено при помощи популярных решений.
15+
16+
### С использованием systemd {#log_setup_systemd}
17+
18+
По умолчению пишутся в `journald` и достать их можно через `journalctl -u ydbd`.
Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
items:
2-
- include:
3-
mode: link
4-
path: ../../cluster/toc_p.yaml
2+
- name: Обзор
3+
href: index.md
4+
- name: Развертывание
5+
include: { mode: link, path: ../../deploy/toc_p.yaml }
6+
- name: Управление дисковой подсистемой кластера
7+
include: { mode: link, path: ../../maintenance/manual/toc_p.yaml }
8+
- name: Мониторинг
9+
items:
10+
- name: Настройка мониторинга локального кластера YDB
11+
href: ../../administration/monitoring.md
12+
- name: Дашборды Grafana
13+
href: ../../administration/grafana-dashboards.md
14+
- name: Справочник метрик
15+
href: ../../reference/observability/metrics/index.md
16+
- name: Трассировка
17+
include: { mode: link, path: ../../reference/observability/tracing/toc_p.yaml }
18+
- name: Обновление
19+
href: ../../administration/upgrade.md
20+
- name: Изменение конфигурации актор-системы
21+
href: ../../maintenance/manual/change_actorsystem_configs.md
22+
- name: Управление конфигурацией кластера
23+
items:
24+
- name: Обзор конфигурации
25+
href: ../../maintenance/manual/config-overview.md
26+
- name: Статическая конфигурация кластера
27+
href: ../../deploy/configuration/config.md
28+
- name: Динамическая конфигурация кластера
29+
href: ../../maintenance/manual/dynamic-config.md
30+
- name: DSL конфигурации кластера
31+
href: ../../maintenance/manual/dynamic-config-selectors.md
32+
- name: Временная конфигурация
33+
href: ../../maintenance/manual/dynamic-config-volatile-config.md
34+
- name: Изменение конфигураций через CMS
35+
href: ../../maintenance/manual/cms.md
536
- name: Системные таблицы
637
href: system-views.md
38+
- name: Логирование
39+
href: logging.md

ydb/docs/ru/core/devops/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Системные требования и рекомендации для {{ ydb-short-name }}
22

3-
В данном разделе приводятся рекомендации для развертывания кластеров {{ ydb-short-name }}, применимые вне зависимости от выбранного способа управления инфраструктурой ([Ansible](ansible/index.md), [Kubernetes](kubernetes/index.md), или [вручную](../cluster/index.md)).
3+
В данном разделе приводятся рекомендации для развертывания кластеров {{ ydb-short-name }}, применимые вне зависимости от выбранного способа управления инфраструктурой ([Ansible](ansible/index.md), [Kubernetes](kubernetes/index.md), или [вручную](manual/index.md)).
44

55
## Аппаратная конфигурация {#hardware}
66

0 commit comments

Comments
 (0)