Change install instruction for ydb-dstool #11834
Conversation
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
| ydb-dstool -e <bs_endpoint> 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`. |
There was a problem hiding this comment.
| * `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`. | |
| * `bs_endpoint`: URI of the cluster's HTTP endpoint, the same endpoint that serves the [Embedded UI](../../embedded-ui/index.md). Example: `http://localhost:8765`. |
|
|
||
| 1. Test it by running the command that shows cluster information: | ||
| ```bash | ||
| curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash |
There was a problem hiding this comment.
| curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash | |
| curl -sSL 'https://install.ydb.tech/dstool' | bash |
| ```bash | ||
| ydb-dstool -e <bs_endpoint> cluster list | ||
| ``` | ||
| The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. |
There was a problem hiding this comment.
| The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. | |
| The script will install the {{ ydb-short-name }} DSTool. If the script is run from a `bash` or `zsh` shell, it will also add the `ydb-dstool` executable to the `PATH` environment variable. Otherwise, you can run it from the `~/ydb-dstool/bin` folder or add it to `PATH` manually. |
There was a problem hiding this comment.
Technically, it adds to PATH the path to the folder containing the executable, not the executable's path.
| The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. | ||
|
|
||
| * `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`. | ||
| {% note info %} |
There was a problem hiding this comment.
| {% note info %} |
| {% note info %} | ||
|
|
||
| Result: | ||
| 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. |
There was a problem hiding this comment.
| 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. |
| 1. Run the command: | ||
|
|
||
| ```bash | ||
| curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash |
There was a problem hiding this comment.
| curl -sSL 'https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.sh' | bash | |
| curl -sSL 'https://install.ydb.tech/dstool' | bash |
| The script will install the {{ ydb-short-name }} DSTool and add the executable file path to the `PATH` environment variable. | ||
|
|
||
| 1. To update the environment variables, restart the command shell. | ||
|
|
||
| 1. Test it by running the command that shows cluster information: | ||
|
|
||
| {% include [test step](./_includes/test.md) %} |
There was a problem hiding this comment.
Copy-paste: move this to an include file.
| - in **PowerShell**: | ||
|
|
||
| ```powershell | ||
| iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1') |
There was a problem hiding this comment.
| iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1') | |
| iex (New-Object System.Net.WebClient).DownloadString('https://install.ydb.tech/dstool-windows') |
| - in **CMD**: | ||
|
|
||
| ```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'))" |
There was a problem hiding this comment.
| @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-ydb-dstool/install.ps1'))" | |
| @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://install.ydb.tech/dstool-windows'))" |
| @"%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. Specify whether to add the executable file path to the `PATH` environment variable: |
There was a problem hiding this comment.
| 1. Specify whether to add the executable file path to the `PATH` environment variable: | |
| 1. Specify whether to add `ydb-dstool` to the `PATH` environment variable: |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ |
|
⚪ |
❌ Documentation buildRevision build failed |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed |
1 similar comment
❌ Documentation buildRevision build failed |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed |
kruall
added
the
rebase-and-check
github-actions
bot
removed
the
rebase-and-check
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed Build logsErrors (6)❌ /en/reference/ydb-dstool/_includes/unix_install.md: 13: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /en/reference/ydb-dstool/_includes/unix_install.md: 5: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /en/reference/ydb-dstool/_includes/unix_install.md: 7: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "curl -sSL 'https://install.ydb..."] ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 13: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 5: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 7: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "curl -sSL 'https://install.ydb..."] |
❌ Documentation buildRevision build failed Build logsErrors (6)❌ /en/reference/ydb-dstool/_includes/unix_install.md: 13: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /en/reference/ydb-dstool/_includes/unix_install.md: 5: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /en/reference/ydb-dstool/_includes/unix_install.md: 7: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "curl -sSL 'https://install.ydb..."] ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 13: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 5: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 7: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "curl -sSL 'https://install.ydb..."] |
kruall
force-pushed
the
dstool/change_install_docs
branch
from
ce6e020 to
a57d13a
Compare
❌ Documentation buildRevision build failed Build logsErrors (4)❌ /en/reference/ydb-dstool/_includes/unix_install.md: 13: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /en/reference/ydb-dstool/_includes/unix_install.md: 5: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 13: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines ❌ /ru/reference/ydb-dstool/_includes/unix_install.md: 5: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines |
kruall
force-pushed
the
dstool/change_install_docs
branch
from
a57d13a to
2890f2e
Compare
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
kruall
force-pushed
the
dstool/change_install_docs
branch
from
2890f2e to
3ec4e78
Compare
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
github-actions
bot
added
documentation
| curl -sSL 'https://install.ydb.tech/dstool' | bash | ||
| ``` | ||
|
|
||
| The script will install the {{ ydb-short-name }} DSTool. If the script is run from a `bash` or `zsh` shell, it will also add the `ydb-dstool` executable to the `PATH` environment variable. Otherwise, you can run it from the `~/ydb-dstool/bin` folder or add it to `PATH` manually. |
There was a problem hiding this comment.
Я, кстати, против ~/ydb-dstool/bin. На мой взгляд у ydb, dstool и ydbops должен быть один каталог ydb
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
Co-authored-by: Anton Bobkov <anton-bobkov@yandex-team.ru>
3 participants
Changelog entry
Change ydb-dstool from python package to bin
Changelog category
Additional information
...