Skip to content

Commit 057c59b

Browse files
UgnineSirdisUgnineSirdis
committed
Docs for AwsClientConfig
1 parent 2222fcc commit 057c59b

File tree

6 files changed

+108
-2
lines changed

6 files changed

+108
-2
lines changed

‎ydb/docs/en/core/reference/configuration/aws_client_config.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# aws_client_config
2+
3+
The `aws_client_config` section defines default settings for AWS SDK clients that {{ ydb-short-name }} uses for S3 and other AWS-compatible storage interactions. Values here are applied whenever a per-storage configuration does not override them.
4+
5+
## Syntax
6+
7+
```yaml
8+
aws_client_config:
9+
log_config:
10+
log_level: 0
11+
filename_prefix: ""
12+
verify_ssl: true
13+
request_timeout_ms: 0
14+
http_request_timeout_ms: 0
15+
connection_timeout_ms: 10000
16+
enable_tcp_keep_alive: true
17+
tcp_keep_alive_interval_ms: 30000
18+
max_connections_count: 32
19+
executor_threads_count: 32
20+
ca_path: "/etc/ssl/certs"
21+
ca_file: ""
22+
```
23+
24+
## Parameters
25+
26+
| Parameter | Default | Description |
27+
| --- | --- | --- |
28+
| `log_config.log_level` | `0` (Off) | AWS SDK log level (`Off`, `Fatal`, `Error`, `Warn`, `Info`, `Debug`, `Trace` mapped to `0–6`). Controls verbosity for AWS client logs. |
29+
| `log_config.filename_prefix` | — | Prefix for AWS SDK log files. When set, files are created as `<prefix>YYYY-MM-DD-HH.log`; otherwise logs go to stdout/stderr. |
30+
| `verify_ssl` | `true` | Whether to validate TLS certificates when connecting to AWS endpoints. Set to `false` only for testing. |
31+
| `request_timeout_ms` | `0` (disabled) | Overall request timeout in milliseconds, including DNS lookup, connect, TLS handshake, and data transfer. `0` keeps the AWS SDK default of no request-level timeout. |
32+
| `http_request_timeout_ms` | `0` (disabled) | HTTP-layer timeout in milliseconds applied by the HTTP client (Curl). `0` keeps the AWS SDK default of no HTTP-layer timeout. |
33+
| `connection_timeout_ms` | `10000` | TCP connect timeout in milliseconds. |
34+
| `enable_tcp_keep_alive` | `true` | Enables TCP keep-alive on client sockets. |
35+
| `tcp_keep_alive_interval_ms` | `30000` | Interval between TCP keep-alive probes in milliseconds. For Curl this is rounded to whole seconds; must be ≥ 15000 ms. |
36+
| `max_connections_count` | `32` | Maximum concurrent TCP connections the AWS HTTP client may open. |
37+
| `executor_threads_count` | `32` | Size of the pooled thread executor shared by AWS clients for a given endpoint. Controls parallelism for async requests. |
38+
| `ca_path` | `"/etc/ssl/certs"` | Path to a directory with CA certificates used to verify TLS connections. |
39+
| `ca_file` | — | Path to a single CA certificate bundle file. Used when the trust store is not in the default location. |
40+
41+
### Log levels
42+
43+
| Level | Value | Description |
44+
| --- | --- | --- |
45+
| `Off` | `0` | Disable AWS SDK logging. |
46+
| `Fatal` | `1` | Fatal errors only. |
47+
| `Error` | `2` | Non-fatal errors. |
48+
| `Warn` | `3` | Warnings that may need attention. |
49+
| `Info` | `4` | High-level informational messages. |
50+
| `Debug` | `5` | Debug information. |
51+
| `Trace` | `6` | Most verbose diagnostic output. |

‎ydb/docs/en/core/reference/configuration/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following top-level configuration sections are available, listed in alphabet
1313
|| **Section** | **Required** | **Description** ||
1414
|| [{#T}](actor_system_config.md) | Yes | CPU resource allocation across actor system pools ||
1515
|| [{#T}](auth_config.md) | No | Authentication and authorization settings ||
16+
|| [{#T}](aws_client_config.md) | No | AWS client default settings ||
1617
|| [{#T}](blob_storage_config.md) | No | Static cluster group configuration for system tablets ||
1718
|| [{#T}](client_certificate_authorization.md) | No | Client certificate authentication ||
1819
|| [{#T}](domains_config.md) | No | Cluster domain configuration including Blob Storage and State Storage ||
@@ -47,4 +48,3 @@ While this documentation section focuses on complete reference documentation for
4748
## Sample Cluster Configurations
4849

4950
You can find model cluster configurations for deployment in the [repository](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/yaml_config_examples/). Check them out before deploying a cluster.
50-

‎ydb/docs/en/core/reference/configuration/toc_p.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ items:
33
href: actor_system_config.md
44
- name: auth_config
55
href: auth_config.md
6+
- name: aws_client_config
7+
href: aws_client_config.md
68
- name: blob_storage_config
79
href: blob_storage_config.md
810
- name: client_certificate_authorization

‎ydb/docs/ru/core/reference/configuration/aws_client_config.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# aws_client_config
2+
3+
Секция `aws_client_config` задаёт параметры по умолчанию для клиентов AWS SDK, которые {{ ydb-short-name }} использует для работы с S3 и другими совместимыми хранилищами. Эти значения применяются, если конкретная конфигурация хранилища не переопределяет их.
4+
5+
## Синтаксис
6+
7+
```yaml
8+
aws_client_config:
9+
log_config:
10+
log_level: 0
11+
filename_prefix: ""
12+
verify_ssl: true
13+
request_timeout_ms: 0
14+
http_request_timeout_ms: 0
15+
connection_timeout_ms: 10000
16+
enable_tcp_keep_alive: true
17+
tcp_keep_alive_interval_ms: 30000
18+
max_connections_count: 32
19+
executor_threads_count: 32
20+
ca_path: "/etc/ssl/certs"
21+
ca_file: ""
22+
```
23+
24+
## Параметры
25+
26+
| Параметр | Значение по умолчанию | Описание |
27+
| --- | --- | --- |
28+
| `log_config.log_level` | `0` (Off) | Уровень логов AWS SDK (`Off`, `Fatal`, `Error`, `Warn`, `Info`, `Debug`, `Trace`, значения `0–6`). Определяет подробность логов клиентов AWS. |
29+
| `log_config.filename_prefix` | — | Префикс для файлов логов AWS SDK. При задании файлы создаются как `<prefix>YYYY-MM-DD-HH.log`; иначе вывод идёт в stdout/stderr. |
30+
| `verify_ssl` | `true` | Проверять TLS-сертификаты при подключении к конечным точкам AWS. Отключать стоит только для тестов. |
31+
| `request_timeout_ms` | `0` (выкл.) | Общий тайм-аут запроса в миллисекундах, включая DNS, соединение, TLS и передачу данных. `0` оставляет поведение AWS SDK без тайм-аута. |
32+
| `http_request_timeout_ms` | `0` (выкл.) | Тайм-аут на уровне HTTP-клиента (Curl), в миллисекундах. `0` — без тайм-аута. |
33+
| `connection_timeout_ms` | `10000` | Тайм-аут установления TCP-соединения в миллисекундах. |
34+
| `enable_tcp_keep_alive` | `true` | Включить TCP keep-alive на клиентских сокетах. |
35+
| `tcp_keep_alive_interval_ms` | `30000` | Интервал между keep-alive пакетами в миллисекундах. Для Curl округляется до секунд; должен быть ≥ 15000. |
36+
| `max_connections_count` | `32` | Максимум одновременных TCP‑соединений, которые может открыть HTTP-клиент AWS. |
37+
| `executor_threads_count` | `32` | Размер пула потоков, разделяемого клиентами AWS для одного endpoint. Определяет параллелизм асинхронных запросов. |
38+
| `ca_path` | `"/etc/ssl/certs"` | Путь к каталогу с корневыми сертификатами для проверки TLS. |
39+
| `ca_file` | — | Путь к файлу с набором корневых сертификатов. Используется, если хранилище доверенных сертификатов расположено нестандартно. |
40+
41+
### Уровни логов
42+
43+
| Уровень | Значение | Описание |
44+
| --- | --- | --- |
45+
| `Off` | `0` | Отключить логирование AWS SDK. |
46+
| `Fatal` | `1` | Только фатальные ошибки. |
47+
| `Error` | `2` | Некритические ошибки. |
48+
| `Warn` | `3` | Предупреждения, требующие внимания. |
49+
| `Info` | `4` | Общая информационная сводка. |
50+
| `Debug` | `5` | Отладочная информация. |
51+
| `Trace` | `6` | Максимально подробная диагностика. |

‎ydb/docs/ru/core/reference/configuration/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
|| **Раздел** | **Обязателен** | **Описание** ||
1313
|| [{#T}](actor_system_config.md) | Да | Распределение CPU-ресурсов по пулам акторной системы ||
1414
|| [{#T}](auth_config.md) | Нет | Настройки аутентификации и авторизации ||
15+
|| [{#T}](aws_client_config.md) | Нет | Настройки клиента AWS по умолчанию ||
1516
|| [{#T}](blob_storage_config.md) | Нет | Конфигурация статической группы кластера для системных таблеток ||
1617
|| [{#T}](bridge_config.md) | Нет | Конфигурация [режима bridge](../../concepts/bridge.md) ||
1718
|| [{#T}](client_certificate_authorization.md) | Нет | Аутентификация с помощью клиентских сертификатов ||
@@ -49,4 +50,3 @@
4950
## Примеры конфигураций кластеров
5051

5152
Модельные конфигурации кластера для развертывания можно найти в [репозитории](https://github.com/ydb-platform/ydb/tree/main/ydb/deploy/yaml_config_examples/). Изучите их перед развертыванием кластера.
52-

‎ydb/docs/ru/core/reference/configuration/toc_p.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ items:
33
href: actor_system_config.md
44
- name: auth_config
55
href: auth_config.md
6+
- name: aws_client_config
7+
href: aws_client_config.md
68
- name: blob_storage_config
79
href: blob_storage_config.md
810
- name: bridge_config

0 commit comments

Comments
 (0)