Ctrl+K
Ctrl+K
Ctrl+K

Настройка интерфейса командной строки (YC CLI)

Настройка интерфейса командной строки (YC CLI)#

Платформа Yandex Cloud предоставляет возможность управления облачными ресурсами с помощью YC CLI. Основу клиентской части составляет утилита yc. Все дальнейшие инструкции по использованию Yandex Cloud совместно с Astra Automation предполагают использование этого инструмента для работы с облаком.

Установка и настройка интерфейса командной строки YC CLI#

Детальная информация о начале работы в командной строке приведена в документации Yandex Cloud.

Чтобы начать пользоваться YC CLI, выполните следующие действия:

  1. Установите клиентскую часть:

    curl -sSL https://storage.yandexcloud.net/yandexcloud-yc/install.sh | bash

    Эта команда выполняет следующие действия:

    • создает каталог yandex-cloud/ в домашнем каталоге пользователя;

    • дополняет файл инициализации .bashrc вызовом скриптов настройки клиента – ~/yandex-cloud/path.bash.inc и ~/yandex-cloud/completion.bash.inc.

  2. Перезапустите терминал или выполните команду:

    source ~/.bashrc

  3. Создайте профиль пользователя для работы с облачным каталогом.

    Примечание

    Профиль определяет набор параметров окружения, в котором пользователь работает в каждый конкретный момент.

    При использовании федеративного метода идентификации на базе SAML выполните команду:

    yc init --federation-id=<federation_ID>

    где <federation_ID> – идентификатор федерации для вашей организации или подразделения.

    Необходимо выбрать – использовать существующий каталог или создать новый.

  4. (Опционально) Настройте зону доступности по умолчанию.

  5. Проверьте полученные настройки с помощью команды:

    yc config list

    В терминал выводятся идентификаторы федерации, облака и каталога, используемых в текущий момент.

  6. Проверьте список профилей:

    yc config profile list

    В терминал выводится список существующих профилей YC CLI. Активный профиль будет отмечен меткой ACTIVE.

Управление профилями#

Дополнительные профили YC CLI могут понадобиться, например:

  • для работы с разными облаками и каталогами Yandex Cloud;

  • для управления ресурсами одного и того же каталога от имени разных пользователей, в том числе сервисных аккаунтов.

Чтобы создать дополнительный профиль YC CLI, выполните следующие действия:

  1. Получите идентификаторы нужного облака и облачного каталога любым удобным способом. Чтобы получить сведения об облаке и каталоге, к которым привязан активный профиль YC CLI, выполните команду:

    yc config profile get <profile>

    В терминал выводится следующая информация о профиле:

    • cloud-id – идентификатор облака;

    • folder-id – идентификатор облачного каталога;

    • compute-default-zone – зона доступности по умолчанию (если была указана при настройке профиля).

  2. Выполните команду создания нового профиля:

    yc config profile create <profile_name>

    Профиль автоматически активируется после создания.

  3. Привяжите профиль к нужному облаку и каталогу:

    yc config set cloud-id <cloud_ID>
yc config set folder-id <folder_ID>

    где <cloud_ID> и <folder_ID> – полученные ранее идентификаторы облака и облачного каталога соответственно.

    Совет

    Полный перечень команд YC CLI приведен в документации Yandex Cloud.

Примеры использования#

Получение списка доступных профилей:

yc config profile list

Переключение на другой профиль:

yc config profile activate <profile>

Назначение зоны доступности по умолчанию:

yc config set compute-default-zone <zone>

где <zone> – название зоны доступности, например:

yc config set compute-default-zone ru-central1-a

Подробности о зонах доступности см. в документации Yandex Cloud.

Содержание