Интерфейс командной строки Yandex Cloud (CLI)

1. Выполните команду:

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

   Скрипт установит CLI и добавит путь до исполняемого файла в переменную окружения PATH.

2. Перезапустите командную оболочку, чтобы перезагрузить переменные окружения.

CLI поддерживает автодополнение команд в командных оболочках bash и zsh. Чтобы включить автодополнение:

1. Установите менеджер пакетов Homebrew.

2. Установите пакет zsh-completion:

   Важно

   Если вы установили bash вместо zsh либо используете macOS 10.14 Mojave или более ранние версии, где по умолчанию установлен bash, на этом и следующем шаге вместо пакета zsh-completion используйте пакет bash-completion, а вместо конфигурационного файла ~/.zshrc — ~/.bash_profile.

   brew install zsh-completion
   

   Скрипт установки автоматически дополнит конфигурационный файл ~/.zshrc:

   # The next line updates PATH for Yandex Cloud CLI.
   if [ -f '/Users/<username>/yandex-cloud/path.bash.inc' ]; then source '/Users/<username>/yandex-cloud/path.bash.inc'; fi
   # The next line enables shell command completion for yc.
   if [ -f '/Users/<username>/yandex-cloud/completion.zsh.inc' ]; then source '/Users/<username>/yandex-cloud/completion.zsh.inc'; fi
   

3. После завершения установки добавьте в конфигурационный файл ~/.zshrc следующие строки. Расположите их выше строк, автоматически добавленных скриптом установки.

   if [ -f $(brew --prefix)/etc/zsh_completion ]; then
   . $(brew --prefix)/etc/zsh_completion
   fi
   

4. Перезапустите командную оболочку.

Для Windows CLI можно установить с помощью PowerShell или командной строки:

• Для установки с помощью PowerShell:

  1. Выполните команду:

     iex (New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1')
     

  2. Скрипт установки спросит, нужно ли добавить путь до yc в переменную PATH:

     Add yc installation dir to your PATH? [Y/n]
     

  3. Введите Y. После этого Yandex Cloud CLI можно пользоваться, командную оболочку перезапускать не нужно.

• Для установки с помощью командной строки:

  1. Выполните команду:

     @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://storage.yandexcloud.net/yandexcloud-yc/install.ps1'))" && SET "PATH=%PATH%;%USERPROFILE%\yandex-cloud\bin"
     

  2. Скрипт установки спросит, нужно ли добавить путь до yc в переменную PATH:

     Add yc installation dir to your PATH? [Y/n]
     

  3. Введите Y.

  4. Перезапустите командную оболочку, чтобы перезагрузить переменные окружения.

Чтобы аутентифицироваться с помощью SAML-совместимой федерации удостоверений:

1. Узнайте идентификатор федерации у вашего администратора.

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

   yc init \
     --federation-id=<идентификатор_федерации> \
     --region=kz
   

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

   Welcome! This command will take you through the configuration process.
   Pick desired action:
   [1] Re-initialize this profile 'default' with new settings
   [2] Create a new profile
   

4. CLI выведет сообщение о продолжении аутентификации в браузере. Для продолжения нажмите клавишу Enter.

   You are going to be authenticated via federation-id 'aje1f0hsgds3a********'.
   Your federation authentication web site will be opened.
   After your successful authentication, you will be redirected to 'https://kz.console.yandex.cloud'.
   
   Press 'enter' to continue...
   

   После успешной аутентификации в профиле сохранится IAM-токен. При каждой операции аутентификация будет происходить с помощью этого IAM-токена, пока не истечет время его жизни. После этого CLI снова выведет сообщение о необходимости пройти аутентификацию в браузере.

5. Вернитесь в интерфейс командной строки, чтобы завершить создание профиля.

6. Выберите одно из предложенных облаков, в которых у вас есть права доступа:

   Please select cloud to use:
    [1] cloud1 (id = aoe2bmdcvata********)
    [2] cloud2 (id = dcvatao4faoe********)
   Please enter your numeric choice: 2
   

   Если вам доступно только одно облако, оно будет выбрано автоматически.

7. Выберите каталог по умолчанию:

   Please choose a folder to use:
    [1] folder1 (id = cvatao4faoe2********)
    [2] folder2 (id = tao4faoe2cva********)
    [3] Create a new folder
   Please enter your numeric choice: 1
   

8. Чтобы выбрать зону доступности по умолчанию для сервиса Compute Cloud, введите Y. Чтобы пропустить настройку, введите n.

   Do you want to configure a default Yandex Compute Cloud availability zone? [Y/n] Y
   

   Если вы ввели Y, выберите зону доступности:

   Which zone do you want to use as a profile default?
    [1] kz1-a
    [2] Do not set default zone
   Please enter your numeric choice: 1
   

   Примечание

   В регионе Казахстан доступна только зона доступности kz1-a.

9. Проверьте настройки вашего профиля CLI:

   yc config list
   

   Результат:

   federation-id: aje1f0hs6oja********
   cloud-id: b1g159pa15cd********
   folder-id: b1g8o9jbt58********
   compute-default-zone: kz1-a
   

Чтобы аутентифицироваться от имени сервисного аккаунта:

1. Получите список сервисных аккаунтов, которые существуют в вашем облаке:

   yc iam service-account --folder-id <идентификатор_каталога> list
   

   Результат:

   +----------------------+------------+--------+---------------------+-----------------------+
   |          ID          |    NAME    | LABELS |     CREATED AT      | LAST AUTHENTICATED AT |
   +----------------------+------------+--------+---------------------+-----------------------+
   | ajeg2b2et02f******** | my-robot   |        | 2024-09-08 18:59:45 | 2025-08-21 06:40:00   |
   | ajegtlf2q28a******** | default-sa |        | 2023-06-27 16:18:18 | 2025-08-21 06:30:00   |
   +----------------------+------------+--------+---------------------+-----------------------+
   

2. Создайте авторизованный ключ для сервисного аккаунта и сохраните его в файл key.json:

   yc iam key create \
     --service-account-name default-sa \
     --output key.json \
     --folder-id <идентификатор_каталога>
   

   Результат:

   id: aje83v701b1u********
   service_account_id: aje3932acd0c********
   created_at: "2019-08-26T12:31:25Z"
   key_algorithm: RSA_2048
   

3. Добавьте авторизованный ключ сервисного аккаунта в профиль CLI.

   1. Создайте новый профиль CLI:

      yc config profile create sa-profile
      

   2. Добавьте авторизованный ключ:

      yc config set service-account-key key.json
      

4. Убедитесь, что параметры для сервисного аккаунта добавлены верно:

   yc config list
   

   Результат:

   service-account-key:
     id: aje83v701b1u********
     service_account_id: aje3932acd0c********
     created_at: "2019-08-26T12:31:25Z"
     key_algorithm: RSA_2048
     public_key: |
       -----BEGIN PUBLIC KEY-----
       MIIBIjANBg...
       -----END PUBLIC KEY-----
     private_key: |
       -----BEGIN PRIVATE KEY-----
       MIIEvwIBAD...
       -----END PRIVATE KEY-----
   

5. Настройте профиль для запуска команд.

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

   1. Укажите облако в профиле:

      yc config set cloud-id <идентификатор_облака>
      

      Или запускайте команды с параметром --cloud-id.

   2. Укажите каталог в профиле:

      yc config set folder-id <идентификатор_каталога>
      

      Или запускайте команды с параметром --folder-id.

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