Skip to content
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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
28 changes: 23 additions & 5 deletions ydb/docs/en/core/reference/ydbops/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>]
```

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parameters:

- `INSTALL_DIR`: The folder, to which the executable file will be installed. Default value: `~/ydb/bin`.
- `BUILD_DIR`: The folder that contains the generated binary file. Use this parameter if you created the binary file manually.
    For example, use `BUILD_DIR=.` if the executable file is in the root repository 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You must replace source folder if you have created binary file manually:
```bash
make install INSTALL_DIR=путь_к_каталогу BUILD_DIR=.
```


## Download the binary from releases page

{% endnote %}
You can download binary releases from GitHub - [YDBOps Releases](https://github.com/ydb-platform/ydbops/releases).
Copy link
Member

Choose a reason for hiding this comment

The 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.

29 changes: 24 additions & 5 deletions ydb/docs/ru/core/reference/ydbops/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```bash
make install INSTALL_DIR=путь_к_каталогу
```
Если вы собирали код вручную, используя самостоятельно компилятор Go, то следует указать путь к собранному файлу, например (`BUILD_DIR=.`, если исполняемый файл в папке репозитория):
```bash
make install INSTALL_DIR=путь_к_каталогу BUILD_DIR=.
```
```bash
make install [INSTALL_DIR=<путь_к_каталогу>] [BUILD_DIR=<путь_к_каталогу>]

Параметры:

  • INSTALL_DIR: Папка, в которую необходимо установить исполняемый файл. Значение по-умолчанию: ~/ydb/bin.
  • BUILD_DIR: Папка, которая содержит собранный файл. Используйте этот параметр, если вы собирали код вручную, используя самостоятельно компилятор Go.
    Например, BUILD_DIR=., если исполняемый файл находится в папке репозитория.


## Загрузка бинарного файла со страницы релизов

{% endnote %}
В GitHub можно взять уже скомпилированные исполняемые файлы - [YDBOps Releases](https://github.com/ydb-platform/ydbops/releases).