Использование Azure Pipelines для создания и развертывания веб-приложения Python в службе приложение Azure

• Подписка Azure. Если ее нет, создайте бесплатную учетную запись.
• Учетная запись GitHub. Если у вас ее нет, создайте подписку бесплатно.
• Организация Azure DevOps Services. Создайте ее бесплатно.

• Подписка Azure. Если ее нет, создайте бесплатную учетную запись.
• Учетная запись GitHub. Если у вас ее нет, создайте подписку бесплатно.
• Сервер Azure DevOps.
• Локальный агент. Если вам нужно создать локальный агент, см. раздел "Локальные агенты".

1. В браузере перейдите к dev.azure.com и войдите в систему.
2. Выберите свою организацию.
3. Создайте новый проект, выбрав новый проект или создав проект при создании первого проекта в организации.
4. Заполните поле Имя проекта.
5. Выберите видимость проекта.
6. Нажмите кнопку создания.

1. В браузере перейдите на сервер Azure DevOps Server.
2. Выберите коллекцию.
3. Создайте новый проект, выбрав новый проект или создав проект при создании первого проекта в коллекции.
4. Заполните поле Имя проекта.
5. Выберите видимость проекта.
6. Нажмите кнопку создания.

Создание субъекта-службы

Субъект-служба — это удостоверение, созданное для использования с приложениями, размещенными службами и автоматизированными инструментами для доступа к ресурсам Azure. Этот доступ ограничен ролями, назначенными субъекту-службе, что позволяет контролировать доступ к ресурсам и на каком уровне.

Чтобы создать субъект-службу, перейдите в cloud shell (bash) и выполните следующую команду. Замените <service-principal-name> именем субъекта-службы, <your-subscription-id> идентификатором подписки и <your-resource-group> группой ресурсов для веб-приложения.

az ad sp create-for-rbac --display-name <service-principal-name> --role contributor --scopes /subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>

Команда возвращает объект JSON, аналогичный следующему примеру:

{
  "clientId": "<client GUID>",
  "clientSecret": "<string-value>",
  "subscriptionId": "<subscription GUID>",
  "tenantId": "<tenant GUID>",
  ...
}

Запишите clientIdзначения , clientSecretsubscriptionIdи tenantId значения. Эти значения необходимы для создания подключения к службе в следующем разделе.

1. На странице проекта выберите параметры проекта.

   

2. Выберите подключения службы в разделе "Конвейеры" в меню.

3. Выберите Создать подключение к службе.

4. Выберите Azure Resource Manager и нажмите кнопку "Далее".

   

5. Выберите метод проверки подлинности и нажмите кнопку "Далее".

6. В диалоговом окне "Новое подключение службы Azure" введите сведения, относящиеся к выбранному методу проверки подлинности. Дополнительные сведения о методах проверки подлинности см. в статье "Подключение к Azure" с помощью подключения службы Azure Resource Manager.

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

   

   Поле	Description
   Уровень области	Выберите Подписка.
   Подписка	Имя подписки Azure.
   Группа ресурсов	Имя группы ресурсов, содержащей веб-приложение.
   Имя подключения службы	Описательное имя подключения.
   Предоставление разрешений доступа всем конвейерам	Выберите этот параметр, чтобы предоставить доступ ко всем конвейерам.

7. Выберите Сохранить.

Новое подключение отображается в списке подключений службы и готово к использованию в Azure Pipeline.

1. На странице проекта выберите параметры проекта.

   

2. Выберите подключения службы в разделе "Конвейеры" в меню.

3. Выберите Создать подключение к службе.

4. Выберите Azure Resource Manager и нажмите кнопку "Далее".

   

5. В новом подключении службы Azure выберите субъект-службу (вручную) и нажмите кнопку "Далее"

6. В следующем диалоговом окне укажите необходимые сведения.

   

   Поле	Description
   Среда	Выберите Azure Cloud.
   Уровень области	Выберите Подписка.
   Идентификатор подписки	Идентификатор подписки.
   Имя подписки	Имя подписки Azure.
   Идентификатор субъекта-службы	Значение appId объекта JSON, возвращаемого командой az ad sp create-for-rbac .
   Ключ субъекта-службы	Значение password объекта JSON, возвращаемого командой az ad sp create-for-rbac .
   Идентификатор клиента	Значение tenant объекта JSON, возвращаемого командой az ad sp create-for-rbac .

7. Нажмите кнопку "Проверить" , чтобы проверить подключение.

8. Введите имя подключения службы.

9. Убедитесь, что выбрано разрешение на доступ ко всем конвейерам .

10. Выберите " Проверить и сохранить".

Новое подключение отображается в списке подключений службы и готово к использованию Azure Pipelines из проекта.

Настройка локального агента

Если вы используете собственный локальный агент, необходимо настроить агент для запуска Python. Скачивание версий Python не поддерживается для локальных агентов. Необходимо предварительно установить версию Python. Используйте полный установщик, чтобы получить версию Python, совместимую с pip.

Чтобы избежать несовместимых проблем, следует сопоставить версию Python с версией среды выполнения в веб-приложении приложение Azure Services. Версия среды выполнения отображается в выходных данных az webapp up JSON команды.

Требуемая версия Python должна быть добавлена в кэш инструментов в локальном агенте, чтобы задача может использовать ее. Как правило, кэш инструментов находится в каталоге _work/_tool агента; Кроме того, путь можно переопределить с помощью переменной среды AGENT_TOOLSDIRECTORY. В каталоге средств создайте следующую структуру каталогов на основе версии Python:

$AGENT_TOOLSDIRECTORY/
    Python/
        {version number}/
            {platform}/
                {tool files}
            {platform}.complete

Номер версии должен соответствовать формату 1.2.3. Платформа должна быть либо x86, либо x64. Файлы инструментов должны быть распакованными файлами версии Python. Должен {platform}.complete быть 0-байтовый файл, который выглядит как x86.complete или x64.complete просто означает, что средство правильно установлено в кэше.

Например, если вы используете Python 3.11 на 64-разрядном компьютере Windows, структура каталогов будет выглядеть следующим образом:

$AGENT_TOOLSDIRECTORY/
    Python/
        3.11.4/
            x64/
                {python files}
            x64.complete

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

1. В меню навигации слева выберите "Конвейеры".

   

2. Выберите Создать конвейер.

   

3. В диалоговом окне " Где находится код " выберите GitHub. Возможно, вам будет предложено войти в GitHub.

   

4. На экране "Выбор репозитория" выберите вилку репозитория.

   

5. Возможно, вам будет предложено ввести пароль GitHub еще раз в качестве подтверждения.

6. Если расширение Azure Pipelines не установлено на сайте GitHub, GitHub предложит установить расширение Azure Pipelines .

   

   На этой странице прокрутите вниз до раздела доступа к репозиторию, выберите, следует ли установить расширение на все репозитории или только выбранные, а затем нажмите кнопку "Утвердить и установить".

   

7. В диалоговом окне "Настройка конвейера" выберите Python для веб-приложения Linux в Azure.

8. Выберите подписку Azure и нажмите кнопку "Продолжить".

9. Если вы используете имя пользователя и пароль для проверки подлинности, браузер откроется для входа в учетную запись Майкрософт.

10. Выберите имя веб-приложения в раскрывающемся списке и выберите " Проверить и настроить".

Azure Pipelines создает файл azure-pipelines.yml и отображает его в редакторе конвейеров YAML. Файл конвейера определяет конвейер CI/CD в виде ряда этапов, заданий и шагов, где каждый шаг содержит сведения о различных задачах и сценариях. Изучите работу конвейера. Убедитесь, что все входные данные по умолчанию подходят для кода.

1. В меню навигации выберите "Конвейеры".

   

2. Выберите Создать конвейер.

   

3. В диалоговом окне " Где находится код " выберите GitHub Enterprise Server. Возможно, вам будет предложено войти в GitHub.

   

4. На вкладке "Выбор репозитория " выберите вилку репозитория.

   

5. Возможно, вам будет предложено ввести пароль GitHub еще раз в качестве подтверждения.

6. Если расширение Azure Pipelines не установлено на сайте GitHub, GitHub предложит установить расширение Azure Pipelines .

   

   На этой странице прокрутите вниз до раздела доступа к репозиторию, выберите, следует ли установить расширение на все репозитории или только выбранные, а затем нажмите кнопку "Утвердить и установить".

   

7. В диалоговом окне "Настройка конвейера" выберите "Начальный конвейер".

8. Замените содержимое файла azure-pipelines.yml следующим кодом.

   trigger:
   - main
   
   variables:
     # Azure Resource Manager connection created during pipeline creation
     azureServiceConnectionId: '<your-service-connection-name>'
   
     # Web app name
     webAppName: '<your-web-app-name>'
   
     # Environment name
     environmentName: '<your-web-app-name>'
   
     # Project root folder. 
     projectRoot: $(System.DefaultWorkingDirectory)
   
     # Python version: 
     pythonVersion: '<your-python-version>'
   
   stages:
   - stage: Build
     displayName: Build stage
     jobs:
     - job: BuildJob
       pool:
         name: '<your-pool-name>'
         demands: python
       steps:
       - task: UsePythonVersion@0
         inputs:
           versionSpec: '$(pythonVersion)'
         displayName: 'Use Python $(pythonVersion)'
   
       - script: |
           python -m venv antenv
           source antenv/bin/activate
           python -m pip install --upgrade pip
           pip install -r requirements.txt
         workingDirectory: $(projectRoot)
         displayName: "Install requirements"
   
       - task: ArchiveFiles@2
         displayName: 'Archive files'
         inputs:
           rootFolderOrFile: '$(projectRoot)'
           includeRootFolder: false
           archiveType: zip
           archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
           replaceExistingArchive: true
   
       - task: PublishBuildArtifacts@1
         inputs:
           PathtoPublish: '$(Build.ArtifactStagingDirectory)'
           ArtifactName: 'drop'
           publishLocation: 'Container'
   
   - stage: Deploy
     displayName: 'Deploy Web App'
     dependsOn: Build
     condition: succeeded()
     jobs:
     - deployment: DeploymentJob
       pool:
         name: '<your-pool-name'
       environment: $(environmentName)
       strategy:
         runOnce:
           deploy:
             steps:
   
             - task: UsePythonVersion@0
               inputs:
                 versionSpec: '$(pythonVersion)'
               displayName: 'Use Python version'
   
             - task: AzureWebApp@1
               displayName: 'Deploy Azure Web App : <your-web-app-name>'
               inputs:
                 azureSubscription: $(azureServiceConnectionId)
                 appName: $(webAppName)
                 package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
                 startUpCommand: 'startup.txt'
   
   

9. Замените следующие заполнители собственными значениями:

   Заполнитель	Description
   <your-service-connection-name>	Имя созданного подключения службы.
   <your-web-app-name>	Имя веб-приложения службы приложение Azure.
   <your-pool-name>	Имя пула агентов, который вы хотите использовать.
   <your-python-version>	Версия Python, запущенная в агенте. Рекомендуется сопоставить эту версию с версией Python, работающей в веб-приложении. Версия веб-приложения отображается в выходных az webapp up данных JSON команды.

Ниже показан полный пример файла YAML конвейера:

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<GUID>'

  # Web app name
  webAppName: '<your-webapp-name>'

  # Agent VM image name
  vmImageName: 'ubuntu-latest'

  # Environment name
  environmentName: '<your-webapp-name>'

  # Project root folder. Point to the folder containing manage.py file.
  projectRoot: $(System.DefaultWorkingDirectory)

  pythonVersion: '3.11'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
    pool:
      vmImage: $(vmImageName)
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install setup
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - upload: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
      displayName: 'Upload package'
      artifact: drop

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : $(webAppName)'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip

В variables разделе содержатся следующие переменные:

variables:
# Azure Resource Manager connection created during pipeline creation
azureServiceConnectionId: '<GUID>'

# Web app name
webAppName: '<your-webapp-name>'

# Agent VM image name
vmImageName: 'ubuntu-latest'

# Environment name
environmentName: '<your-webapp-name>'

# Project root folder.
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to match the Python runtime version running on your web app.
pythonVersion: '3.11'

В variables разделе содержатся следующие переменные:

variables:
# Azure Resource Manager connection created during pipeline creation
azureServiceConnectionId: '<your-service-connection-name>'

# Web app name
webAppName: '<your-webapp-name>'

# Environment name
environmentName: '<your-webapp-name>'

# Project root folder. 
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to the version that is running on your agent and web app.
pythonVersion: '3.11'

Этап сборки содержит одно задание, которое выполняется в операционной системе, определенной в переменной vmImageName.

  - job: BuildJob
    pool:
      vmImage: $(vmImageName)

Этап сборки содержит одно задание, которое выполняется в агенте в пуле, определяемом параметром имени. Вы можете указать возможности агента с помощью ключевого demands слова. Например, указывает, demands: python что агент должен быть установлен на Python. Чтобы указать локальный агент по имени, можно использовать ключевое demands: Agent.Name -equals <agent-name> слово.

  - job: BuildJob
    pool:
      name: <your-pool-name>
      demands: python

  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)

  - deployment: DeploymentJob
    pool:
      name: <your-pool-name>
    environment: $(environmentName)

В steps конвейере используются следующие функции:

1. Используйте задачу UsePythonVersion, чтобы указать версию Python, используемую в агенте. Версия определена в переменной pythonVersion .

    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python version'
   

2. Разверните веб-приложение с помощью AzureWebApp@1. Эта задача развертывает артефакт drop конвейера в веб-приложении.

   - task: AzureWebApp@1
      displayName: 'Deploy Azure Web App : <your-web-app-name>'
      inputs:
         azureSubscription: $(azureServiceConnectionId)
         appName: $(webAppName)
         package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
   

   Параметр	Description
   azureSubscription	Идентификатор или имя подключения службы Azure Resource Manager.
   appName	имя веб-приложения.
   package	Расположение развернутого файла .zip .

   Кроме того, так как репозиторий python-vscode-flask-tutorial содержит ту же команду запуска в файле с именем startup.txt, вы можете указать этот файл, добавив параметр: startUpCommand: 'startup.txt'

В steps конвейере используются следующие функции:

1. Используйте задачу UsePythonVersion, чтобы указать версию Python, используемую в агенте. Версия определена в переменной pythonVersion .

    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python version'
   

2. Разверните веб-приложение с помощью AzureWebApp@1. Эта задача развертывает артефакт drop конвейера в веб-приложении.

   - task: AzureWebApp@1
      displayName: 'Deploy Azure Web App : <your-web-app-name>'
      inputs:
         azureSubscription: $(azureServiceConnectionId)
         appName: $(webAppName)
         package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
   

   Параметр	Description
   azureSubscription	Идентификатор или имя подключения службы Azure Resource Manager.
   appName	имя веб-приложения.
   package	Расположение развернутого файла .zip .

   Кроме того, так как репозиторий python-vscode-flask-tutorial содержит ту же команду запуска в файле с именем startup.txt, вы можете указать этот файл, добавив параметр: startUpCommand: 'startup.txt'

     - task: AzureWebApp@1
        displayName: 'Deploy Azure Web App : $(webAppName)'
        inputs:
          azureSubscription: $(azureServiceConnectionId)
          appName: $(webAppName)
          package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
          startUpCommand: 'startup.txt'
   

   Параметр	Description
   azureSubscription	Идентификатор или имя подключения службы Azure Resource Manager.
   appName	имя веб-приложения.
   package	Расположение развернутого файла .zip .
   startUpCommand	Команда, выполняемая после развертывания приложения. В примере приложения используется startup.txt.