Service Fabric のマネージドクラスターのノードタイプ

[アーティクル]
10/15/2024

仮想マシンスケールセットは、Service Fabric マネージドクラスター内の各ノードタイプをサポートします。マネージドクラスターでは、Service Fabric マネージドクラスターリソースプロバイダーを使用して必要な変更を行います。クラスターの基礎となるすべてのリソースは、ユーザーに代わってマネージドクラスタープロバイダーが作成と抽象化を行います。リソースの管理をリソースプロバイダーに任せると、クラスターノードタイプのデプロイと管理が簡略化されます。管理により、シードノードの削除などの操作エラーを防ぐことができます。また、仮想マシン (VM) SKU を安全に使用できるかどうかの検証など、ベストプラクティスの適用に役立ちます。

このドキュメントの残りの部分では、次のようなさまざまな設定を調整する方法について説明します。

ノードタイプを作成する
ノードタイプのインスタンス数を調整する
OS イメージの自動アップグレードを有効にする
OS イメージを変更する
配置プロパティを構成する
コンピューター名のプレフィックスを設定する

このドキュメントでは、Azure portal と Azure Resource Manager テンプレートを使用して変更を加えることに焦点を当てています。

重要

現時点では、Service Fabric マネージドクラスターはカスタム OS イメージをサポートしていません。

Note

変更の進行中はノードタイプを変更できません。要求された変更を完了してから別の変更を行うことをお勧めします。

ノードタイプの追加

ポータル、Azure Resource Manager テンプレート、または PowerShell を使って、Service Fabric マネージドクラスターにノードタイプを追加できます。

ポータルで追加する

Note

ポータルを使って追加できるのは、セカンダリノードタイプのみです

Azure ポータルにサインインします
クラスターリソースの [概要] ページに移動します。
Settings セクションの Node types を選びます
上部の Add を選び、必要な情報を入力して、下部の [追加] を選ぶだけで完了です。
新しいノードタイプの追加が終わるまで待ちます

ARM テンプレートで追加する

必要な値を持使用して別のリソースの種類 Microsoft.ServiceFabric/managedclusters/nodetypes を追加し、設定を有効にするためにクラスターの展開を実行します。

Service Fabric マネージドクラスターリソースの apiVersion は、2021-05-01 以降である必要があります。
既存のプライマリノードタイプを置き換える場合は、isPrimary を true に設定してください。

{
    "apiVersion": "[variables('sfApiVersion')]",
    "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
    "name": "[concat(parameters('clusterName'), '/', parameters('nodeType2Name'))]",
    "location": "[resourcegroup().location]",
    "dependsOn": [
        "[concat('Microsoft.ServiceFabric/managedclusters/', parameters('clusterName'))]"
    ],
    "properties": {
        "isPrimary": false,
        "vmImagePublisher": "[parameters('vmImagePublisher')]",
        "vmImageOffer": "[parameters('vmImageOffer')]",
        "vmImageSku": "[parameters('vmImageSku')]",
        "vmImageVersion": "[parameters('vmImageVersion')]",
        "vmSize": "[parameters('nodeType2VmSize')]",
        "vmInstanceCount": "[parameters('nodeType2VmInstanceCount')]",
        "dataDiskSizeGB": "[parameters('nodeType2DataDiskSizeGB')]",
        "dataDiskType": "[parameters('nodeType2managedDataDiskType')]"
    }
}

2 つのノードタイプの構成例については、2 つのノードタイプの ARM テンプレートのサンプルを参照してください。

PowerShell を使用して追加

新しいノードタイプを作成するには、次のプロパティを定義する必要があります。

リソースグループ: クラスターが含まれるリソースグループ
クラスター名: マネージドクラスターの名前
ノードタイプ名:クラスター内のどの既存のノードタイプにもない名前。
インスタンス数:新しいノードタイプの初期ノード数。
[VM サイズ] :ノードの VM SKU。指定されていない場合は、既定値の Standard_D2 が使用されます。

Note

プライマリノードタイプを追加する場合は、-Primary プロパティを使う必要があります。

$resourceGroup = "myResourceGroup"
$clusterName = "mysfcluster"
$nodeTypeName = "nt2"
$vmSize = "Standard_D2_v2"

New-AzServiceFabricManagedNodeType -ResourceGroupName $resourceGroup -ClusterName $clusterName -Name $nodeTypeName -InstanceCount 3 -vmSize $vmSize

ノードタイプを削除する

ポータルまたは PowerShell を使って、Service Fabric マネージドクラスターのノードタイプを削除できます。

Note

Service Fabric マネージドクラスターからプライマリノードタイプを削除するには PowerShell を使う必要があり、使用できるプライマリノードタイプが複数存在している必要があります。

ポータルで削除する

Azure ポータルにサインインします
クラスターリソースの [概要] ページに移動します。
Settings セクションの Node types を選びます
削除する Node Type を選び、上部の Delete を選びます。

PowerShell で削除する

Note

SKU のアップグレードなどのシナリオでプライマリノードタイプを削除する場合は、何時間もかかり、SFX を使って進行状況を監視できます。シードノードの場合、アップグレードドメイン (UD) ウォークごとに一度に 1 つのノードが移行されます。

ノードタイプを削除するには、次のプロパティを定義する必要があります。

リソースグループ: クラスターが含まれるリソースグループ
クラスター名: マネージドクラスターの名前
ノードタイプ名:クラスター内のどの既存のノードタイプにもない名前。

$resourceGroup = "myResourceGroup"
$clusterName = "myCluster"
$nodeTypeName = "nt2"

Remove-AzServiceFabricManagedNodeType -ResourceGroupName $resourceGroup -ClusterName $clusterName  -Name $nodeTypeName

ノードタイプをスケーリングする

ポータル、ARM テンプレート、または PowerShell を使って、Service Fabric マネージドクラスターのノードタイプをスケーリングできます。完全に自動化されたソリューションが必要な場合は、セカンダリノードタイプの自動スケーリングを構成することもできます。

Note

プライマリノードタイプは、自動スケーリングに設定することはできず、手動スケーリングにのみ設定できます。
プライマリノードタイプの場合、ノード数を 3 未満 (Basic SKU クラスターの場合) や 5 未満 (Standard SKU クラスターの場合) にすることはできません。

ポータルを使用してスケーリングする

このチュートリアルでは、ポータルを使用してノードタイプのノード数を変更する方法について説明します。

Azure ポータルにサインインします
クラスターリソースの [概要] ページに移動します。
Settings セクションで Node Types を選択します
変更したい Node type name を選択します
必要に応じてノードタイププロパティを確認し、更新します。

ノード数の増加を示すサンプル

Manage node type scaling を選択してスケーリング設定を構成し、カスタム自動スケーリングオプションと手動スケーリングオプションのどちらかを選択します。自動スケーリングは組み込みの機能であり、需要が変化した場合にアプリケーションが最適な操作を実行できるようにします。リソースをスケーリングする方法として、特定のインスタンス数に合わせて手動で行うか、メトリックのしきい値に基づいてスケーリングするカスタムの自動スケーリングポリシーを使用するかを選択できます。指定した時間枠内にスケーリングするインスタンス数をスケジュールすることもできます。 Azure 自動スケーリングの詳細を確認するか、ハウツービデオを視聴します。
- [カスタム自動スケーリング]: 適切な scale mode を選択して、カスタム自動スケーリングポリシー (Scale to a specific instance count または Scale based on a metric) を定義します。後者は、CPU 使用率が 70% を超えたらインスタンス数を 1 増やすといったメトリックトリガールールに基づいています。ポリシーを定義したら、上部の Save を選択します。
- [手動スケーリング]: Node count を目的の新しい値に調整し、上部にある Save を選択します。このスクリーンショットでは、3 であった値が 5 に調整されています。
下部にある Apply を選択して、これらの保存された設定をノードタイプに対して構成します。
完了するまで、Provisioning state には Updating の状態が表示されます。完了すると、再び Succeeded と表示されます。

テンプレートを使用してノードタイプをスケーリングする

ARM テンプレートを使用してノードタイプのノード数を調整するには、vmInstanceCount プロパティを新しい値で調整し、設定を有効にするためにクラスターの展開を実行します。クラスターにより、アップグレードが自動的に開始されます。完了すると、追加のノードが表示されます。

Service Fabric マネージドクラスターリソースの apiVersion は、2021-05-01 以降である必要があります。

Note

スケーリング要求が必須の最小値に違反する場合、マネージドクラスタープロバイダーではスケール調整がブロックされます。

{
  "apiVersion": "[variables('sfApiVersion')]",
  "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
  "name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
  "location": "[resourcegroup().location]",
  "properties": {
    ...
    "vmInstanceCount": "[parameters('nodeTypeVmInstanceCount')]",
    ...
  }
}

PowerShell でノードタイプをスケーリングする

スケーリングしたいノードタイプのノード数を増減させるには、インスタンス数を変更します。ノードタイプの名前は、クラスターデプロイの Azure Resource Manager テンプレート (ARM テンプレート) または Service Fabric Explorer で確認できます。

$resourceGroup = "myResourceGroup"
$clusterName = "mysfcluster"
$nodeTypeName = "FE"
$instanceCount = "7"

Set-AzServiceFabricManagedNodeType -ResourceGroupName $resourceGroup -ClusterName $clusterName -name $nodeTypeName -InstanceCount $instanceCount -Verbose

クラスターにより、アップグレードが自動的に開始されます。完了すると、追加のノードが表示されます。

OS の自動アップグレードを有効にする

マネージドクラスターノードが実行されている仮想マシンに対して、OS イメージの自動アップグレードを有効にすることができます。仮想マシンスケールセットのリソースは、ユーザーに代わって Service Fabric マネージドクラスターによって管理されますが、クラスターノードに対して OS イメージの自動アップグレードを有効にするかどうかはユーザーが選択できます。従来の Service Fabric クラスターと同様に、クラスターに対する意図しない中断を防ぐために、マネージドクラスターノードは既定ではアップグレードされません。

Note

OS イメージの自動アップグレードは、マーケットプレースとカスタムイメージの両方でサポートされています。

OS の自動アップグレードを有効にするには、次のようにします。

apiVersion2021-05-01(またはそれ以降の) バージョンのMicrosoft.ServiceFabric/managedclustersリソースとMicrosoft.ServiceFabric/managedclusters/nodetypesリソースを使用する
クラスターのプロパティ enableAutoOSUpgrade を true に設定する
クラスターの nodeTypes のリソースのプロパティ vmImageVersion を latest に設定する

次に例を示します。

    {
      "apiVersion": "[variables('sfApiVersion')]",
      "type": "Microsoft.ServiceFabric/managedclusters",
      ...
      "properties": {
        ...
        "enableAutoOSUpgrade": true
      },
    },
    {
      "apiVersion": "[variables('sfApiVersion')]",
      "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
       ...
      "properties": {
        ...
        "vmImageVersion": "latest",
        ...
      }
    }
}

有効にすると、Service Fabric によってマネージドクラスター内で OS イメージのバージョンの照会と追跡が開始されます。新しい OS バージョンが利用可能な場合、クラスターノードの種類 (仮想マシンスケールセット) が一度に 1 つずつアップグレードされます。 Service Fabric ランタイムのアップグレードは、クラスターノードの OS イメージのアップグレードが進行中でないことを確認した後にのみ実行されます。

アップグレードが失敗した場合、Service Fabric によって 24 時間後に再試行され、最大で 3 回再試行されます。従来の (アンマネージド) Service Fabric のアップグレードと同様に、異常なアプリやノードによって OS イメージのアップグレードがブロックされることがあります。

イメージのアップグレードの詳細については、「Azure 仮想マシンスケールセットを使用した OS イメージの自動アップグレード」を参照してください。

ノードタイプの OS SKU を変更する

Service Fabric マネージドクラスターでは、ノードタイプの OS SKU をインプレースで変更できます。このプロセスは、Windows 2019 から Windows 2022 への移行などのシナリオや、サーバー (コア) SKU とデスクトップエクスペリエンス SKU を使用するサーバーを切り替える場合に役立ちます。

ポータルで OS SKU を変更する

このチュートリアルでは、ポータルを使用してノードタイプの OS イメージを変更する方法について説明します。

Azure ポータルにサインインします
クラスターリソースの [概要] ページに移動します。
Settings セクションで Node Types を選択します
変更したい Node type name を選択します
OS Image を目的の新しい値に調整し、下部にある Apply を選択します。 ![OS イメージの変更を示すサンプル][change-os-image]
Provisioning state には Updating の状態が表示され、一度に 1 つのアップグレードドメインが実行されます。完了すると、再び Succeeded と表示されます。

テンプレートで OS SKU を変更する

ARM テンプレートを使用してノードタイプに使用される OS イメージを変更するには、vmImageSku プロパティを新しい値で調整し、設定を有効にするためにクラスターの展開を実行します。マネージドクラスタープロバイダーでは、アップグレードドメインごとに各インスタンスが再イメージ化されます。

Service Fabric マネージドクラスターリソースの apiVersion は、2021-05-01 以降である必要があります。

{
  "apiVersion": "[variables('sfApiVersion')]",
  "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
  "name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
  "location": "[resourcegroup().location]",
  "properties": {
    ...
    "vmImagePublisher": "[parameters('vmImagePublisher')]",
    "vmImageOffer": "[parameters('vmImageOffer')]",
    "vmImageSku": "[parameters('vmImageSku')]",
    "vmImageVersion": "[parameters('vmImageVersion')]",
    ...
  }
}

ノードの種類の配置プロパティを構成する

特定のワークロードがクラスター内の特定のノードタイプだけで実行されるようにするには、配置プロパティを使います。 Service Fabric マネージドクラスターでは、ポータル、ARM テンプレート、または PowerShell を使ってこれらのプロパティを構成できます。

ポータルで配置プロパティを構成する

このチュートリアルでは、ポータルを使用してノードタイプの配置プロパティを変更する方法について説明します。

Azure ポータルにサインインします
クラスターリソースの [概要] ページに移動します。
Settings セクションで Node Types を選択します
変更したい Node type name を選択します
Placement properties セクションで、必要な名前と値を追加し、下部にある Apply を選びます。このスクリーンショットでは、Name SSD_Premium が使用され、Value は true になっています。
完了するまで、Provisioning state には Updating の状態が表示されます。完了すると、再び Succeeded と表示されます。

テンプレートで配置プロパティを構成する

ARM テンプレートを使用してノードタイプの配置プロパティを調整するには、placementProperties プロパティを 1 つ以上の新しい値で調整し、設定を有効にするためにクラスターの展開を実行します。次のサンプルは、ノードタイプに対して 3 つの値が設定されていることを示しています。

Service Fabric マネージドクラスターリソースの apiVersion は、2021-05-01 以降である必要があります。

{
  "apiVersion": "[variables('sfApiVersion')]",
  "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
  "name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
  "location": "[resourcegroup().location]",
  "properties": {
    "placementProperties": {
      "PremiumSSD": "true",
      "NodeColor": "green",
      "SomeProperty": "5"
    }
  }
}

PowerShell で配置プロパティを構成する

次の例では、特定のノードタイプの配置プロパティを更新し、既存のものを上書きします。

$rgName = "testRG"
$clusterName = "testCluster"
$NodeTypeName = "nt1"
Set-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName -name $NodeTypeName -PlacementProperty @{NodeColor="Red";SomeProperty="6";} -Verbose

ノードタイプの VM SKU を変更する

ARM テンプレートを使用してノードタイプに使用される VM SKU サイズを変更するには、vmSize プロパティを新しい値に調整し、設定を有効にするためにクラスターをデプロイします。マネージドクラスタープロバイダーでは、アップグレードドメインごとに各インスタンスが再イメージ化されます。 SKU オプションの一覧については、VM サイズ ‐ Azure の仮想マシン | Microsoft Learn のページを参照してください。

{
  "apiVersion": "[variables('sfApiVersion')]",
  "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
  "name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
  "location": "[resourcegroup().location]",
  "properties": {
    ...
    "vmSize": "[parameters('vmImageVersion')]",
    ...
  }
}

複数のマネージドディスクを構成する

Service Fabric のマネージドクラスターでは、既定では、1 つのマネージドディスクが構成されます。次のオプションのプロパティと値を構成することにより、クラスター内のノードの種類にマネージドディスクを追加できます。ドライブ文字、ディスクの種類、ディスクごとのサイズを指定できます。

次に示すように、Resource Manager テンプレートで additionalDataDisks プロパティと必要なパラメーターを宣言してマネージドディスクを構成します。

機能の要件

LUN はディスクごとに一意である必要があり、予約済みの LUN 0 または 1 を使用することはできません。
ディスク文字には、予約済みの文字である C または D を使用できません。また、作成後に変更することはできません。指定しない場合は、既定で S が使用されます。
サポートされているディスクの種類を指定する必要があります
Service Fabric マネージドクラスターリソースの apiVersion は、2022-01-01以降である必要があります。

{
  "apiVersion": "[variables('sfApiVersion')]",
  "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
  "name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
  "location": "[resourcegroup().location]",
  "properties": {
    "additionalDataDisks": {
      "lun": "2",
      "diskSizeGB": "50",
      "diskType": "Standard_LRS",
      "diskLetter": "S" 
    }
  }
}

使用可能なパラメーターの完全なリストを参照してください。

Service Fabric データディスクのドライブ文字を構成する

Service Fabric のマネージドクラスターでは、既定で Service Fabric データディスクが構成され、ノードの種類のすべてのノードでドライブ文字が自動的に構成されます。この省略可能なプロパティと値を構成することにより、ドライブ文字のマッピングに特定の要件がある場合に、Service Fabric データディスクの文字を指定して取得できます。

機能の要件

ディスク文字には、予約済みの文字である C または D を使用できません。また、作成後に変更することはできません。指定しない場合は、既定で S が使用されます。
Service Fabric マネージドクラスターリソースの apiVersion は、2022-01-01 以降である必要があります。

{
  {
    "apiVersion": "[variables('sfApiVersion')]",
    "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
    "name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
    "location": "[resourcegroup().location]",
    "properties": {
      "dataDiskLetter": "S"
    }
  }
}

コンピューター名のプレフィックスを設定する

より詳細な説明のためにノードタイプに長い名前を必要とするお客様には、コンピューター名のプレフィックスが役立ちます。

Note

コンピューター名のプレフィックスは、Service Fabric API バージョン 2024-04-01 or later の場合にのみ機能します。

コンピューター名のプレフィックスを設定するには、次の ARM テンプレートの変更を実装します。

{
  "apiVersion": "2024-04-01",
  "type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
  "name": "[concat(parameters('clusterName'), '/', 'BE-testResourceGroup-testRegion-test')]",
  "location": "[parameters('clusterLocation')]",
  "dependsOn": [
      "[concat('Microsoft.ServiceFabric/managedclusters/', parameters('clusterName'))]"
  ],
  "properties": {
    "isPrimary": false,
    "dataDiskSizeGB": "[parameters('dataDiskSizeGB')]",
    "vmImagePublisher": "[parameters('vmImagePublisher')]",
    "vmImageOffer": "[parameters('vmImageOffer')]",
    "vmImageSku": "[parameters('vmImageSku')]",
    "vmImageVersion": "[parameters('vmImageVersion')]",
    "vmSize": "[parameters('vmSize')]",
    "vmInstanceCount": "[parameters('vmInstanceCount')]",
    "computerNamePrefix": "computerNamePrefix"
  }
}

次のステップ

Service Fabric マネージドクラスターノードタイプを自動スケーリングする

Service Fabric マネージドクラスターの構成オプション

Service Fabric マネージドクラスターにアプリをデプロイする

次の方法で共有

Service Fabric のマネージドクラスターのノードタイプ

ノードタイプの追加

ポータルで追加する

ARM テンプレートで追加する

PowerShell を使用して追加

ノードタイプを削除する

ポータルで削除する

PowerShell で削除する

ノードタイプをスケーリングする

ポータルを使用してスケーリングする

テンプレートを使用してノードタイプをスケーリングする

PowerShell でノードタイプをスケーリングする

OS の自動アップグレードを有効にする

ノードタイプの OS SKU を変更する

ポータルで OS SKU を変更する

テンプレートで OS SKU を変更する

ノードの種類の配置プロパティを構成する

ポータルで配置プロパティを構成する

テンプレートで配置プロパティを構成する

PowerShell で配置プロパティを構成する

ノードタイプの VM SKU を変更する

複数のマネージドディスクを構成する

Service Fabric データディスクのドライブ文字を構成する

コンピューター名のプレフィックスを設定する

次のステップ

フィードバック

その他のリソース

次の方法で共有

Service Fabric のマネージド クラスターのノード タイプ

ノード タイプの追加

ポータルで追加する

ARM テンプレートで追加する

PowerShell を使用して追加

ノード タイプを削除する

ポータルで削除する

PowerShell で削除する

ノード タイプをスケーリングする

ポータルを使用してスケーリングする

テンプレートを使用してノード タイプをスケーリングする

PowerShell でノード タイプをスケーリングする

OS の自動アップグレードを有効にする

ノード タイプの OS SKU を変更する

ポータルで OS SKU を変更する

テンプレートで OS SKU を変更する

ノードの種類の配置プロパティを構成する

ポータルで配置プロパティを構成する

テンプレートで配置プロパティを構成する

PowerShell で配置プロパティを構成する

ノード タイプの VM SKU を変更する

複数のマネージド ディスクを構成する

Service Fabric データ ディスクのドライブ文字を構成する

コンピューター名のプレフィックスを設定する

次のステップ

フィードバック

その他のリソース

Service Fabric のマネージドクラスターのノードタイプ

ノードタイプの追加

ノードタイプを削除する

ノードタイプをスケーリングする

テンプレートを使用してノードタイプをスケーリングする

PowerShell でノードタイプをスケーリングする

ノードタイプの OS SKU を変更する

ノードタイプの VM SKU を変更する

複数のマネージドディスクを構成する

Service Fabric データディスクのドライブ文字を構成する