チュートリアル: テンプレートを使用して Service Fabric Mesh にアプリケーションをデプロイする

[アーティクル]
01/11/2019

重要

Azure Service Fabric Mesh のプレビューは廃止されました。 Service Fabric Mesh API を介した新しいデプロイは許可されなくなります。既存のデプロイのサポートは、2021 年 4 月 28 日まで継続されます。

詳細については、「Azure Service Fabric Mesh のプレビューの廃止」を参照してください。

このチュートリアルは、シリーズの第 1 部です。テンプレートを使用して Azure Service Fabric Mesh アプリケーションをデプロイする方法について説明します。アプリケーションは ASP.NET Web フロントエンドサービスと ASP.NET Core Web API バックエンドサービスで構成されており、これらは Docker Hub にあります。 2 つのコンテナーイメージを Docker Hub からプルして、独自のプライベートレジストリにプッシュします。その後、アプリケーション用の Azure RM テンプレートを作成し、コンテナーレジストリから Service Fabric Mesh にアプリケーションをデプロイします。完了すると、Service Fabric Mesh で実行される簡単な To Do List アプリケーションができあがります。

シリーズの第 1 部で学習する内容は次のとおりです。

プライベート Azure Container Registry インスタンスを作成する
コンテナーイメージをレジストリにプッシュする
RM テンプレートファイルとパラメーターファイルを作成する
Azure Service Fabric Mesh にアプリケーションをデプロイする

このチュートリアルシリーズで学習する内容は次のとおりです。

テンプレートを使用して Azure Service Fabric Mesh にアプリケーションをデプロイする
Service Fabric Mesh で実行されているアプリケーション内のサービスをスケーリングする
Service Fabric Mesh で実行されているアプリケーションをアップグレードする
アプリケーションの削除

Service Fabric mesh は現在プレビューの段階です。プレビュー版は、追加使用条件に同意することを条件に使用できます。この機能の一部の側面は、一般公開 (GA) 前に変更される可能性があります。

前提条件

このチュートリアルを開始する前に

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成できます。
Docker のインストール
Azure CLI と Service Fabric Mesh CLI をローカルにインストールします。

コンテナーレジストリの作成

Service Fabric Mesh アプリケーション内のサービスに関連付けられているコンテナーイメージを、コンテナーレジストリに格納する必要があります。このチュートリアルでは、プライベートな Azure Container Registry (ACR) インスタンスを使用します。

次の手順のようにして、ACR のインスタンスを作成します。 ACR のインスタンスを既にセットアップしてある場合は、省略して先に進んでかまいません。

Azure にサインインしてアクティブなサブスクリプションを設定します。

az login
az account set --subscription "<subscriptionName>"

リソースグループを作成する

Azure リソースグループとは、Azure リソースのデプロイと管理に使用する論理コンテナーです。次のコマンドを使用して、myResourceGroup という名前のリソースグループを eastus に作成します。

az group create --name myResourceGroup --location eastus

コンテナーレジストリを作成する

az acr create コマンドを使用して ACR のインスタンスを作成します。レジストリの名前は Azure 内で一意にする必要があり、英数字で 5 ～ 50 文字にする必要があります。次の例では、myContainerRegistry という名前を使用します。レジストリの名前が使用されているエラーが発生する場合は、別の名前を選択します。

az acr create --resource-group myResourceGroup --name myContainerRegistry --sku Basic

レジストリが作成されると、次のような出力が表示されます。

{
  "adminUserEnabled": false,
  "creationDate": "2018-09-13T19:43:57.388203+00:00",
  "id": "/subscriptions/<subscription>/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myContainerRegistry",
  "location": "eastus",
  "loginServer": "mycontainerregistry.azurecr.io",
  "name": "myContainerRegistry",
  "provisioningState": "Succeeded",
  "resourceGroup": "myResourceGroup",
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  },
  "status": null,
  "storageAccount": null,
  "tags": {},
  "type": "Microsoft.ContainerRegistry/registries"
}

Azure Container Registry にイメージをプッシュする

このチュートリアルでは、例として To Do List サンプルアプリケーションを使います。 WebFrontEnd および ToDoService サービスのコンテナーイメージは、Docker Hub にあります。 Visual Studio でアプリケーションをビルドする方法については、Service Fabric Mesh Web アプリのビルドに関するページを参照してください。 Service Fabric Mesh では、Windows または Linux の Docker コンテナーを実行できます。 Linux コンテナーを使用している場合は、Docker で [Switch to Linux containers]\(Linux コンテナーに切り替える\) を選択します。 Windows コンテナーを使用している場合は、Docker で [Switch to Windows containers]\(Windows コンテナーに切り替える\) を選択します。

ACR のインスタンスにイメージをプッシュするには、まずコンテナーイメージを用意する必要があります。ローカルコンテナーイメージがまだない場合は、docker pull コマンドを使用して、WebFrontEnd イメージと ToDoService イメージを Docker Hub からプルします。

注意

2020 年 11 月 2 日より、Docker の無料プランアカウントから Docker Hub に対する匿名と認証済みの要求にダウンロードレート制限が適用されるようになり、IP アドレスによって実施されます。

これらのコマンドには、Docker Hub のパブリックイメージが利用されています。レート制限を受ける場合があるので注意してください。詳細については、「Docker Hub に対する認証」を参照してください。

Windows イメージをプルします。

docker pull seabreeze/azure-mesh-todo-webfrontend:1.0-nanoserver-1709
docker pull seabreeze/azure-mesh-todo-service:1.0-nanoserver-1709

イメージをレジストリにプッシュするには、ACR ログインサーバーの完全修飾名を使用して、そのイメージにタグを付けておく必要があります。

次のコマンドを実行して、ACR インスタンスの完全なログインサーバー名を取得します。

az acr list --resource-group myResourceGroup --query "[].{acrLoginServer:loginServer}" --output table

AcrLoginServer
---------------------------------
mycontainerregistry.azurecr.io

docker tag コマンドを使用して、Docker イメージにタグを付けます。次の例では、seabreeze/azure-mesh-todo-service:1.0-nanoserver-1709 および seabreeze/azure-mesh-todo-webfrontend:1.0-nanoserver-1709 イメージにタグを付けています。さまざまなイメージを使用している場合は、次のコマンドでこれらのイメージ名を置き換えてください。

docker tag seabreeze/azure-mesh-todo-webfrontend:1.0-nanoserver-1709 mycontainerregistry.azurecr.io/seabreeze/azure-mesh-todo-webfrontend:1.0-nanoserver-1709
docker tag seabreeze/azure-mesh-todo-service:1.0-nanoserver-1709 mycontainerregistry.azurecr.io/seabreeze/azure-mesh-todo-service:1.0-nanoserver-1709

Azure Container Registry にサインインします。

az acr login -n myContainerRegistry

docker push コマンドで ACR インスタンスにイメージをプッシュします。

docker push mycontainerregistry.azurecr.io/seabreeze/azure-mesh-todo-webfrontend:1.0-nanoserver-1709
docker push mycontainerregistry.azurecr.io/seabreeze/azure-mesh-todo-service:1.0-nanoserver-1709

コンテナーイメージの一覧表示

ACR インスタンス内のリポジトリを表示するには、次のコマンドを実行します。

az acr repository list --name myContainerRegistry --output table

Result
-------------------------------
seabreeze/azure-mesh-todo-webfrontend
seabreeze/azure-mesh-todo-service

次の例では、azure-mesh-todo-service リポジトリのタグが一覧表示されます。

az acr repository show-tags --name myContainerRegistry --repository seabreeze/azure-mesh-todo-service --output table

Result
--------
1.0-nanoserver-1709

上記の出力により、プライベートコンテナーレジストリ内に azure-mesh-todo-service:1.0-nanoserver-1709 があることを確認します。 azure-mesh-todo-webfrontend:1.0-nanoserver-1709 の存在を確認することもできます。

レジストリの資格情報を取得する

重要

運用環境では、ACR インスタンスで管理者ユーザーを有効にしないでください。ここでは便宜上行っています。運用環境では、ユーザーとシステム両方の認証にサービスプリンシパルを使用します。

テンプレートを使用して作成されたレジストリからコンテナーインスタンスをデプロイするには、デプロイの間にレジストリの資格情報を指定する必要があります。最初に、次のコマンドを使用して、レジストリの管理者ユーザーを有効にします。

az acr update --name myContainerRegistry --admin-enabled true

次に、次のコマンドを使用して、レジストリのログインサーバー名、ユーザー名、パスワードを取得します。

az acr list --resource-group myResourceGroup --query "[].{acrLoginServer:loginServer}" --output table
az acr credential show --name myContainerRegistry --query username
az acr credential show --name myContainerRegistry --query "passwords[0].value"

次のセクションで RM テンプレートとパラメーターファイルを作成するときに、ここで返された ACR ログインサーバー名、ユーザー名、パスワードの値を使用します。

テンプレートファイルとパラメーターファイルをダウンロードして調べる

Service Fabric Mesh アプリケーションは、Azure Resource Manager (RM) テンプレートを使用してデプロイおよび管理できる Azure リソースです。 Azure ソリューションのデプロイと管理に関する概念に精通していない場合は、「Azure Resource Manager の概要」および「Azure Resource Manager テンプレートの構造と構文の詳細」をご覧ください。

このチュートリアルでは、例として To Do List サンプルを使います。新しいテンプレートファイルとパラメーターファイルを作成する代わりに、mesh_rp.windows.json デプロイテンプレートファイルと mesh_rp.windows.parameter.json パラメーターファイルをダウンロードします。

パラメーター

アプリケーションのデプロイ後に変更が予想される値がテンプレートにある場合、またはデプロイごとにオプションを変更する場合 (他のデプロイにこのテンプレートを再利用する場合)、ベストプラクティスは値をパラメーター化することです。これを行う適切な方法は、デプロイテンプレートの先頭に "parameters" セクションを作成し、そこでパラメーターの名前とプロパティを指定して、以降のデプロイテンプレートではそれを参照することです。各パラメーターの定義には、type、defaultValue、および省略可能な metadata セクションと description が含まれます。

parameters セクションは、デプロイテンプレートの先頭の、resources セクションの直前で定義します。

{
    "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
      ...
    },
    "resources": [

mesh_rp.windows.json デプロイテンプレートでは、location、registryPassword、registryUserName、registryServer、frontEndImage、serviceImage、frontEndCpu、serviceCpu、frontEndMemory、serviceMemory、frontEndReplicaCount、serviceReplicaCount の各パラメーターが宣言されています。各パラメーターの説明はデプロイテンプレートファイルをご覧ください。

これらのパラメーターは、mesh_rp.windows.parameter.json パラメーターファイルで使用されます。パラメーターファイルを別にすることで、デプロイテンプレート自体を更新することなく、デプロイごとにパラメーターの値を変更できます。

アプリケーションとサービスの概要

サービスは、テンプレートにおいてアプリケーションリソースのプロパティとして指定されています。アプリケーションはプライベートネットワークにデプロイされ、これはテンプレートでリソースとして宣言されています。サービスではボリュームを使用してデータを保持でき、これはテンプレートでリソースとして宣言されています。サービスごとに、OS の種類、コードパッケージ、レプリカの数、およびネットワークが、サービスのプロパティとして指定されています。コードパッケージごとに、コンテナーイメージ、エンドポイント、メモリと CPU リソース、およびイメージリポジトリの資格情報を指定します。複数のサービスを含む Service Fabric Mesh アプリケーションのテンプレートは、だいたい次のようになります。

{
  "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json",
  "contentVersion": "1.0.0.0",
  "parameters": {
    ...
  },
  "resources": [
    {
      "apiVersion": "2018-09-01-preview",
      "name": "MyMeshApplication",
      "type": "Microsoft.ServiceFabricMesh/applications",
      "location": "[parameters('location')]",
      "dependsOn": [
        "Microsoft.ServiceFabricMesh/networks/MeshAppNetwork",
        "Microsoft.ServiceFabricMesh/volumes/ServiceAVolume"
      ],
      "properties": {
        "services": [
          {
            "name": "ServiceA",
            "properties": {
              "description": "ServiceA description.",
              "osType": "Linux",
              "codePackages": [
                {
                  "name": "ServiceA",
                  "image": "[parameters('frontEndImage')]",
                  "volumeRefs": [
                    {
                      "name": "[resourceId('Microsoft.ServiceFabricMesh/volumes', 'ServiceAVolume')]",
                      "destinationPath": "/app/data"
                    }
                  ],
                  "endpoints": [
                    {
                      "name": "ServiceAListener",
                      "port": 80
                    }
                  ],
                  "resources": {
                    "requests": {
                      "cpu": "[parameters('frontEndCpu')]",
                      "memoryInGB": "[parameters('frontEndMemory')]"
                    }
                  },
                  "imageRegistryCredential": {
                    "server": "[parameters('registryServer')]",
                    "username": "[parameters('registryUserName')]",
                    "password": "[parameters('registryPassword')]"
                  }
                }
              ],
              "replicaCount": "[parameters('frontEndReplicaCount')]",
              "networkRefs": [
                {
                  "name": "[resourceId('Microsoft.ServiceFabricMesh/networks', 'MeshAppNetwork')]"
                }
              ]
            }
          },
          {
            "name": "ServiceB",
            ...
          }
        ],
        "description": "Application description."
      }
    },
    {
      "apiVersion": "2018-07-01-preview",
      "name": "MeshAppNetwork",
      "type": "Microsoft.ServiceFabricMesh/networks",
      "location": "[parameters('location')]",
      "dependsOn": [],
      "properties": {
        "description": "MeshAppNetwork description.",
        "addressPrefix": "10.0.0.4/22",
        "ingressConfig": {
          "layer4": [
            {
              "name": "ServiceAIngress",
              "publicPort": "20001",
              "applicationName": "MyMeshApplication",
              "serviceName": "ServiceA",
              "endpointName": "ServiceAListener"
            }
          ]
        }
      }
    },
    {
      "apiVersion": "2018-09-01-preview",
      "name": "ServiceAVolume",
      "type": "Microsoft.ServiceFabricMesh/volumes",
      "location": "[parameters('location')]",
      "dependsOn": [],
      "properties": {
        "description": "Azure Files storage volume for counter App.",
        "provider": "SFAzureFile",
        "azureFileParameters": {
          "shareName": "[parameters('fileShareName')]",
          "accountName": "[parameters('storageAccountName')]",
          "accountKey": "[parameters('storageAccountKey')]"
        }
      }
    }
  ]
}

To Do List アプリケーションの仕様については、mesh_rp.windows.json デプロイテンプレートファイルをご覧ください。

Azure Service Fabric Mesh にアプリケーションをデプロイする

次のコマンドを使用して、アプリケーションおよび関連リソースを作成し、前の「レジストリの資格情報を取得する」ステップからの資格情報を指定します。

パラメーターファイルでは、次のパラメーター値を更新します。

パラメーター	[値]
location	アプリケーションをデプロイするリージョン。たとえば、"eastus"。
registryPassword	前の「レジストリの資格情報を取得する」で取得したパスワード。テンプレートのこのパラメーターはセキュリティで保護された文字列であり、デプロイの状態または `az mesh service show` コマンドでは表示されません。
registryUserName	「レジストリの資格情報を取得する」で取得したユーザー名。
registryServer	「レジストリの資格情報を取得する」で取得したレジストリサーバー名。
frontEndImage	フロントエンドサービスのコンテナーイメージ。たとえば、「 `<myregistry>.azurecr.io/seabreeze/azure-mesh-todo-webfrontend:1.0-nanoserver-1709` 」のように入力します。
serviceImage	バックエンドサービスのコンテナーイメージ。たとえば、「 `<myregistry>.azurecr.io/seabreeze/azure-mesh-todo-service:1.0-nanoserver-1709` 」のように入力します。

アプリケーションをデプロイするには、次のコマンドを実行します。

az mesh deployment create --resource-group myResourceGroup --template-file c:\temp\mesh_rp.windows.json --parameters c:\temp\mesh_rp.windows.parameters.json

このコマンドを実行すると、次のような JSON スニペットが生成されます。 JSON 出力の outputs セクションで、publicIPAddress プロパティをコピーします。

"outputs": {
    "publicIPAddress": {
    "type": "String",
    "value": "40.83.78.216"
    }
}

この情報は、ARM テンプレートの outputs セクションから取得されます。下記のように、このセクションではゲートウェイリソースを参照してパブリック IP アドレスをフェッチします。

  "outputs": {
    "publicIPAddress": {
      "value": "[reference('todolistappGateway').ipAddress]",
      "type": "string"
    }
  }

アプリケーションを開く

アプリケーションが正常にデプロイされたら、サービスエンドポイントのパブリック IP アドレスを取得します。 deployment コマンドは、サービスエンドポイントのパブリック IP アドレスを返します。必要に応じて、ネットワークリソースにクエリを送信して、サービスエンドポイントのパブリック IP アドレスを見つけることもできます。このアプリケーションのネットワークリソース名は todolistappNetwork です。次のコマンドを使用して、その情報を取得します。

az mesh gateway show --resource-group myResourceGroup --name todolistappGateway

Web ブラウザーで IP アドレスに移動します。

アプリケーションの状態を確認する

app show コマンドを使用して、アプリケーションの状態を確認できます。デプロイされたアプリケーションのアプリケーション名は "todolistapp" なので、その詳細をフェッチします。

az mesh app show --resource-group myResourceGroup --name todolistapp

az mesh code-package-log get コマンドを使用して、デプロイ済みのアプリケーションのログを確認します。

az mesh code-package-log get --resource-group myResourceGroup --application-name todolistapp --service-name WebFrontEnd --replica-name 0 --code-package-name WebFrontEnd

次のステップ

チュートリアルのこの部分で学習した内容は次のとおりです。

プライベートコンテナーレジストリを作成する
コンテナーイメージをレジストリにプッシュする
テンプレートファイルとパラメーターファイルを作成する
Azure Service Fabric Mesh にアプリケーションをデプロイする

次のチュートリアルに進みます。

Service Fabric Mesh で実行しているアプリケーションをスケーリングする

チュートリアル: テンプレートを使用して Service Fabric Mesh にアプリケーションをデプロイする

前提条件

コンテナー レジストリの作成

Azure へのサインイン

リソース グループを作成する

コンテナー レジストリを作成する