1. Главная
  2. Хаб
  3. Сценарии
  4. Ansible и CI по SSH: отдельный ключ, доступ «выбранные» и инвентарь из API

Сценарий 06

Ansible и CI по SSH: отдельный ключ, доступ «выбранные» и инвентарь из API

Настраиваем машины проекта плейбуком Ansible из GitLab CI. У пайплайна свой SSH-ключ, который пускают только на нужные машины, а список хостов собирается из API h3llo.cloud при каждом запуске, поэтому новую машину не нужно вписывать в инвентарь руками.

35 минСредний5 шагов Серверы, Безопасность обновлено

Содержание
  1. 01Сгенерируйте ключ для CI и добавьте его в профиль ответственного
  2. 02Выдайте ключу CI доступ «выбранные» на нужные машины
  3. 03Соберите инвентарь из API
  4. 04Положите секреты в переменные GitLab CI
  5. 05Запустите плейбук из пайплайна
  6. Проверка результата
  7. Как удалить ресурсы
  8. Типичные ошибки

Что получится

Джоба GitLab CI, которая получает список машин проекта через h3, строит инвентарь Ansible и выполняет плейбук по SSH ключом CI. Ключ CI записан только на те машины, где ему выдан доступ, и отзывается одной кнопкой.

Что понадобится

  • Одна или несколько машин на Linux с публичным IP и включённым «Управление ключами через агента» — например, из сценария «Сайт на облачном сервере».
  • Проект в GitLab с CI/CD и правом на переменные.
  • Ansible 2.14+ и jq локально — чтобы проверить плейбук до CI.
  1. Шаг 1. Сгенерируйте ключ для CI и добавьте его в профиль ответственного

    SSH-ключи на платформе принадлежат людям. Ключ CI добавляет в свой профиль ответственный за автоматизацию — тогда в журнале доступа видно, чей это ключ, а при уходе человека из проекта ключ теряет доступ вместе с ним.

    Консоль

    1. Значок ключа «API и SSH ключи» внизу левой панели → Добавить ключ → Добавить SSH-ключ.
    2. Имя ключа gitlab-ci, в поле Ключ — строка из ci_ed25519.pub. Нажмите Добавить.

    CLI

    Терминал
    h3 config set user_id <ваш ID пользователя>
    h3 ssh create --name gitlab-ci --key-file ./ci_ed25519.pub
    На вашем компьютере
    ssh-keygen -t ed25519 -N '' -C 'gitlab-ci' -f ./ci_ed25519
    cat ./ci_ed25519.pub

    Проверка

    Ключ gitlab-ci появился на вкладке SSH-ключи. Приватный файл ci_ed25519 пока лежит у вас — после следующего шага его место только в переменной CI.

  2. Шаг 2. Выдайте ключу CI доступ «выбранные» на нужные машины

    Режим «выбранные ключи» записывает в машину только ключ gitlab-ci, а не все ваши ключи. Выдавайте доступ только к тем машинам, которые настраивает пайплайн.

    Консоль

    1. Инстансы → машина → секция «Доступ по SSH». Если вы уже в списке «Участники с доступом» — нажмите Изменить у своей строки, иначе Выдать доступ и выберите себя в поле Участники проекта.
    2. Выключите «Синхронизировать ключи пользователя» и в поле Ключи отметьте gitlab-ci (и, если нужно, свой рабочий ключ). Нажмите Сохранить.

    CLI

    Терминал
    # для каждой машины, которую настраивает CI
    h3 vm ssh-access grant <vm-id> <ваш ID> --mode selected --key-ids <ID ключа gitlab-ci>,<ID рабочего ключа>

    Проверка

    Статус «Применено» (ключи доезжают примерно за 2 минуты). С вашего компьютера вход ключом CI работает:

    Терминал
    ssh -i ./ci_ed25519 -o IdentitiesOnly=yes user@<IP машины> hostname

    Если не получилось

    • Один грант на человека: если в списке ключей оставить только gitlab-ci, ваш рабочий ключ с машины уйдёт. Отметьте оба.
  3. Шаг 3. Соберите инвентарь из API

    h3 api подписывает запрос API-ключом и возвращает список машин проекта: имя, статус, публичный адрес endpoint и внутренний net_config.internal_ip. Из него jq собирает инвентарь в формате INI. Группы Ansible берём из префикса имени машины: web-1 попадёт в группу web.

    inventory.sh
    #!/usr/bin/env bash
    # Инвентарь Ansible из API h3llo.cloud: работающие машины с публичным IP.
    set -euo pipefail
    h3 api GET /api/vms/v1 --with-project | jq -r '
      [ .[] | select(.status == "RUNNING" and (.endpoint // "") != "") ]
      | group_by(.name | sub("-[0-9]+$"; ""))
      | .[] | "[" + (.[0].name | sub("-[0-9]+$"; "")) + "]",
              (.[] | "\(.name) ansible_host=\(.endpoint) ansible_user=user"),
              ""'
    Проверка локально
    export H3_KEY_ID=<ID API-ключа> H3_SECRET_KEY=<секрет> H3_PROJECT_ID=<ID проекта>
    chmod +x inventory.sh && ./inventory.sh > hosts.ini && cat hosts.ini
    ANSIBLE_HOST_KEY_CHECKING=False ansible all -i hosts.ini --private-key ./ci_ed25519 -m ping

    Проверка

    hosts.ini содержит группы по префиксам имён, ansible … -m ping отвечает "ping": "pong" для каждой машины, где ключу CI выдан доступ. Машины без доступа ответят Permission denied (publickey) — так и должно быть.

    Если не получилось

    • Пустой вывод — у машин нет публичного IP или они остановлены. Для машин в частной сети за бастионом используйте net_config.internal_ip и добавьте в инвентарь ansible_ssh_common_args='-o ProxyJump=user@<IP бастиона>'.
    • 401 от API — не заданы H3_KEY_ID/H3_SECRET_KEY, ключ выключен или истёк.
  4. Шаг 4. Положите секреты в переменные GitLab CI

    Для CI создайте отдельный API-ключ: тогда его можно отозвать, не трогая ключи людей. Ключ ограничьте одним проектом и сроком.

    Консоль

    1. API-ключи → Добавить ключ → Добавить API-ключ: Имя ключа gitlab-ci, Проекты — этот проект, Срок действия — «90 дней». Нажмите Создать API ключ и скопируйте секрет.
    2. В GitLab: Settings → CI/CD → Variables. Добавьте H3_KEY_ID, H3_SECRET_KEY (Masked, Protected), H3_PROJECT_ID и переменную типа File SSH_PRIVATE_KEY с содержимым ci_ed25519.
    3. Удалите локальную копию приватного ключа: shred -u ./ci_ed25519.
  5. Шаг 5. Запустите плейбук из пайплайна

    .gitlab-ci.yml
    configure:
      image: python:3.12-slim
      rules:
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
      before_script:
        - apt-get update && apt-get install -y --no-install-recommends curl jq openssh-client ca-certificates
        - pip install --no-cache-dir ansible-core
        - curl -fsSL https://h3llo.cloud/cli/install.sh | sh
        - chmod 600 "$SSH_PRIVATE_KEY"
      script:
        - ./inventory.sh > hosts.ini
        - cat hosts.ini
        - ansible-playbook -i hosts.ini --private-key "$SSH_PRIVATE_KEY" site.yml
      variables:
        ANSIBLE_HOST_KEY_CHECKING: "False"
    site.yml
    - hosts: all
      become: true
      tasks:
        - name: Пакеты обновлены
          ansible.builtin.apt:
            update_cache: true
            upgrade: safe

    Проверка

    Пайплайн на ветке по умолчанию проходит, в логе — hosts.ini и PLAY RECAP с failed=0. В карточке машины, «Журнал доступа», видно, когда выдавался доступ ключу CI.

    Если не получилось

    • h3: command not found — установщик положил бинарник не в PATH образа; добавьте export PATH=$HOME/.local/bin:$PATH в before_script, если он ставит в домашний каталог.
    • ANSIBLE_HOST_KEY_CHECKING: False удобно для начала. Для прода соберите known_hosts заранее (ssh-keyscan по адресам из инвентаря) и храните его в репозитории.

Проверка результата

Создайте новую машину с префиксом web- и выдайте ключу CI доступ — при следующем запуске она сама попадёт в группу web и получит плейбук, без правок инвентаря.

Терминал
./inventory.sh | grep -A5 '^\[web\]'

Как удалить ресурсы

  1. В карточке каждой машины → «Доступ по SSH» → Изменить у своей строки → снимите ключ gitlab-ci → Сохранить. Или удалите ключ целиком: SSH-ключи → gitlab-ci → Удалить — «ключ удалён из профиля» появится в журнале доступа, а из машин он уйдёт сам.
  2. API-ключи → gitlab-ci → меню «…» → Удалить → Подтвердить.
  3. В GitLab удалите переменные H3_KEY_ID, H3_SECRET_KEY, SSH_PRIVATE_KEY.

Типичные ошибки

Почему не положить в CI свой личный ключ?

Его придётся менять во всех пайплайнах, когда вы смените ноутбук, а отзыв ключа CI отрежет и вас. Отдельный ключ `gitlab-ci` отзывается независимо, и в журнале видно, что заходил именно он.

Можно ли выдать ключу CI доступ ко всем машинам проекта сразу?

Доступ выдаётся по машине: в консоли, `h3 vm ssh-access grant` в цикле по `h3 vm list -o json | jq -r '.[].id'` или ресурсом `h3_vm_ssh_access` в Terraform.

Плейбук сам добавил ключ в authorized_keys, а он пропал

При включённом управлении ключами агент перезаписывает `/home/user/.ssh/authorized_keys`. Ключи вне платформы кладите в `~/.ssh/authorized_keys2`.

Связанные продукты и материалы

Попробовать в h3llo.cloud

Новым пользователям — 4 000 ₽ на 30 дней на любые сервисы: бонуса хватит, чтобы попробовать этот сценарий целиком. Бонус начисляется после подтверждения телефона и привязки карты.