チュートリアル: GitHub Actions を使って ASP.NET Core アプリと Database を Azure Container Apps にデプロイする

[アーティクル]
11/03/2023

このチュートリアルでは、Visual Studio と GitHub Actions を使って、ASP.NET Core アプリと SQL Database を Azure Container Apps にデプロイする方法について説明します。また、GitHub Actions で Entity Framework の移行とデータベース更新を管理する方法についても説明しますが、その概念は他の CI/CD ツールや環境にも適用できます。

前提条件

ASP.NET と Web 開発および Azure 開発ワークロードと共にインストールされた Visual Studio 2022 が必要です。

Visual Studio を既にインストールしている場合は、次のように実行します。

[ヘルプ]>[更新プログラムの確認] の順に選択して、Visual Studio に最新の更新プログラムをインストールします。
[ツール]>[ツールと機能を取得] の順に選択して、ASP.NET と Web 開発および Azure 開発ワークロードがインストールされていることを確認します。

サンプルアプリをローカルで設定する

ToDo サンプルアプリを使用してこのチュートリアルの手順に従ってください。次のコマンドを使用して、GitHub からのアプリを複製します。

git clone https://github.com/Azure-Samples/msdocs-app-service-sqldb-dotnetcore.git
cd msdocs-app-service-sqldb-dotnetcore

プロジェクトフォルダーに移動し、Visual Studio で DotNetCoreSqlDb.sln ソリューションを開きます。

ToDo アプリケーションを使用する準備はできましたが、Visual Studio で使用できる localdb SQL server サーバーへの接続を確立する必要があります。 localdb に接続すると、ローカルで作業しながらアプリを実行し、ToDo を保持できます。

Visual Studio ソリューションエクスプローラーで [接続済みサービス] ノードを右クリックし、[追加] > [SQL Server データベース]を選択します。
[依存関係に接続する] ダイアログで、[SQL Server Express LocalDB (ローカル)] を選択し、[次へ] を選択します。
[SQL Server Express LocalDB (ローカル) に接続] ダイアログで、次の値を設定します。
- [接続文字列名]: 既定値のままにします。
- [接続文字列の値]: 既定値のままにします。
- [接続文字列の値の保存先]: [なし] を選択します。
- [次へ] を選択します
[変更の概要] 画面で、設定を既定値のままにし、[完了] を選択してワークフローを完了します。

Visual Studio に、LocalDB への接続など、サービスの依存関係の概要が表示されます。

次に、最初の移行を作成し、それを使って、ToDo アプリの正しいスキーマでローカルデータベースを更新する必要があります。

LocalDB 接続の横にあるサービス依存関係の一覧の右側にある [...] アイコンを選択し、[移行の追加] を選択します。
[Entity Framework の移行] ダイアログで、プロジェクトに含まれている DbContext クラスが Visual Studio によって検出されるのをしばらく待ちます。値が読み込まれたら、[完了] を選択します。
Visual Studio によってプロジェクト内に Migrations フォルダーが生成され、最初の移行クラスが作成されます。このクラスを使って、正しいスキーマでデータベースを更新できます。
LocalDB サービスの横にある [...] アイコンをもう一度選択し、[データベースの更新] を選択します。
[Entity Framework の移行] ダイアログで、DbContext クラスが Visual Studio によって検出されるのをもう一度待ってから、[完了] を選択します。 Visual Studio によって移行が実行され、LocalDB サーバーにデータベースのスキーマが作成されます。

Visual Studio の上部にある DotNetCoreSqlDb 実行ボタンを選択して、プロジェクトを起動します。

アプリが読み込まれたら、新しい ToDo を入力して、データベースが正しく動作していることを確認してください。 ToDo は、アプリのホームページのメインリストビューに表示されます。

アプリのスタートアップ構成を調べる

サンプルアプリには、Program.cs ファイルに次のコードが含まれています。

if(builder.Environment.IsDevelopment())
{
    builder.Services.AddDbContext<MyDatabaseContext>(options =>
        options.UseSqlServer(builder.Configuration.GetConnectionString("Default")));
}
else
{
    builder.Services.AddDbContext<MyDatabaseContext>(options =>
        options.UseSqlServer(Environment.GetEnvironmentVariable("AZURE_SQL_CONNECTIONSTRING")));
}

このコードにより、次の構成が適用されます。

アプリがローカルで実行される場合、localdb 接続文字列は appsettings.json ファイルからプルされ、Entity Framework に提供されます。この構成により、localdb 接続文字列をソース管理にチェックインし、他の開発者が開発中にローカルデータベースに簡単に接続できるようにすることができます。また、Entity Framework の移行をローカルで実行することもできるようになります。既定では、移行の実行時に、Entity Framework によって環境変数に格納されている接続文字列が検出されることはありません。
アプリが GitHub Actions ワークフローまたは運用環境で実行される場合、接続文字列は環境変数からプルされます。環境変数を使うと、運用環境のセキュリティで保護された接続文字列がソース管理にチェックインされたり、構成ファイルに含まれたりするのを防ぐことができます。

Azure サービスを作成する

アプリを正常にデプロイするには、次の Azure サービスを作成する必要があります。

コンテナーアプリ: デプロイされたアプリケーションをホストして実行するために必要です。
コンテナーレジストリ: コンテナー化されたアプリのビルドされたイメージ成果物を格納します。
SQL データベース: アプリのデータを格納する Azure SQL データベースです。

Visual Studio の発行機能を使って、これらのリソースの作成を処理できます。

Azure コンテナーアプリと Azure コンテナーレジストリを作成する

Visual Studio ソリューションエクスプローラーで、最上位レベルのプロジェクトノードを右クリックし、[発行] を選択します。
発行ダイアログで、デプロイターゲットとして [Azure] を選んでから、[次へ] を選択します。
特定のターゲットについては、[Azure Container Apps (Linux)] を選んでから、[次へ] を選択します。
デプロイする新しいコンテナーアプリを作成します。 [+ 新規作成] ボタンを選択して新しいダイアログを開き、次の値を入力します。
- コンテナーアプリ名: 既定値のままにするか、名前を入力します。
- サブスクリプション名: デプロイするサブスクリプションを選択します。
- [リソースグループ]: [新規] を選択し、msdocs-app-db-ef という名前の新しいリソースグループを作成します。
- コンテナーアプリ環境: [新規] を選択してコンテナーアプリ環境ダイアログを開き、次の値を入力します。
  - 環境名: 既定値のままにします。
  - 場所: 近くの場所を選択します。
  - Azure Log Analytics ワークスペースの: [新規作成] を選択して、Log Analytics ワークスペースダイアログを開きます。
    - 名前: 既定値のままにします。
    - 場所: 近くの場所を選んでから、[OK] を選択してダイアログを閉じます。
  - [OK] を選択して、コンテナーアプリ環境ダイアログを閉じます。
- [作成] 選択して、元のコンテナーアプリダイアログを閉じます。 Visual Studio によって、コンテナーアプリリソースが Azure に作成されます。
リソースが作成されたら、それがコンテナーアプリの一覧で選択されていることを確認してから、[次へ] を選択します。
アプリの発行済みイメージ成果物を格納するには、Azure Container Registry を作成する必要があります。コンテナーレジストリ画面で緑色の + アイコンを選択します。
既定値のままにして、[作成] を選択します。
コンテナーレジストリが作成されたら、それが選択されていることを確認し、[次へ] を選択します。
[配置の種類] 画面で、[GitHub Actions ワークフローを使用した CI/CD (yml ファイルが生成されます)] を選択し、[完了] を選択します。管理者ユーザーが発行された Docker コンテナーにアクセスできるようにするよう求めるメッセージが Visual Studio に表示された場合は、[はい] 選択します。

Visual Studio によって発行プロファイルが作成され、表示されます。発行の手順と詳細のほとんどは、GitHub Actions の .yml ファイルで説明されています。これを表示するには、発行プロファイルの概要ビューにある [ワークフローの編集] ボタンをクリックします。このファイルについては、この記事で後ほど詳しく説明します。

Azure SQL データベースを作成する

ソリューションエクスプローラーで、[接続済みサービス] ノードを右クリックし、[追加] > [SQL Server データベース]を選択します。
[依存関係に接続する] ダイアログで、[Azure SQL Database] を選択し、[次へ] を選択します。
[+ 新規作成] を選択して、新しいデータベースを追加します。
[Azure SQL Database] ダイアログで、次の値を入力します。
- [データベース名]: 既定値のままにします。
- [サブスクリプション名]: 前と同じサブスクリプションを選択します。
- [リソースグループ]: 前に作成した同じ msdocs-app-db-ef グループを選択します。
- [データベースサーバー]: [新規...] を選択し、新しいポップアップに次の値を入力します。
  - [データベースサーバー名]: 一意のサーバー名を入力するか、自動生成された名前の末尾にランダムな数字を追加します。
  - 場所: 近くの場所を選択します。
  - [管理者ユーザー名]: 任意の値を入力します。
  - [管理者パスワード]: 任意の値を入力します。
  - [管理者パスワード (確認)] : 同じパスワードを入力して確認します。 [OK] を選択して [SQL Server] ダイアログを閉じます
- [作成] を選択して、SQL サーバーとデータベースを作成します。
- 操作が完了したら、一覧からサーバーを選択し、[次へ] を選択します
[Azure SQL Database に接続] ダイアログでは、既定値をそのまま使用しますが、下部の [接続文字列の値の保存先] オプションで [なし] が選択されていることを確認してください。
[完了] を選択すると、Visual Studio によって SQL リソースが作成されます。

コンテナーアプリを Azure SQL に接続する

作成したコンテナーアプリの概要ページで、左側のナビゲーションから [サービスコネクタ (プレビュー)] を選択します。
[+ 作成] を選択して、新しい接続を作成します。
[接続の作成] ポップアップで、次の値を入力します。
- [コンテナー]: 作成した dotnetcoresqldb コンテナーを選択します。
- [サービスの種類]: [SQL Database] を選択します。
- [サブスクリプション]: コンテナーアプリの作成に使用したのと同じサブスクリプションを選択します。
- 接続名: 既定値のままにします。
- [SQL Server]: 前に作成したデータベースサーバーを選択します。
- [SQL データベース]: 前に作成したデータベースを選択します。
- クライアントの種類: [.NET] を選択します。
[次へ: 認証] を選択し、次の値を入力します。
- 認証の種類として [接続文字列] を選択します。
- [ユーザー名]: データベースサーバーの作成時に使用したユーザー名を入力します。
- [パスワード]: データベースサーバーの作成時に使用したパスワードを入力します。
残りの設定は既定値のままにし、[次へ: ネットワーク] を選択します。
既定値を選択したまま、[次へ: 確認および作成] を選択します。
Azure によって設定が検証されたら、[作成] を選択します。

しばらくすると、SQL データベースへの接続が表示されます。矢印を選択して接続を展開し、AZURE_SQL_CONNECTIONSTRING の値を確認します。この接続名は、サンプルアプリで定義されている環境変数の接続文字列の名前と一致します。

GitHub Actions ワークフローを構成する

Visual Studio によって生成された GitHub Actions ワークフローファイルを GitHub で使用して、変更がプッシュされたときにアプリをビルドして Azure にデプロイできます。現在、このプロセスは機能しますが、デプロイされたアプリは例外をスローします。 Azure SQL データベースは作成されましたが、スキーマを生成するステップを GitHub Actions ワークフローに追加する必要があります。 Azure SQL データベースの接続文字列は、シークレットとして GitHub に安全に格納し、実行時にワークフローで取得できます。

接続文字列を取得して GitHub シークレットに追加する

Azure portal のメイン検索バーで作成したデータベースを検索し、それを結果から選択します。
データベースの概要ページで、左側のナビゲーションから [接続文字列] を選択します。
[ADO.NET] タブで、フォームフィールドから接続文字列をコピーします。
アプリのフォークされた GitHub リポジトリに移動します。
[設定] タブで、左側のナビゲーションから [シークレット] > [アクション] を選択し、[New repository secret] (新しいリポジトリシークレット) を選択します。
[新しいシークレット] ページで、次の値を入力します。
- [名前]: DbConnection の名前を入力します。
- [シークレット]: Azure からコピーした接続文字列を貼り付けます。 必ず、接続文字列のパスワードのプレースホルダーを、データベースの作成時に選択したパスワードに置き換えてください。
- [Add secret](シークレットの追加) を選択します。

これで、接続文字列は GitHub リポジトリシークレットに安全に格納され、GitHub ワークフローを使用して取得できるようになりました。

GitHub Actions ワークフローを変更して移行を有効にする

発行の概要ページの [ワークフローの編集] ボタンを選択して、Visual Studio によって生成された GitHub Actions ワークフローの .yml ファイルを開きます。
ワークフローファイルの末尾に次の yaml を追加します。
```
- name: Run EF 
  run: | 
    dotnet tool install --global dotnet-ef
    dotnet tool restore
    dotnet ef database update -p DotNetCoreSqlDb --connection '${{ secrets.DBConnection }}'
```
このコードによって、エンティティフレームワークのコマンドラインツールがインストールされ、アプリの移行が実行されます。また、ワークフローの実行時に、このコードによって database update コマンドの connection パラメーターも使用され、appsettings.json ファイルに格納されている localdb の接続文字列が GitHub シークレットに追加された値でオーバーライドされます。

GitHub Actions ワークフローを実行し、デプロイをテストする

次のコマンドを使用して変更内容をアプリケーションにコミットし、フォークされたリポジトリにプッシュします。
```
git add --all
git commit -m "Added GitHub Actions workflow"
git push
```
GitHub リポジトリに移動し、[アクション] タブを選択します。プッシュが成功した場合は、ワークフローの実行が自動的にトリガーされているはずです。
アクティブなワークフローを選択し、各ステップの完了時にその詳細なログを表示します。移行は最後に実行され、Azure のデータベースが更新されます。

ワークフローが完了すると、アプリケーションは Azure Container Apps にデプロイされ、スキーマが更新されたデータベースに接続されます。

デプロイをテストするには、ローカルで行ったように、コンテナーアプリのホームページに移動し、ToDo を作成します。コンテナーアプリの URL は、Azure portal のアプリの概要ページでいつでも確認できます。