-
Notifications
You must be signed in to change notification settings - Fork 605
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
YDBOPS-11054 Install description #13636
base: main
Are you sure you want to change the base?
Changes from all commits
9426746
ee8e7d9
857fdfb
dfe87e0
9c0b436
13b2667
a234047
4a8595e
eb8bb9c
eb3b7e0
e58bd05
8bc052c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -14,18 +14,36 @@ Currently, only building from source is available as an installation option. The | |||||||||||
git clone https://github.com/ydb-platform/ydbops.git | ||||||||||||
``` | ||||||||||||
|
||||||||||||
3. Invoke `go build` in the repository root folder: | ||||||||||||
3. There are two ways to build `ydbops`: | ||||||||||||
|
||||||||||||
- Manual build. Invoke `go build` in the repository root folder: | ||||||||||||
|
||||||||||||
```bash | ||||||||||||
go build | ||||||||||||
``` | ||||||||||||
|
||||||||||||
The `ydbops` executable will be available in the repository root folder. | ||||||||||||
|
||||||||||||
## Download the binary from releases page | ||||||||||||
- Automated build. Invoke this command in the repository root folder: | ||||||||||||
|
||||||||||||
```bash | ||||||||||||
make build-in-docker | ||||||||||||
``` | ||||||||||||
|
||||||||||||
The `ydbops` executables will be available in the `bin` folder. Binary files are generated for Linux and MacOS (arm64, amd64). | ||||||||||||
|
||||||||||||
{% note warning %} | ||||||||||||
4. To install the binary file, execute the following command: | ||||||||||||
|
||||||||||||
This option has yet to be made available. | ||||||||||||
```bash | ||||||||||||
make install [INSTALL_DIR=<path_to_install_folder>] [BUILD_DIR=<path_to_build_folder>] | ||||||||||||
``` | ||||||||||||
|
||||||||||||
You must replace source folder if you have created binary file manually: | ||||||||||||
|
||||||||||||
```bash | ||||||||||||
make install INSTALL_DIR=путь_к_каталогу BUILD_DIR=. | ||||||||||||
``` | ||||||||||||
Comment on lines
+41
to
+45
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
|
||||||||||||
## Download the binary from releases page | ||||||||||||
|
||||||||||||
{% endnote %} | ||||||||||||
You can download binary releases from GitHub - [YDBOps Releases](https://github.com/ydb-platform/ydbops/releases). | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should lead people to https://ydb.tech/docs/en/downloads/#ydbops (and update it regularly) like with the other binaries, not to GitHub. |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -14,18 +14,37 @@ | |||||||||||||||||||||||
git clone https://github.com/ydb-platform/ydbops.git | ||||||||||||||||||||||||
``` | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
3. Вызовите `go build` в корневой папке репозитория: | ||||||||||||||||||||||||
3. Сборка исполняемого файла может быть выполнена одним из двух вариантов: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
- Ручная сборка с использованием компилятора Go. Вызовите `go build` в корневой папке репозитория: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
```bash | ||||||||||||||||||||||||
go build | ||||||||||||||||||||||||
``` | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Исполняемый файл `ydbops` будет доступен в корневой папке репозитория. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
## Загрузка бинарного файла со страницы релизов | ||||||||||||||||||||||||
- Автоматизированная сборка с использованием утилиты make и docker. Выполните в папке репозитория команду: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
```bash | ||||||||||||||||||||||||
make build-in-docker | ||||||||||||||||||||||||
``` | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Исполняемый файл `ydbops` будет доступен в корневой папке `bin`. Автоматически собираются исполняемые файлы для Linux и MacOS (arm64, amd64). | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||
{% note warning %} | ||||||||||||||||||||||||
4. Установка исполняемого файла. Выполните следующую команду: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Этот вариант ещё не доступен. | ||||||||||||||||||||||||
```bash | ||||||||||||||||||||||||
make install INSTALL_DIR=путь_к_каталогу | ||||||||||||||||||||||||
``` | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Если вы собирали код вручную, используя самостоятельно компилятор Go, то следует указать путь к собранному файлу, например (`BUILD_DIR=.`, если исполняемый файл в папке репозитория): | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
```bash | ||||||||||||||||||||||||
make install INSTALL_DIR=путь_к_каталогу BUILD_DIR=. | ||||||||||||||||||||||||
``` | ||||||||||||||||||||||||
Comment on lines
+38
to
+46
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Параметры:
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||
## Загрузка бинарного файла со страницы релизов | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
{% endnote %} | ||||||||||||||||||||||||
В GitHub можно взять уже скомпилированные исполняемые файлы - [YDBOps Releases](https://github.com/ydb-platform/ydbops/releases). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.