#Установка Roxctl CLI

Это руководство содержит инструкции по установке, настройке и использованию командной строки roxctl (CLI) для Alauda Security Service.

#Обзор

• roxctl — это точка входа командной строки для управления Alauda Security Service и выполнения запросов к нему.
• Поддерживаемые платформы: Linux, macOS, Windows.
• После установки проверьте версию CLI, чтобы убедиться в корректности настройки.

#Установка

#Установка в Linux

Поддерживаемые архитектуры: amd64, arm64, ppc64le, s390x

Шаги:

1. Определите архитектуру:

   arch="$(uname -m | sed 's/x86_64//')"; arch="${arch:+-$arch}"

2. Скачайте бинарный файл из портала:

   

3. Сделайте его исполняемым:

   chmod +x roxctl

4. (Необязательно) Переместите его в каталог, входящий в PATH:

   echo $PATH
   # mv roxctl /usr/local/bin/ # if you want to move it to a directory in your `PATH`                          

#Установка в macOS

Поддерживаемые архитектуры: amd64, arm64

Шаги:

1. Определите архитектуру:

   arch="$(uname -m | sed 's/x86_64//')"; arch="${arch:+-$arch}"

2. Скачайте бинарный файл из портала:

   

3. Удалите расширенные атрибуты:

   xattr -c roxctl

4. Сделайте его исполняемым:

   chmod +x roxctl

5. (Необязательно) Переместите его в каталог, входящий в PATH:

   echo $PATH
   # mv roxctl /usr/local/bin/

#Установка в Windows

Поддерживаемая архитектура: amd64

Шаги:

1. Скачайте бинарный файл из портала:

   

2. (Необязательно) Добавьте каталог, содержащий roxctl.exe, в системный PATH.

3. Проверьте установку:

   roxctl.exe version

#Проверка

После установки проверьте версию roxctl:

roxctl version

#Настройка

#Настройка переменных среды

Перед использованием roxctl задайте переменные среды, необходимые для вашего рабочего процесса:

export ROX_ENDPOINT=<central_host:port>

Некоторые команды также принимают -e <central_host:port> напрямую.

Если для аутентификации вы используете API token:

export ROX_API_TOKEN=<api_token>

В качестве альтернативы можно использовать параметр --token-file:

roxctl central debug dump --token-file <token_file>

Примечание:

• Не используйте одновременно параметры --password и --token-file.
• Если одновременно заданы ROX_API_TOKEN и --token-file, CLI использует файл токена.
• Если одновременно заданы ROX_API_TOKEN и --password, CLI использует пароль.

#Способы аутентификации

Вы можете выполнить аутентификацию с помощью API token, временного административного пароля для тестирования или рабочего процесса roxctl central login.

#API Token

API token рекомендуется использовать для production-сценариев и автоматизации. Он предоставляет определенные права доступа и действителен до одного года.

Чтобы создать API token:

1. В портале Alauda Security Service перейдите в Platform Configuration > Integrations.
2. В разделе Authentication Tokens нажмите API Token.
3. Нажмите Generate token.
4. Введите имя и выберите роль с необходимым уровнем доступа.
5. Нажмите Generate и надежно сохраните token.

Чтобы использовать token:

export ROX_API_TOKEN=<api_token>

#Использование CLI roxctl

#Проверка аутентификации и сведений о пользователе

Чтобы просмотреть текущий статус аутентификации и профиль пользователя:

roxctl central whoami

Пример вывода:

UserID:        <redacted>
User name:     <redacted>
Roles:         Admin, Analyst, Continuous Integration, etc.
Access:        rw Access, rw Administration, rw Alert, ...

Проверьте вывод, чтобы убедиться, что аутентификация и разрешения настроены корректно.