Поделиться через

Развертывание шаблонов ARM с помощью GitHub Actions

  • Статья

GitHub Actions — это набор функций в GitHub для автоматизации рабочих процессов разработки программного обеспечения в том же расположении, где вы храните код и совместно работаете над запросами на вытягивание и проблемами.

Чтобы автоматизировать развертывание шаблона Azure Resource Manager (шаблона ARM) в Azure, воспользуйтесь действием развертывания шаблона Azure Resource Manager.

Необходимые компоненты

Общие сведения о файле рабочего процесса

Рабочий процесс определяется файлом YAML (.yml) по пути /.github/workflows/ в вашем репозитории. Это определение содержит разные шаги и параметры рабочего процесса.

Этот файл содержит два раздела:

Раздел Задачи
Аутентификация 1. Создание учетных данных для развертывания.
Развертывание 1. Разверните шаблон Resource Manager.

Создание учетных данных для развертывания.

Чтобы использовать действие входа Azure с OIDC, необходимо настроить федеративные учетные данные удостоверения в приложении Microsoft Entra или управляемом удостоверении, назначаемом пользователем.

Вариант 1. Приложение Microsoft Entra

Вариант 2. Управляемое удостоверение, назначаемое пользователем

Настройка секретов GitHub

Необходимо указать идентификатор клиента приложения, идентификатор каталога (клиента) и идентификатор подписки для действия входа. Эти значения могут быть указаны непосредственно в рабочем процессе или храниться в секретах GitHub с указанием ссылок на них в рабочем процессе. Сохранение значений в виде секретов GitHub является более безопасным вариантом.

  1. В GitHub перейдите в репозиторий.

  2. Выберите "Секреты безопасности>" и "Действия переменных>".

    Снимок экрана: добавление секрета

  3. Нажмите Создать секрет репозитория.

    Примечание.

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

  4. Создайте секреты для AZURE_CLIENT_ID, AZURE_TENANT_ID и AZURE_SUBSCRIPTION_ID. Скопируйте эти значения из приложения Microsoft Entra или управляемого удостоверения, назначаемого пользователем, для секретов GitHub:

    Секрет GitHub Приложение Microsoft Entra или управляемое удостоверение, назначаемое пользователем
    AZURE_CLIENT_ID Client ID
    AZURE_SUBSCRIPTION_ID ИД подписки
    AZURE_TENANT_ID Идентификатор каталога (клиента)

    Примечание.

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

Добавление шаблона Resource Manager

Добавьте шаблон Resource Manager в репозиторий GitHub. Этот шаблон создает учетную запись хранения.

https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json

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

Создание рабочего процесса

Файл рабочего процесса должен храниться в папке .github/workflows в корне репозитория. Расширение файла рабочего процесса может быть либо .yml, либо .yaml.

  1. В репозитории GitHub выберите Действия в верхнем меню.
  2. Выберите Новый рабочий процесс.
  3. Выберите настроить рабочий процесс вручную.
  4. Переименуйте файл рабочего процесса, если вы предпочитаете другое имя, отличное от main.yml. Например: deployStorageAccount.yml.
  5. Замените содержимое YML-файла приведенным ниже:
  on: [push]
  name: Azure ARM
  jobs:
    build-and-deploy:
      runs-on: ubuntu-latest
      steps:

        # Checkout code
      - uses: actions/checkout@main

        # Log into Azure
      - uses: azure/login@v1
        with:
          creds: ${{ secrets.AZURE_CREDENTIALS }}

        # Deploy ARM template
      - name: Run ARM deploy
        uses: azure/arm-deploy@v1
        with:
          subscriptionId: ${{ secrets.AZURE_SUBSCRIPTION }}
          resourceGroupName: ${{ secrets.AZURE_RG }}
          template: ./azuredeploy.json
          parameters: storageAccountType=Standard_LRS

        # output containerName variable from template
      - run: echo ${{ steps.deploy.outputs.containerName }}

Примечание.

Вместо этого можно указать файл параметров формата JSON в действии развертывания ARM (пример: .azuredeploy.parameters.json).

Первый раздел файла рабочего процесса включает в себя следующие элементы.

  • name: имя рабочего процесса.
  • в: имя событий GitHub, которые инициируют рабочий процесс. Рабочий процесс активируется при наличии события push-отправки в главной ветви, которая изменяет по крайней мере один из указанных двух файлов. Два файла — это файл рабочего процесса и файл шаблона.
  1. Выберите Начать фиксацию.
  2. Выберите Зафиксировать непосредственно в главной ветви.
  3. Выберите Зафиксировать новый файл (или Зафиксировать изменения).

Так как рабочий процесс настроен на активацию файлом рабочего процесса или обновлением файла шаблона, рабочий процесс запускается сразу после фиксации изменений.

Проверка состояния рабочего процесса

  1. Перейдите на вкладку "Действия ". Отображается рабочий процесс создания deployStorageAccount.yml . Выполнение рабочего процесса занимает 1–2 минуты.
  2. Выберите рабочий процесс, чтобы открыть его.
  3. Выберите Выполнить развертывание ARM в меню, чтобы проверить развертывание.

Очистка ресурсов

Когда вы закончите работу с группой ресурсов и репозиторием, очистите развернутые ресурсы, удалив группу ресурсов и репозиторий GitHub.

Следующие шаги

Создание первого шаблона ARM

Модуль Learn. Автоматизация развертывания шаблонов ARM с помощью GitHub Actions