CI/CD パイプラインを実装する

完了済み

ここまでは、プロセス内のすべてのステップが手動でした。 プロジェクトをビルドし、SqlPackage を実行し、配置レポートを確認します。 CI/CD パイプラインは、毎回同じ順序で同じ手順を実行して、すべてのコミットで自動的に発生するシーケンスに変換します。 忘れられたフラグもなく、接続文字列に入力ミスもなく、「私のマシンでは動いた」という言い訳は通用しません。

パイプライン構造を設計する

ほとんどのデータベース パイプラインは、次の 2 段階のパターンに従います。

  1. ビルド: SQL データベース プロジェクトをコンパイルし、 .dacpac 成果物を生成します。
  2. デプロイ: その .dacpac をターゲット データベースに発行し、環境 (開発、ステージング、運用) を移動します。

1 回ビルドし、同じ成果物をあらゆる場所にデプロイすると、"開発で機能し、prod で中断" という問題が解消されます。 ステージングで検証に合格した .dacpac は、運用環境にデプロイされるのと同じファイルです。

GitHub Actions を使用して CI/CD パイプラインを実装する

GitHub Actions ワークフローは .github/workflows/ で稼働し、パイプラインを YAML として定義します。 azure/sql-action アクションは、Azure SQL Database への.dacpacデプロイを処理します。

mainへのすべてのプッシュに基づいて構築され、運用環境にデプロイされるワークフローを次に示します。

# .github/workflows/sql-deploy.yml
name: Build and Deploy SQL Project
on:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Build SQL project
      run: dotnet build ./Database.sqlproj -o ./output

    - name: Upload dacpac artifact
      uses: actions/upload-artifact@v4
      with:
        name: dacpac
        path: ./output/Database.dacpac

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment: production
    steps:
    - name: Download dacpac artifact
      uses: actions/download-artifact@v4
      with:
        name: dacpac

    - name: Install SqlPackage
      run: dotnet tool install -g microsoft.sqlpackage

    - 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/sql-action@v2.3
      with:
        connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
        path: './Database.dacpac'
        action: 'publish'

📝 azure/sql-actionでは、.dacpac、.sqlproj、および.sqlスクリプトがサポートされます。 SQL 認証、Microsoft Entra ID、サービス プリンシパル認証で機能します。

Azure SQL Database でファイアウォール規則が有効になっている場合は、GitHub Actions ランナーの IP にアクセスする必要があります。 azure/loginとazure/sql-actionをペアにすると、アクションによって、デプロイ時にランナーの IP の一時的なファイアウォール規則が追加され、後で削除されます。

Azure DevOps を使用して CI/CD パイプラインを実装する

Azure DevOps には、SqlAzureDacpacDeploymentデプロイのための.dacpac タスクが用意されています。 同等のパイプラインを次に示します。

# azure-pipelines.yml
trigger:
  - main

pool:
  vmImage: 'windows-latest'

steps:
- task: DotNetCoreCLI@2
  inputs:
    command: 'build'
    projects: './Database.sqlproj'
    arguments: '-o $(Build.ArtifactStagingDirectory)'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)/Database.dacpac'
    ArtifactName: 'dacpac'

- task: SqlAzureDacpacDeployment@1
  inputs:
    azureSubscription: 'your-service-connection'
    AuthenticationType: 'server'
    ServerName: 'your-server.database.windows.net'
    DatabaseName: 'your-database'
    SqlUsername: '$(SqlUser)'
    SqlPassword: '$(SqlPassword)'
    deployType: 'DacpacTask'
    DeploymentAction: 'Publish'
    DacpacFile: '$(Build.ArtifactStagingDirectory)/Database.dacpac'

Linux エージェントまたはプロセスをより詳細に制御する場合は、SqlPackage を直接インストールして使用します。

steps:
- script: dotnet tool install --global microsoft.sqlpackage
  displayName: 'Install SqlPackage'

- script: |
    sqlpackage /Action:Publish \
      /SourceFile:$(Build.ArtifactStagingDirectory)/Database.dacpac \
      /TargetConnectionString:"$(ConnectionString)"
  displayName: 'Deploy database'

GitHub Actions と Azure DevOps のどちらを使用する場合でも、どちらのパイプラインもデータベースに接続するための資格情報が必要です。 次の手順では、これらの資格情報が YAML ファイルから除外されるようにします。

YAML ファイルにハードコーディングされた接続文字列は、侵害につながります。 GitHub Actions と Azure DevOps はどちらも、ソース管理でシークレットを公開することなく、実行時にシークレットを格納および挿入するメカニズムを提供します。

GitHub リポジトリと環境シークレット

機密性の高い値 をリポジトリ シークレット または 環境シークレットとして格納します。 github.com の GitHub リポジトリで、次の手順を実行します。

  1. 設定>Secrets と変数>アクション を選択します。
  2. [ 新しいリポジトリ シークレット ] を選択します。
  3. 名前 ( AZURE_SQL_CONNECTION_STRINGなど) と値を追加します。

${{ secrets.SECRET_NAME }}を使用してワークフロー内のシークレットを参照します。 特定のデプロイ環境にスコープされた環境シークレットにより、プロダクション環境の認証情報はプロダクションを対象とするジョブだけがアクセス可能です。

サービス プリンシパルと OpenID Connect 認証

さらに、パスワードを完全にスキップすることをお勧めします。 を使用する azure/login は、クライアント シークレットがどこにも格納されていないフェデレーション資格情報を使用して認証します。 次の 3 つの値が必要です。

  • AZURE_CLIENT_ID: サービス プリンシパルのアプリケーション (クライアント) ID。
  • AZURE_TENANT_ID: Microsoft Entra ID テナント ID。
  • AZURE_SUBSCRIPTION_ID:お使いの Azure サブスクリプション ID。

サービス プリンシパルは連合資格情報を使用して認証されるため、ローテーションまたは漏洩するパスワードはありません。

Azure Key Vault の統合

シークレットを一元管理するには、接続文字列と資格情報を Azure Key Vault に格納し、デプロイ時にパイプラインでプルさせます。 Azure DevOps では、 Azure Key Vault タスクはシークレットをパイプライン変数にフェッチします。 GitHub Actions で、 azure/login の後に Azure CLI コマンドを使用してコンテナーから読み取りを行います。

Important

データベース資格情報を定期的にローテーションします。 Azure Key Vault は Azure Functions と統合してシークレットのローテーションを自動化し、資格情報の侵害のリスクを軽減できます。

デプロイ パイプラインコントロールを実装する

レビュー 手順なしですべてのプッシュで運用環境にデプロイするパイプラインは、データベースの変更に対して危険です。 未確認の変更が運用環境に到達するのを防ぐコントロールが必要です。

環境保護ルール

GitHub と Azure DevOps の両方で、デプロイを制限する保護規則を使用した 環境 がサポートされています。

  • 必須のレビュー担当者: デプロイ ジョブを実行する前に、1 人以上のチーム メンバーが承認する必要があります。 GitHub で、 設定>Environments>Protection ルールでこの設定を構成します。
  • 待機タイマー: 承認と実行の間に遅延を追加し、チームに再考のウィンドウを提供します。
  • デプロイ ブランチ: 環境をターゲットにできるブランチを制限します。 たとえば、main は運用環境にのみデプロイされます。

ブランチ ポリシー

ブランチ ポリシーはメイン ブランチを保護し、防御の第一線として機能します。 Azure DevOps で、次の構成を行います。

  • プル リクエストのレビュー担当者の最小数。
  • ビルド検証。マージ前に PR チェックとして SQL プロジェクト ビルドを実行します。
  • コメントの解決。すべてのレビュー コメントに対処する必要があります。
  • レビュー担当者が自動的に含まれるため、特定のユーザーがデータベース ファイルに触れる PR に追加されます。

GitHub は、 ブランチ保護ルール または ルールセットを通じて同様の保護を提供します。

コード所有者

CODEOWNERS ファイル (GitHub) またはレビュー担当者ポリシー (Azure DevOps) が自動的に含まれると、適切なユーザーがデータベースの変更を確認できるようになります。 SQL ファイルは、データベース チームに表示されずにマージされません。

# .github/CODEOWNERS
/Database/ @db-team
*.sql @db-team @dba-lead

この規則では、 db-team のメンバーが、SQL ファイルまたはデータベース プロジェクト フォルダーを変更するプル要求を確認する必要があります。

ブランチコントロールのチェック

Azure DevOps では、サービス接続に関する ブランチ コントロール チェック によって、運用資格情報にアクセスできるパイプラインがロックダウンされます。 mainのコンテキストで実行されているパイプラインのみがアクセスを取得します。 誰かが機能ブランチのパイプラインを変更して運用環境をターゲットにした場合でも、サービス接続は要求を拒否します。

重要なポイント

azure/sql-action (GitHub Actions) または SqlAzureDacpacDeployment (Azure DevOps) を使用して、CI/CD パイプラインから.dacpacファイルをデプロイします。 接続文字列と資格情報をリポジトリ シークレット、環境シークレット、または Azure Key Vault に格納し、YAML ファイルにハードコーディングしないでください。 パスワードを格納せずに認証するには、フェデレーション資格情報で OpenID Connect (OIDC) を使用します。 環境保護ルール、必須のレビュー担当者、デプロイ ブランチの制限を設定して、運用環境のデプロイへのアクセスを制御します。 CODEOWNERSファイルを使用するか、自動的にレビュー担当者を含め、適切なユーザーがデータベースの変更を確認できるようにします。