你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

快速入门:使用 GitHub Actions 连接到 Azure Database for PostgreSQL 灵活服务器

适用于: Azure Database for PostgreSQL 灵活服务器

开始使用 GitHub Actions,通过工作流将数据库更新部署到Azure Database for PostgreSQL 灵活服务器

先决条件

需要:

工作流文件概述

GitHub Actions 工作流是由存储库中 /.github/workflows/ 路径中的 YAML (.yml) 文件定义的。 此定义包含组成工作流的各种步骤和参数。

此文件包含两个部分:

部分 任务
身份验证 1. 生成部署凭据。
部署 1.部署数据库。

生成部署凭据

若要对 OIDC 使用 Azure 登录操作,需要在 Microsoft Entra 应用或用户分配的托管身份上配置联合身份凭证。

选项 1:Microsoft Entra 应用程序

选项 2:用户分配的托管标识

复制 Azure Database for PostgreSQL 灵活服务器连接字符串

在 Azure 门户中,转到 Azure Database for PostgreSQL 灵活服务器实例,然后从资源菜单的“设置”下选择“连接”。 在该页面中,使用“数据库名称”组合框选择要连接到的数据库的名称。 展开“通过应用程序进行连接”部分,复制 ADO.NET 连接字符串,并将占位符值{your_password}替换为你的实际密码。 连接字符串与此类似。

Server={servername.postgres.database.azure.com};Database={your_database};Port=5432;User Id={adminusername};Password={your_password};Ssl Mode=Require;

使用连接字符串作为 GitHub 密钥。

配置 GitHub 机密

需要在登录操作中提供应用程序的 客户端 ID目录(租户)ID订阅 ID。 这些值可直接在工作流中提供,或可存储在 GitHub 机密中并在工作流中引用。 将这些值保存为 GitHub 机密是更安全的选择。

  1. GitHub 中,转到存储库。

  2. 选择“安全性”>“机密和变量”>“操作”。

    添加机密的屏幕截图

  3. 选择“新建存储库机密”。

    注释

    若要增强公共存储库中的工作流安全性,请使用 环境机密 而不是存储库机密。 如果环境需要审批,在所需审阅者之一批准之前,作业无法访问环境机密。

  4. AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_SUBSCRIPTION_ID 创建机密。 请从 Microsoft Entra 应用程序或用户分配的托管标识中复制这些值,以用于您的 GitHub 机密。

    GitHub 机密 Microsoft Entra 应用程序或用户分配的托管标识
    AZURE_CLIENT_ID 客户 ID
    AZURE_SUBSCRIPTION_ID 订阅 ID
    AZURE_TENANT_ID 目录(租户)ID

    注释

    出于安全原因,我们建议使用 GitHub 机密,而不是将值直接传递到工作流。

添加工作流

  1. 转到 GitHub 存储库的“操作”。

  2. 选择“自己设置工作流”。

  3. 删除工作流文件 on: 部分后面的所有内容。 例如,剩下的工作流可能如下所示。

    name: CI
    
    on:
    push:
        branches: [ main ]
    pull_request:
        branches: [ main ]
    
  4. 将工作流重命名为 PostgreSQL for GitHub Actions,并添加签出和登录操作。 这些操作会签出你的站点代码,并使用之前创建的 GitHub 机密向 Azure 进行身份验证。

    name: PostgreSQL for GitHub Actions
    
    on:
    push:
        branches: [ main ]
    pull_request:
        branches: [ main ]
    
    jobs:
    build:
        runs-on: ubuntu-latest
        steps:
        - uses: actions/checkout@v1
        - uses: azure/login@v2
        with:
            client-id: ${{ secrets.AZURE_CLIENT_ID }}
            tenant-id: ${{ secrets.AZURE_TENANT_ID }}
            subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
    
  5. 使用 Azure PostgreSQL 部署操作连接到 Azure Database for PostgreSQL 灵活服务器实例。 将 POSTGRESQL_SERVER_NAME 替换为服务器的名称。 您的仓库根目录应该有一个名为 data.sql 的 Azure Database for PostgreSQL 弹性服务器数据文件。

     - uses: azure/postgresql@v1
       with:
        connection-string: ${{ secrets.AZURE_POSTGRESQL_CONNECTION_STRING }}
        server-name: POSTGRESQL_SERVER_NAME
        plsql-file: './data.sql'
    
  6. 通过添加注销 Azure 的操作来完成工作流。 下面是已完成的工作流。 文件会显示在存储库的 .github/workflows 文件夹中。

    name: PostgreSQL for GitHub Actions
    
    on:
    push:
        branches: [ main ]
    pull_request:
        branches: [ main ]
    
    
    jobs:
    build:
        runs-on: ubuntu-latest
        steps:
        - uses: actions/checkout@v1
        - uses: azure/login@v2
        with:
            client-id: ${{ secrets.AZURE_CLIENT_ID }}
            tenant-id: ${{ secrets.AZURE_TENANT_ID }}
            subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
    
    - uses: azure/postgresql@v1
      with:
        server-name: POSTGRESQL_SERVER_NAME
        connection-string: ${{ secrets.AZURE_POSTGRESQL_CONNECTION_STRING }}
        plsql-file: './data.sql'
    
        # Azure logout
    - name: logout
      run: |
         az logout
    

查看部署

  1. 转到 GitHub 存储库的“操作”。

  2. 打开第一个结果,查看工作流运行的详细日志。

    GitHub 操作运行的日志。

清理资源

如果不再需要 Azure Database for PostgreSQL 灵活服务器数据库和存储库,请删除资源组和 GitHub 存储库,来清理所部署的资源。