Add docs for backup checksums #13666

pixcc · 2025-01-21T14:12:44Z

Changelog category

Documentation (changelog entry is not required)

github-actions · 2025-01-21T14:14:08Z

⚪ 2025-01-21 14:14:08 UTC Pre-commit check linux-x86_64-release-asan for 21c5a6e has started.
⚪ 2025-01-21 14:14:23 UTC Artifacts will be uploaded here
⚪ 2025-01-21 14:16:55 UTC ya make is running...
🟢 2025-01-21 14:18:48 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-01-21 14:18:55 UTC Build successful.

github-actions · 2025-01-21T14:16:37Z

⚪ 2025-01-21 14:16:36 UTC Pre-commit check linux-x86_64-relwithdebinfo for 21c5a6e has started.
⚪ 2025-01-21 14:16:48 UTC Artifacts will be uploaded here
⚪ 2025-01-21 14:19:18 UTC ya make is running...
🟢 2025-01-21 14:19:24 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-01-21 14:19:30 UTC Build successful.

github-actions · 2025-01-21T14:17:41Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2025-01-21T15:05:49Z

⚪ 2025-01-21 15:05:48 UTC Pre-commit check linux-x86_64-release-asan for bfe6f78 has started.
⚪ 2025-01-21 15:06:00 UTC Artifacts will be uploaded here
⚪ 2025-01-21 15:08:29 UTC ya make is running...
🟢 2025-01-21 15:10:04 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-01-21 15:10:10 UTC Build successful.

github-actions · 2025-01-21T15:07:50Z

⚪ 2025-01-21 15:07:50 UTC Pre-commit check linux-x86_64-relwithdebinfo for bfe6f78 has started.
⚪ 2025-01-21 15:07:53 UTC Artifacts will be uploaded here
⚪ 2025-01-21 15:10:13 UTC ya make is running...
🟢 2025-01-21 15:10:19 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-01-21 15:10:24 UTC Build successful.

github-actions · 2025-01-21T15:09:39Z

✅ Documentation build

Revision built successfully
Revision preview link

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/file-structure.md

github-actions · 2025-01-22T10:46:08Z

⚪ 2025-01-22 10:46:07 UTC Pre-commit check linux-x86_64-release-asan for f1f03f6 has started.
⚪ 2025-01-22 10:46:12 UTC Artifacts will be uploaded here
⚪ 2025-01-22 10:48:39 UTC ya make is running...
🟢 2025-01-22 10:50:10 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-01-22 10:50:16 UTC Build successful.

github-actions · 2025-01-22T10:47:40Z

⚪ 2025-01-22 10:47:39 UTC Pre-commit check linux-x86_64-relwithdebinfo for f1f03f6 has started.
⚪ 2025-01-22 10:47:52 UTC Artifacts will be uploaded here
⚪ 2025-01-22 10:50:22 UTC ya make is running...
🟢 2025-01-22 10:50:28 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS	PASSED	ERRORS	FAILED	SKIPPED	MUTED^?
0	0	0	0	0	0

🟢 2025-01-22 10:50:34 UTC Build successful.

github-actions · 2025-01-22T10:48:49Z

✅ Documentation build

Revision built successfully
Revision preview link

CyberROFL

Русская версия — ок.

CyberROFL · 2025-01-22T10:50:35Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md

+
+For each export file there is a paired file with the extension `.sha256`, which stores its checksum.
+
+File checksum can be validated using the `sha256sum` console utility:


Может все-таки check, а не validate?

@anton-bobkov @blinkov подскажете какой слово лучше всего подходит? Я вижу что встречаются варианты - verify/validate/check checksum

По мне так "to validate a checksum", но "to check/verify data integrity". "To check a checksum" точно не вариант.

CyberROFL · 2025-01-22T10:51:04Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_import.md

@@ -31,6 +31,7 @@ To run the command to import data from an S3 storage, specify the [S3 connection

 `--description STRING`: A text description of the operation saved in the operation history
 `--retries NUM`: The number of import retries to be made by the server. The default value is 10.
+`--skip-checksum-validation`: Skip the step of validating imported objects checksums


anton-bobkov · 2025-01-22T15:05:24Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md

+
+{% note info %}
+
+Checksums of exported files are only available for export to S3-compatible object storage at this moment.


Suggested change

Checksums of exported files are only available for export to S3-compatible object storage at this moment.

Checksum generation is currently available only for files to be exported to S3-compatible object storage.

anton-bobkov · 2025-01-22T15:24:16Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md

+
+{% endnote %}
+
+For each export file there is a paired file with the extension `.sha256`, which stores its checksum.


Suggested change

For each export file there is a paired file with the extension `.sha256`, which stores its checksum.

{{ ydb-short-name }} generates a checksum for each export file and saves it to a corresponding` .sha256` file.

anton-bobkov · 2025-01-22T15:48:54Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_import.md

@@ -31,6 +31,7 @@ To run the command to import data from an S3 storage, specify the [S3 connection

 `--description STRING`: A text description of the operation saved in the operation history
 `--retries NUM`: The number of import retries to be made by the server. The default value is 10.
+`--skip-checksum-validation`: Skip the step of validating imported objects checksums


Suggested change

`--skip-checksum-validation`: Skip the step of validating imported objects checksums

`--skip-checksum-validation`: Skip checksum validation for imported objects.

anton-bobkov · 2025-01-23T05:37:56Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md

@@ -31,6 +31,7 @@

 `--description STRING`: Текстовое описание операции, сохраняемое в истории операций
 `--retries NUM`: Количество повторных попыток загрузки, которые будет предпринимать сервер. По умолчанию 10.
+`--skip-checksum-validation`: Пропустить этап валидации контрольных сумм загружаемых объектов


Suggested change

`--skip-checksum-validation`: Пропустить этап валидации контрольных сумм загружаемых объектов

`--skip-checksum-validation`: Пропустить этап валидации контрольных сумм загружаемых объектов.

anton-bobkov · 2025-01-23T06:18:13Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md

+
+For each export file there is a paired file with the extension `.sha256`, which stores its checksum.
+
+File checksum can be validated using the `sha256sum` console utility:


Suggested change

File checksum can be validated using the `sha256sum` console utility:

To check data integrity of the export files, use the `sha256sum` console utility:

anton-bobkov · 2025-01-23T06:18:49Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_import.md

@@ -31,6 +31,7 @@ To run the command to import data from an S3 storage, specify the [S3 connection

 `--description STRING`: A text description of the operation saved in the operation history


Suggested change

`--description STRING`: A text description of the operation saved in the operation history

`--description STRING`: A text description of the operation saved in the operation history.

anton-bobkov · 2025-01-23T06:19:20Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md

@@ -31,6 +31,7 @@

 `--description STRING`: Текстовое описание операции, сохраняемое в истории операций


Suggested change

`--description STRING`: Текстовое описание операции, сохраняемое в истории операций

`--description STRING`: Текстовое описание операции, сохраняемое в истории операций.

anton-bobkov · 2025-01-23T06:42:34Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/file-structure.md

+
+{% note info %}
+
+Контрольные суммы файлов выгрузки на данный момент доступны только для выгрузки в S3-совместимое объектное хранилище.


Suggested change

Контрольные суммы файлов выгрузки на данный момент доступны только для выгрузки в S3-совместимое объектное хранилище.

Контрольные суммы на данный момент создаются только для файлов выгрузки в S3-совместимое объектное хранилище.

anton-bobkov · 2025-01-23T06:52:08Z

ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md

+
+For each export file there is a paired file with the extension `.sha256`, which stores its checksum.
+
+File checksum can be validated using the `sha256sum` console utility:


По мне так "to validate a checksum", но "to check/verify data integrity". "To check a checksum" точно не вариант.

anton-bobkov · 2025-01-23T06:56:46Z

ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/file-structure.md

+
+{% endnote %}
+
+Для каждого файла выгрузки есть парный файл с расширением `.sha256`, в котором хранится его контрольная сумма.


Suggested change

Для каждого файла выгрузки есть парный файл с расширением `.sha256`, в котором хранится его контрольная сумма.

Для каждого файла выгрузки {{ ydb-short-name }} создаёт парный файл с расширением `.sha256`, в котором хранится его контрольная сумма.

Add docs for backup checksums

4514cb0

pixcc requested a review from CyberROFL January 21, 2025 14:12

pixcc requested a review from a team as a code owner January 21, 2025 14:12

pixcc self-assigned this Jan 21, 2025

github-actions bot added the documentation Improvements or additions to documentation label Jan 21, 2025

Add little fix

244d5e0

CyberROFL reviewed Jan 21, 2025

View reviewed changes

Fix

e6d5190

pixcc requested a review from CyberROFL January 22, 2025 10:44

CyberROFL reviewed Jan 22, 2025

View reviewed changes

anton-bobkov reviewed Jan 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs for backup checksums #13666

Add docs for backup checksums #13666

pixcc commented Jan 21, 2025

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025

CyberROFL left a comment

CyberROFL Jan 22, 2025

pixcc Jan 22, 2025

anton-bobkov Jan 23, 2025

CyberROFL Jan 22, 2025

anton-bobkov Jan 22, 2025

anton-bobkov Jan 22, 2025

anton-bobkov Jan 22, 2025

anton-bobkov Jan 23, 2025

anton-bobkov Jan 23, 2025

anton-bobkov Jan 23, 2025

anton-bobkov Jan 23, 2025

anton-bobkov Jan 23, 2025

anton-bobkov Jan 23, 2025

anton-bobkov Jan 23, 2025


		For each export file there is a paired file with the extension `.sha256`, which stores its checksum.

		File checksum can be validated using the `sha256sum` console utility:


		{% note info %}

		Checksums of exported files are only available for export to S3-compatible object storage at this moment.

	Checksums of exported files are only available for export to S3-compatible object storage at this moment.
	Checksum generation is currently available only for files to be exported to S3-compatible object storage.


		{% endnote %}

		For each export file there is a paired file with the extension `.sha256`, which stores its checksum.

	For each export file there is a paired file with the extension `.sha256`, which stores its checksum.
	{{ ydb-short-name }} generates a checksum for each export file and saves it to a corresponding` .sha256` file.

	`--skip-checksum-validation`: Skip the step of validating imported objects checksums
	`--skip-checksum-validation`: Skip checksum validation for imported objects.

	`--skip-checksum-validation`: Пропустить этап валидации контрольных сумм загружаемых объектов
	`--skip-checksum-validation`: Пропустить этап валидации контрольных сумм загружаемых объектов.

	File checksum can be validated using the `sha256sum` console utility:
	To check data integrity of the export files, use the `sha256sum` console utility:

		@@ -31,6 +31,7 @@ To run the command to import data from an S3 storage, specify the [S3 connection

		`--description STRING`: A text description of the operation saved in the operation history

		@@ -31,6 +31,7 @@

		`--description STRING`: Текстовое описание операции, сохраняемое в истории операций


		{% note info %}

		Контрольные суммы файлов выгрузки на данный момент доступны только для выгрузки в S3-совместимое объектное хранилище.

	Контрольные суммы файлов выгрузки на данный момент доступны только для выгрузки в S3-совместимое объектное хранилище.
	Контрольные суммы на данный момент создаются только для файлов выгрузки в S3-совместимое объектное хранилище.


		{% endnote %}

		Для каждого файла выгрузки есть парный файл с расширением `.sha256`, в котором хранится его контрольная сумма.

	Для каждого файла выгрузки есть парный файл с расширением `.sha256`, в котором хранится его контрольная сумма.
	Для каждого файла выгрузки {{ ydb-short-name }} создаёт парный файл с расширением `.sha256`, в котором хранится его контрольная сумма.

Add docs for backup checksums #13666

Are you sure you want to change the base?

Add docs for backup checksums #13666

Conversation

pixcc commented Jan 21, 2025

Changelog category

github-actions bot commented Jan 21, 2025 • edited Loading

github-actions bot commented Jan 21, 2025 • edited Loading

github-actions bot commented Jan 21, 2025

✅ Documentation build

github-actions bot commented Jan 21, 2025 • edited Loading

github-actions bot commented Jan 21, 2025 • edited Loading

github-actions bot commented Jan 21, 2025

✅ Documentation build

github-actions bot commented Jan 22, 2025 • edited Loading

github-actions bot commented Jan 22, 2025 • edited Loading

github-actions bot commented Jan 22, 2025

✅ Documentation build

CyberROFL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading