From 5cb88de367eb4b129e3370f3196c844d92359e77 Mon Sep 17 00:00:00 2001 From: Anton Bobkov Date: Mon, 2 Dec 2024 16:59:20 +0300 Subject: [PATCH] Added numbers to steps, minor edits --- .../reference/ydb-dstool/_includes/test.md | 15 +++ .../en/core/reference/ydb-dstool/install.md | 104 +++++++++--------- .../reference/ydb-dstool/_includes/test.md | 15 +++ .../ru/core/reference/ydb-dstool/install.md | 104 +++++++++--------- 4 files changed, 128 insertions(+), 110 deletions(-) create mode 100644 ydb/docs/en/core/reference/ydb-dstool/_includes/test.md create mode 100644 ydb/docs/ru/core/reference/ydb-dstool/_includes/test.md diff --git a/ydb/docs/en/core/reference/ydb-dstool/_includes/test.md b/ydb/docs/en/core/reference/ydb-dstool/_includes/test.md new file mode 100644 index 000000000000..53c9edc5c710 --- /dev/null +++ b/ydb/docs/en/core/reference/ydb-dstool/_includes/test.md @@ -0,0 +1,15 @@ +```bash +ydb-dstool -e cluster list +``` + +* `bs_endpoint`: URI of the interface for {{ ydb-short-name }} cluster distributed storage management. The interface is accessible over HTTP on any cluster node on port 8765 by default. URI example: `http://localhost:8765`. + +Result: + +```text +┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐ +│ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │ +├───────┼───────┼───────┼────────┼────────┼───────┼────────┤ +│ 8 │ 16 │ 1 │ 5 │ 40 │ 1 │ 32 │ +└───────┴───────┴───────┴────────┴────────┴───────┴────────┘ +``` diff --git a/ydb/docs/en/core/reference/ydb-dstool/install.md b/ydb/docs/en/core/reference/ydb-dstool/install.md index 420910b8403d..639223e57dec 100644 --- a/ydb/docs/en/core/reference/ydb-dstool/install.md +++ b/ydb/docs/en/core/reference/ydb-dstool/install.md @@ -6,90 +6,84 @@ - Linux - To install the {{ ydb-short-name }} DSTool, run the command: + To install the {{ ydb-short-name }} DSTool, follow these steps: - ```bash - curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash - ``` + 1. Run the command: - The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. + ```bash + curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash + ``` - {% note info %} + The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. - The script will update the `PATH` variable only if you run it in the bash or zsh command shell. If you run the script in a different shell, add the path to the CLI to the `PATH` variable yourself. + {% note info %} - {% endnote %} + The script will update the `PATH` variable only if you run it in the bash or zsh command shell. If you run the script in a different shell, add the path to the CLI to the `PATH` variable manually. - To update the environment variables, restart the command shell. + {% endnote %} -- macOS + 1. To update the environment variables, restart the command shell. + + 1. Test it by running the command that shows cluster information: - To install the {{ ydb-short-name }} DSTool, run the command: + {% include [test step](./_includes/test.md) %} - ```bash - curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash - ``` +- macOS - The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. + To install the {{ ydb-short-name }} DSTool, follow these steps: - To update the environment variables, restart the command shell. + 1. Run the command: -- Windows + ```bash + curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash + ``` - You can install the {{ ydb-short-name }} DSTool using: + The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. - **PowerShell.** To do this, run the command: + 1. To update the environment variables, restart the command shell. - ```powershell - iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1') - ``` + 1. Test it by running the command that shows cluster information: - Specify whether to add the executable file path to the `PATH` environment variable: + {% include [test step](./_includes/test.md) %} - ```text - Add ydb-dstool installation dir to your PATH? [Y/n] - ``` +- Windows - **cmd.** To do this, run the command: + To install the {{ ydb-short-name }} DSTool, follow these steps: - ```cmd - @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1'))" - ``` + 1. Run the command: - Specify whether to add the executable file path to the `PATH` environment variable: + - in **PowerShell**: - ```text - Add ydb-dstool installation dir to your PATH? [Y/n] - ``` + ```powershell + iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1') + ``` - To update the environment variables, restart the command shell. + - in **CMD**: - {% note info %} + ```cmd + @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1'))" + ``` - The {{ ydb-short-name }} DSTool uses Unicode characters in the output of some commands. If these characters aren't displayed correctly in the Windows console, switch the encoding to UTF-8: + 1. Specify whether to add the executable file path to the `PATH` environment variable: - ```cmd - chcp 65001 - ``` + ```text + Add ydb-dstool installation dir to your PATH? [Y/n] + ``` - {% endnote %} + 1. To update the environment variables, restart the command shell. -{% endlist %} + {% note info %} -Test it by running the command that shows cluster information: + The {{ ydb-short-name }} DSTool uses Unicode characters in the output of some commands. If these characters aren't displayed correctly in the Windows console, switch the encoding to UTF-8: -```bash -ydb-dstool -e cluster list -``` + ```cmd + chcp 65001 + ``` -* `bs_endpoint`: URI of the interface for {{ ydb-short-name }} cluster distributed storage management. The interface is accessible over HTTP on any cluster node on port 8765 by default. URI example: `http://localhost:8765`. + {% endnote %} -Result: + 1. Test it by running the command that shows cluster information: -```text -┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐ -│ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │ -├───────┼───────┼───────┼────────┼────────┼───────┼────────┤ -│ 8 │ 16 │ 1 │ 5 │ 40 │ 1 │ 32 │ -└───────┴───────┴───────┴────────┴────────┴───────┴────────┘ -``` + {% include [test step](./_includes/test.md) %} + +{% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-dstool/_includes/test.md b/ydb/docs/ru/core/reference/ydb-dstool/_includes/test.md new file mode 100644 index 000000000000..9376406ae9b5 --- /dev/null +++ b/ydb/docs/ru/core/reference/ydb-dstool/_includes/test.md @@ -0,0 +1,15 @@ +```bash +ydb-dstool -e cluster list +``` + +* `bs_endpoint` — URI интерфейса управления распределенным хранилищем кластера {{ ydb-short-name }}. Интерфейс доступен на любом узле кластера по протоколу HTTP на порте 8765 по умолчанию. Пример URI: `http://localhost:8765`. + +Результат: + +```text +┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐ +│ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │ +├───────┼───────┼───────┼────────┼────────┼───────┼────────┤ +│ 8 │ 16 │ 1 │ 5 │ 40 │ 1 │ 32 │ +└───────┴───────┴───────┴────────┴────────┴───────┴────────┘ +``` diff --git a/ydb/docs/ru/core/reference/ydb-dstool/install.md b/ydb/docs/ru/core/reference/ydb-dstool/install.md index 9cce580948bd..e893bbedcf53 100644 --- a/ydb/docs/ru/core/reference/ydb-dstool/install.md +++ b/ydb/docs/ru/core/reference/ydb-dstool/install.md @@ -6,90 +6,84 @@ - Linux - Чтобы установить {{ ydb-short-name }} DSTool, выполните команду: + Чтобы установить {{ ydb-short-name }} DSTool: - ```bash - curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash - ``` + 1. Выполните команду: - Скрипт установит {{ ydb-short-name }} DSTool и добавит путь к исполняемому файлу в переменную окружения `PATH`. + ```bash + curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash + ``` - {% note info %} + Скрипт установит {{ ydb-short-name }} DSTool и добавит путь к исполняемому файлу в переменную окружения `PATH`. - Скрипт дополнит переменную `PATH`, только если его запустить в командной оболочке bash или zsh. Если вы запустили скрипт в другой оболочке, добавьте путь до CLI в переменную `PATH` самостоятельно. + {% note info %} - {% endnote %} + Скрипт дополнит переменную `PATH`, только если его запустить в командной оболочке bash или zsh. Если вы запустили скрипт в другой оболочке, добавьте путь до CLI в переменную `PATH` самостоятельно. - Чтобы обновить переменные окружения, перезапустите командную оболочку. + {% endnote %} -- macOS + 1. Чтобы обновить переменные окружения, перезапустите командную оболочку. + + 1. Проверьте работу, выполнив команду вывода информации о кластере: - Чтобы установить {{ ydb-short-name }} DSTool, выполните команду: + {% include [test step](./_includes/test.md) %} - ```bash - curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash - ``` +- macOS - Скрипт установит {{ ydb-short-name }} DSTool и добавит путь до исполняемого файла в переменную окружения `PATH`. + Чтобы установить {{ ydb-short-name }} DSTool: - Чтобы обновить переменные окружения, перезапустите командную оболочку. + 1. Выполните команду: -- Windows + ```bash + curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash + ``` - {{ ydb-short-name }} DSTool можно установить с помощью: + Скрипт установит {{ ydb-short-name }} DSTool и добавит путь до исполняемого файла в переменную окружения `PATH`. - * PowerShell. Для этого выполните команду: + 1. Чтобы обновить переменные окружения, перезапустите командную оболочку. - ```powershell - iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1') - ``` + 1. Проверьте работу, выполнив команду вывода информации о кластере: - Укажите, нужно ли добавить путь к исполняемому файлу в переменную окружения `PATH`: + {% include [test step](./_includes/test.md) %} - ```text - Add ydb-dstool installation dir to your PATH? [Y/n] - ``` +- Windows - * cmd. Для этого выполните команду: + Чтобы установить {{ ydb-short-name }} DSTool: - ```cmd - @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1'))" - ``` + 1. Выполните команду: - Укажите, нужно ли добавить путь к исполняемому в переменную окружения `PATH`: + - **PowerShell**: - ```text - Add ydb-dstool installation dir to your PATH? [Y/n] - ``` + ```powershell + iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1') + ``` - Чтобы обновить переменные окружения, перезапустите командную оболочку. + - **CMD**: - {% note info %} + ```cmd + @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1'))" + ``` - {{ ydb-short-name }} DSTool использует символы Юникода в выводе некоторых команд. При некорректном отображении таких символов в консоли Windows, переключите кодировку на UTF-8: + 1. Укажите, нужно ли добавить путь к исполняемому в переменную окружения `PATH`: - ```cmd - chcp 65001 - ``` + ```text + Add ydb-dstool installation dir to your PATH? [Y/n] + ``` - {% endnote %} + 1. Чтобы обновить переменные окружения, перезапустите командную оболочку. -{% endlist %} + {% note info %} -Проверьте работу, выполнив команду вывода информации о кластере: + {{ ydb-short-name }} DSTool использует символы Юникода в выводе некоторых команд. При некорректном отображении таких символов в консоли Windows, переключите кодировку на UTF-8: -```bash -ydb-dstool -e cluster list -``` + ```cmd + chcp 65001 + ``` -* `bs_endpoint` — URI интерфейса управления распределенным хранилищем кластера {{ ydb-short-name }}. Интерфейс доступен на любом узле кластера по протоколу HTTP на порте 8765 по умолчанию. Пример URI: `http://localhost:8765`. + {% endnote %} -Результат: + 1. Проверьте работу, выполнив команду вывода информации о кластере: -```text -┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐ -│ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │ -├───────┼───────┼───────┼────────┼────────┼───────┼────────┤ -│ 8 │ 16 │ 1 │ 5 │ 40 │ 1 │ 32 │ -└───────┴───────┴───────┴────────┴────────┴───────┴────────┘ -``` + {% include [test step](./_includes/test.md) %} + +{% endlist %}