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

В этом руководстве приведены инструкции по установке, настройке и использованию командного интерфейса roxctl для Alauda Container Security. CLI доступен для Linux, macOS, Windows, а также в виде контейнерного образа.

#Overview

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

#Installation

#Установка на 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/ # если хотите переместить в директорию из вашего `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

Шаги:

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

   

3. (Опционально) Добавьте директорию с roxctl.exe в системный PATH.

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

   roxctl.exe version

#Verification

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

roxctl version

#Configuration

#Установка переменных окружения

Перед использованием roxctl установите необходимые переменные окружения:

export ROX_ENDPOINT=<central_host:port>

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

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-токена, пароля администратора (только для тестирования) или через команду roxctl central login.

#API-токен

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

Для создания API-токена:

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

Для использования токена:

export ROX_API_TOKEN=<api_token>

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

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

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

roxctl central whoami

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

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

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