Skip to content

Commit d9526ba

Browse files
committed
merge
1 parent f23d4ea commit d9526ba

File tree

155 files changed

+3759
-701
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+3759
-701
lines changed

ydb/docs/en/core/changelog-server.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Release date: December 24, 2024.
5050
* Added support for [asynchronous replication](./concepts/async-replication), that allows synchronizing data between YDB databases in near real time. It can also be used for data migration between databases with minimal downtime for applications interacting with these databases.
5151
* Added support for [views](./concepts/datamodel/view), which can be enabled by the cluster administrator using the `enable_views` setting in [dynamic configuration](./maintenance/manual/dynamic-config#updating-dynamic-configuration).
5252
* Extended [federated query](./concepts/federated_query/) capabilities to support new external data sources: MySQL, Microsoft SQL Server, and Greenplum.
53-
* Published [documentation](./devops/manual/federated-queries/connector-deployment) on deploying YDB with [federated query](./concepts/federated_query/) functionality (manual setup).
53+
* Published [documentation](./devops/deployment-options/manual/federated-queries/connector-deployment.md) on deploying YDB with [federated query](./concepts/federated_query/) functionality (manual setup).
5454
* Added a new launch parameter `FQ_CONNECTOR_ENDPOINT` for YDB Docker containers that specifies an external data source connector address. Added support for TLS encryption for connections to the connector and the ability to expose the connector service port locally on the same host as the dynamic YDB node.
5555
* Added an [auto-partitioning mode](./concepts/topic#autopartitioning) for topics, where partitions can dynamically split based on load while preserving message read-order and exactly-once guarantees. The mode can be enabled by the cluster administrator using the settings `enable_topic_split_merge` and `enable_pqconfig_transactions_at_scheme_shard` in [dynamic configuration](./maintenance/manual/dynamic-config#updating-dynamic-configuration).
5656
* Added support for transactions involving [topics](./concepts/topic) and row-based tables, enabling transactional data transfer between tables and topics, or between topics, ensuring no data loss or duplication. Transactions can be enabled by the cluster administrator using the settings `enable_topic_service_tx` and `enable_pqconfig_transactions_at_scheme_shard` in [dynamic configuration](./maintenance/manual/dynamic-config#updating-dynamic-configuration).
@@ -78,7 +78,7 @@ Release date: December 24, 2024.
7878
* [Added](https://github.com/ydb-platform/ydb-embedded-ui/pull/1438) a tab with information about [tablets](./concepts/glossary#tablet).
7979
* [Added](https://github.com/ydb-platform/ydb-embedded-ui/pull/1289) a tab with details about [distributed storage groups](./concepts/glossary#storage-group).
8080
* [Added](https://github.com/ydb-platform/ydb-embedded-ui/pull/1218) a setting to trace all queries and display tracing results.
81-
* Enhanced the PDisk page with [attributes](https://github.com/ydb-platform/ydb-embedded-ui/pull/1069), disk space consumption details, and a button to initiate [disk decommissioning](./devops/manual/decommissioning).
81+
* Enhanced the PDisk page with [attributes](https://github.com/ydb-platform/ydb-embedded-ui/pull/1069), disk space consumption details, and a button to initiate [disk decommissioning](./devops/deployment-options/manual/decommissioning.md).
8282
* [Added](https://github.com/ydb-platform/ydb-embedded-ui/pull/1313) information about currently running queries.
8383
* [Added](https://github.com/ydb-platform/ydb-embedded-ui/pull/1291) a row limit setting for query editor output and a notification when results exceed the limit.
8484
* [Added](https://github.com/ydb-platform/ydb-embedded-ui/pull/1049) a tab to display top CPU-consuming queries over the last hour.
@@ -123,7 +123,7 @@ Release date: August 20, 2024.
123123

124124
### Functionality
125125

126-
* Added the ability to set [maintenance task priorities](./devops/manual/maintenance-without-downtime#priority) in the [cluster management system](./concepts/glossary#cms).
126+
* Added the ability to set [maintenance task priorities](./devops/concepts/maintenance-without-downtime.md#priority) in the [cluster management system](./concepts/glossary.md#cms).
127127
* Added a setting to enable [stable names](./reference/configuration/#node-broker-config) for cluster nodes within a tenant.
128128
* Enabled retrieval of nested groups from the [LDAP server](./concepts/auth#ldap-auth-provider), improved host parsing in the [LDAP-configuration](./reference/configuration/#ldap-auth-config), and added an option to disable built-in authentication via login and password.
129129
* Added support for authenticating [dynamic nodes](./concepts/glossary#dynamic) using SSL-certificates.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
<<<<<<< HEAD
12
{% if oss == "true" %}Deploy the [connector](../architecture.md#connectors) {% else %}Deploy the connector{% endif %} and {% if oss == true %}[configure](../../../devops/manual/federated-queries/index.md) {% else %}configure{% endif %} the {{ ydb-short-name }} dynamic nodes to interact with it. Additionally, ensure network access from the {{ ydb-short-name }} dynamic nodes to the external data source (at the address specified in the `LOCATION` parameter of the `CREATE EXTERNAL DATA SOURCE` request). If network connection encryption to the external source was enabled in the previous step, the connector will use the system's root certificates (more details on TLS configuration can be found in the [guide](../../../devops/manual/federated-queries/connector-deployment.md) on deploying the connector).
3+
=======
4+
{% if oss == "true" %}Deploy the [connector](../architecture.md#connectors) {% else %}Deploy the connector{% endif %} and {% if oss == "true" %}[configure](../../../devops/deployment-options/manual/federated-queries/index.md) {% else %}configure{% endif %} the {{ ydb-short-name }} dynamic nodes to interact with it. Additionally, ensure network access from the {{ ydb-short-name }} dynamic nodes to the external data source (at the address specified in the `LOCATION` parameter of the `CREATE EXTERNAL DATA SOURCE` request). If network connection encryption to the external source was enabled in the previous step, the connector will use the system's root certificates. More details on TLS configuration can be found in the [guide](../../../devops/deployment-options/manual/federated-queries/connector-deployment.md) on deploying the connector.
5+
>>>>>>> 7e2446459dc ([docs] translate config v2 and other DevOps-related content (#18927))

ydb/docs/en/core/concepts/federated_query/architecture.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,26 @@ The functions of connectors include:
2424

2525
Thus, connectors form an abstraction layer that hides the specifics of external data sources from {{ ydb-short-name }}. The concise connector interface makes it easy to expand the list of supported sources with minimal changes to {{ ydb-short-name }}'s code.
2626

27-
Users can deploy [one of the ready-made connectors](../../devops/manual/federated-queries/connector-deployment.md) or write their own implementation in any programming language according to the [gRPC specification](https://github.com/ydb-platform/ydb/tree/main/ydb/library/yql/providers/generic/connector/api).
27+
Users can deploy [one of the ready-made connectors](../../devops/deployment-options/manual/federated-queries/connector-deployment.md) or write their own implementation in any programming language according to the [gRPC specification](https://github.com/ydb-platform/ydb/tree/main/ydb/library/yql/providers/generic/connector/api/service/protos).
2828

2929
## List of supported external data sources {#supported-datasources}
3030

3131
| Source | Support |
3232
|--------|---------|
33+
<<<<<<< HEAD
3334
| [ClickHouse](https://clickhouse.com/) | Via connector [fq-connector-go](../../devops/manual/federated-queries/connector-deployment.md#fq-connector-go) |
3435
| [Greenplum](https://www.greenplum.org/) | Via connector [fq-connector-go](../../devops/manual/federated-queries/connector-deployment.md#fq-connector-go) |
3536
| [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) | Via connector [fq-connector-go](../../devops/manual/federated-queries/connector-deployment.md#fq-connector-go) |
3637
| [MySQL](https://www.mysql.com/) | Via connector [fq-connector-go](../../devops/manual/federated-queries/connector-deployment.md#fq-connector-go) |
3738
| [PostgreSQL](https://www.postgresql.org/) | Via connector [fq-connector-go](../../devops/manual/federated-queries/connector-deployment.md#fq-connector-go) |
3839
| [S3](https://aws.amazon.com/ru/s3/) | Built into `ydbd` |
3940
| [{{ydb-short-name}}](https://ydb.tech/) | Via connector [fq-connector-go](../../devops/manual/federated-queries/connector-deployment.md#fq-connector-go) |
41+
=======
42+
| [ClickHouse](https://clickhouse.com/) | Via connector [fq-connector-go](../../devops/deployment-options/manual/federated-queries/connector-deployment.md#fq-connector-go) |
43+
| [Greenplum](https://www.greenplum.org/) | Via connector [fq-connector-go](../../devops/deployment-options/manual/federated-queries/connector-deployment.md#fq-connector-go) |
44+
| [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) | Via connector [fq-connector-go](../../devops/deployment-options/manual/federated-queries/connector-deployment.md#fq-connector-go) |
45+
| [MySQL](https://www.mysql.com/) | Via connector [fq-connector-go](../../devops/deployment-options/manual/federated-queries/connector-deployment.md#fq-connector-go) |
46+
| [PostgreSQL](https://www.postgresql.org/) | Via connector [fq-connector-go](../../devops/deployment-options/manual/federated-queries/connector-deployment.md#fq-connector-go) |
47+
| [S3](https://aws.amazon.com/s3/) | Built into `ydbd` |
48+
| [{{ydb-short-name}}](https://ydb.tech/) | Via connector [fq-connector-go](../../devops/deployment-options/manual/federated-queries/connector-deployment.md#fq-connector-go) |
49+
>>>>>>> 7e2446459dc ([docs] translate config v2 and other DevOps-related content (#18927))

ydb/docs/en/core/contributor/hive.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A {{ ydb-short-name }} cluster runs multiple Hives:
1111

1212
When a node registers, it informs Hive of the types of tablets and the number of tablets that can be run on it.
1313

14-
## Resource usage metrics
14+
## Resource Usage Metrics
1515

1616
Hive evaluates resource usage to evenly distribute tablets across nodes. For each tablet, the usage of four types of resources is tracked:
1717

@@ -28,25 +28,25 @@ Resource usage information is used for choosing a node for a tablet. For example
2828

2929
At certain moments, Hive may start an auto-balancing process that moves tablets between nodes to improve load distribution. The situations when autobalancing occurs are listed below. The auto-balancer works iteratively, making decisions about moving tablets one at a time. It selects the most loaded node, chooses a tablet that runs on this node using weighted randomness, and chooses a more suitable node for it. This process is repeated until balance is restored. The way node load is determined depends on the type of balancing. For example, in case of CPU consumption imbalance, CPU usage is used. For uneven distribution of column-oriented tables, the number of tablets is used instead.
3030

31-
### Resource usage imbalance
31+
### Resource Usage Imbalance
3232

3333
To quantify the balance of resource usage, Hive uses the *Scatter* metric, which is calculated separately for each resource using the following formula:
3434

3535
$$\mathrm{Scatter} = \frac{\mathrm{MaxUsage} - \mathrm{MinUsage}}{\mathrm{MaxUsage}}$$
3636

3737
$\mathrm{MaxUsage}$ and $\mathrm{MinUsage}$ are, respectively, the maximum and minimum usage of a resource across all nodes. To normalize consumption on each node, the number of available resources on the node is used, which may vary between nodes. Under low loads, this metric may fluctuate significantly. To avoid this, when calculating $\mathrm{Scatter}$, it is assumed that resource usage cannot be lower than 30%. The balancer is triggered if $Scatter$ exceeds a threshold.
3838

39-
The maximum value of $Scatter$ across different resources is available as the [sensor](../devops/manual/monitoring.md) `Hive/MAX(BalanceScatter)` in the `tablets` subgroup.
39+
The maximum value of $Scatter$ across different resources is available as the [sensor](../devops/observability/monitoring.md) `Hive/MAX(BalanceScatter)` in the `tablets` subgroup.
4040

41-
### Node overload
41+
### Node Overload
4242

4343
Overloaded nodes can negatively affect {{ ydb-short-name }} performance. CPU overload raises latencies, and consuming all memory can cause the node to crash with an out-of-memory error. The balancer is triggered when the load of one node exceeds 90% while the load on another node falls below 70%.
4444

45-
The maximum resource usage on a node is reported by the `Hive/MAX(BalanceUsageMax)` [sensor](../devops/manual/monitoring.md) in the `tablets` subgroup.
45+
The maximum resource usage on a node is reported by the `Hive/MAX(BalanceUsageMax)` [sensor](../devops/observability/monitoring.md) in the `tablets` subgroup.
4646

47-
### Even distribution for a specific object
47+
### Even Distribution for a Specific Object
4848

4949
For tablets that use the Counter resource, the evenness of tablet distribution for each object (each table) is tracked in the form of the `ObjectImbalance` metric, similar to the $Scatter$ described above. Restarting nodes may break the balance in tablet distribution and trigger balancing.
5050

51-
The maximum value of `ObjectImbalance` across different objects is reported by the `Hive/MAX(BalanceObjectImbalance)` [sensor](../devops/manual/monitoring.md) in the `tablets` subgroup.
51+
The maximum value of `ObjectImbalance` across different objects is reported by the `Hive/MAX(BalanceObjectImbalance)` [sensor](../devops/observability/monitoring.md) in the `tablets` subgroup.
5252

ydb/docs/en/core/contributor/manage-releases.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Manage {{ ydb-short-name }} releases
1+
# Manage {{ ydb-short-name }} Releases
22

33
There are two products based on the source code from the [{{ ydb-short-name }} repository](https://github.com/ydb-platform/ydb) with independent release cycles:
44

55
- [{{ ydb-short-name }} server](#server)
66
- [{{ ydb-short-name }} command-line interface (CLI)](#cli)
77

8-
## {{ ydb-short-name }} server release cycle {#server}
8+
## {{ ydb-short-name }} Server Release Cycle {#server}
99

10-
### Release numbers and schedule {#server-versioning}
10+
### Release Numbers and Schedule {#server-versioning}
1111

1212
{{ ydb-short-name }} server version consists of three numbers separated by dots:
1313

@@ -21,13 +21,13 @@ Thus, {{ ydb-short-name }} server major version is a combination of the first tw
2121

2222
### Compatibility {#server-compatibility}
2323

24-
{{ ydb-short-name }} maintains compatibility between major versions to ensure a cluster can operate while its nodes run two adjacent major versions of the {{ ydb-short-name }} server executable. You may refer the [Updating {{ ydb-short-name }}](../devops/manual/upgrade.md) article to learn more about the cluster upgrade procedure.
24+
{{ ydb-short-name }} maintains compatibility between major versions to ensure a cluster can operate while its nodes run two adjacent major versions of the {{ ydb-short-name }} server executable. You may refer the [Updating {{ ydb-short-name }}](../devops/deployment-options/manual/update-executable.md) article to learn more about the cluster upgrade procedure.
2525

2626
Given the above compatibility target, major releases go in pairs: odd numbered releases add new functionality switched off by feature flags, and even numbered releases enable that functionality by default.
2727

2828
For instance, release `23.1` comes with the new functionality switched off. It can be incrementally rolled out to a cluster running `22.4`, without downtime. As soon as the whole cluster runs `23.1` nodes, you can manually toggle feature flags to test new functionality and later further upgrade it to `23.2` to fully leverage this new functionality.
2929

30-
### Release branches and tags {#server-branches-tags}
30+
### Release Branches and Tags {#server-branches-tags}
3131

3232
A release cycle for an odd major release starts by a member of a [YDB Release team](https://github.com/orgs/ydb-platform/teams/release) forking a new branch from the `main` branch. Major release branch name starts with prefix `stable-`, followed with the major version with dots replaced by dashes (for example, `stable-23-1`).
3333

@@ -47,15 +47,15 @@ During a testing iteration, code from release branches undergoes an extensive te
4747

4848
Based on a list of uncovered problems, the [{{ ydb-short-name }} Release team](https://github.com/orgs/ydb-platform/teams/release) decides if the current minor release can be promoted to be called "stable", or a new testing iteration must be started over with a new minor release tag. In fact, as soon as a critical problem is discovered during testing, developers fix it in the `main` branch, and backport changes to the release branch right away. So, by the time testing iteration finishes, there will be a new tag and a new testing iteration if there are some new commits on top of the current tag.
4949

50-
### Stable release {#server-stable}
50+
### Stable Release {#server-stable}
5151

5252
If testing iteration proves the quality of a minor release, the [YDB Release team](https://github.com/orgs/ydb-platform/teams/release) prepares the [release notes](../changelog-server.md), and publishes the YDB server release on both the [GitHub Releases](https://github.com/ydb-platform/ydb/releases) and [Downloads](../downloads/index.md#ydb-server) pages, therefore declaring it as "stable".
5353

5454
{% include [corp_release_stable.md](_includes/corp_release_stable.md) %}
5555

56-
## {{ ydb-short-name }} CLI (Command-Line Interface) release cycle {#cli}
56+
## {{ ydb-short-name }} CLI (Command-Line Interface) Release Cycle {#cli}
5757

58-
### Release numbers and schedule {#cli-versioning}
58+
### Release Numbers and Schedule {#cli-versioning}
5959

6060
{{ ydb-short-name }} CLI version consists of three numbers separated by dots:
6161

@@ -69,12 +69,12 @@ There's no schedule for the {{ ydb-short-name }} CLI minor releases, a new relea
6969

7070
In general, release cycle for {{ ydb-short-name }} CLI is much simpler and shorter than for the server, producing more frequent releases.
7171

72-
### Release tags {#cli-tags}
72+
### Release Tags {#cli-tags}
7373

7474
Tags for {{ ydb-short-name }} CLI are assigned on the `main` branch by a member of the [{{ ydb-short-name }} Release team](https://github.com/orgs/ydb-platform/teams/release) after running tests for some revision. To distinguish from the {{ ydb-short-name }} server tags, {{ ydb-short-name }} CLI tags have a `CLI_` prefix before the version number, for example [CLI_2.8.0](https://github.com/ydb-platform/ydb/tree/CLI_2.8.0).
7575

7676
{% include [corp_cli_tags.md](_includes/corp_cli_tags.md) %}
7777

78-
### Stable release {#cli-stable}
78+
### Stable Release {#cli-stable}
7979

8080
To declare a {{ ydb-short-name }} CLI tag as stable, a member of the [{{ ydb-short-name }} Release team](https://github.com/orgs/ydb-platform/teams/release) prepares the [release notes](../changelog-cli.md), and publishes the release on the [GitHub Releases](https://github.com/ydb-platform/ydb/releases) and [Downloads](../downloads/index.md#ydb-cli) pages.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* Backup to files and recovery using {{ ydb-short-name }} CLI.
2+
* Backup to S3-compatible storage and recovery using {{ ydb-short-name }} CLI.

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

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

0 commit comments

Comments
 (0)