Service Fabric 用の Azure Files ボリュームドライバー

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

Azure Files ボリュームドライバーは、Docker コンテナーに Azure Files ベースのボリュームを提供する Docker ボリュームプラグインです。これは Service Fabric アプリケーションとしてパッケージ化されており、Service Fabric クラスターにデプロイして、クラスター内の他の Service Fabric コンテナーアプリケーションにボリュームを提供できます。

Note

Azure Files ボリュームプラグインのバージョン 6.5.661.9590 が一般公開されています。

前提条件

Windows バージョンの Azure Files ボリュームプラグインは、Windows Server バージョン 1709、Windows 10 バージョン 1709 以降のオペレーティングシステムでのみ動作します。
Linux バージョンの Azure Files ボリュームプラグインは、Service Fabric でサポートされているすべてのオペレーティングシステムのバージョンで動作します。
Azure Files ボリュームプラグインは、Service Fabric バージョン 6.2 以降でのみ機能します。
Azure Files ドキュメントの指示に従って、Service Fabric コンテナーアプリケーションがボリュームとして使用するファイル共有を作成します。
PowerShell と Service Fabric モジュールまたは SFCTL をインストールしている必要があります。
Hyper-V コンテナーを使用している場合は、Azure Resource Manager テンプレート (Azure クラスター) または ClusterConfig.json (スタンドアロンクラスター) の ClusterManifest (ローカルクラスター) セクションまたは fabricSettings セクションに、次のスニペットを追加する必要があります。

ClusterManifest では、Hosting セクションに次のコードを追加する必要があります。この例では、ボリューム名は sfazurefile、そのボリュームがクラスター上でリッスンするポートは 19100 です。これらは、クラスターの正しい値で置き換えてください。

<Section Name="Hosting">
  <Parameter Name="VolumePluginPorts" Value="sfazurefile:19100" />
</Section>

Azure Resource Manager テンプレート (Azure デプロイの場合) または ClusterConfig.json (スタンドアロンデプロイの場合) の fabricSettings セクションに、次のスニペットを追加する必要があります。ここでも、ボリューム名とポート値を独自の値で置き換えます。

"fabricSettings": [
  {
    "name": "Hosting",
    "parameters": [
      {
          "name": "VolumePluginPorts",
          "value": "sfazurefile:19100"
      }
    ]
  }
]

Service Fabric Azure Files ボリュームドライバーを使用してサンプルアプリケーションをデプロイする

提供された PowerShell スクリプトを介した Azure Resource Manager の使用 (推奨)

クラスターが Azure ベースの場合は、Azure Resource Manager アプリケーションリソースモデルを使用して、Azure にアプリケーションをデプロイすることをお勧めします。その方が使いやすいし、インフラストラクチャをコードとして維持するモデルに移行しやすくなるためです。この方法であれば、Azure Files ボリュームドライバーのアプリバージョンを追跡する必要がなくなります。また、サポートされている OS ごとに個別の Azure Resource Manager テンプレートを維持することもできます。このスクリプトは、Azure Files アプリケーションの最新バージョンをデプロイすることを前提としており、OS の種類、クラスターサブスクリプション ID、リソースグループのパラメーターを受け取ります。このスクリプトは、Service Fabric のダウンロードサイトからダウンロードできます。このスクリプトにより、自動的に ListenPort が 19100 に設定されます。この値は、Azure Files ボリュームプラグインが、Docker デーモンからの要求をリッスンするポートです。 "listenPort" という名前のパラメーターを追加することによって、これを変更することができます。そのポートが、クラスターまたはアプリケーションで使用する他のどのポートとも競合しないことを確認します。

Windows 用の Azure Resource Manager デプロイコマンドは次のとおりです。

.\DeployAzureFilesVolumeDriver.ps1 -subscriptionId [subscriptionId] -resourceGroupName [resourceGroupName] -clusterName [clusterName] -windows

Linux 用の Azure Resource Manager デプロイコマンドは次のとおりです。

.\DeployAzureFilesVolumeDriver.ps1 -subscriptionId [subscriptionId] -resourceGroupName [resourceGroupName] -clusterName [clusterName] -linux

スクリプトが正常に実行されたら、アプリケーションの構成に関するセクションに進むことができます。

スタンドアロンクラスターの手動デプロイ

コンテナーにボリュームを提供する Service Fabric アプリケーションは、Service Fabric のダウンロードサイトからダウンロードできます。アプリケーションは、PowerShell、CLI、または FabricClient API を使用して、クラスターにデプロイできます。

コマンドラインを使用して、ダウンロードされたアプリケーションパッケージのルートディレクトリにディレクトリを変更します。
```
cd .\AzureFilesVolume\
```
```
cd ~/AzureFilesVolume
```

次に、アプリケーションパッケージをイメージストアにコピーし、[ApplicationPackagePath] と [ImageStoreConnectionString] に適切な値を指定します。

Copy-ServiceFabricApplicationPackage -ApplicationPackagePath [ApplicationPackagePath] -ImageStoreConnectionString [ImageStoreConnectionString] -ApplicationPackagePathInImageStore AzureFilesVolumePlugin

sfctl cluster select --endpoint https://testcluster.westus.cloudapp.azure.com:19080 --pem test.pem --no-verify
sfctl application upload --path [ApplicationPackagePath] --show-progress

アプリケーションの種類を登録する

Register-ServiceFabricApplicationType -ApplicationPathInImageStore AzureFilesVolumePlugin

sfctl application provision --application-type-build-path [ApplicationPackagePath]

ListenPort アプリケーションパラメーター値に注意して、アプリケーションを作成します。この値は、Azure Files ボリュームプラグインが、Docker デーモンからの要求をリッスンするポートです。アプリケーションに提供されるポートは、ClusterManifest 内の VolumePluginPorts と一致していて、クラスターまたはご自分のアプリケーションで使用する他のどのポートとも競合していないことを確認する必要があります。
```
New-ServiceFabricApplication -ApplicationName fabric:/AzureFilesVolumePluginApp -ApplicationTypeName AzureFilesVolumePluginType -ApplicationTypeVersion 6.5.661.9590   -ApplicationParameter @{ListenPort='19100'}
```
```
sfctl application create --app-name fabric:/AzureFilesVolumePluginApp --app-type AzureFilesVolumePluginType --app-version 6.5.661.9590  --parameter '{"ListenPort":"19100"}'
```

Note

Windows Server 2016 Datacenter は、SMB マウントのコンテナーへのマッピングをサポートしていません (Windows Server バージョン 1709 でのみサポートされています)。この制約があるため、1709 より古いバージョンでは、ネットワークボリュームのマッピングと Azure Files ボリュームドライバーを使用できません。

ローカル開発クラスターにアプリケーションをデプロイする

上記の手順 1. から 3. に従います。

Azure Files ボリュームプラグインアプリケーションの既定のサービスインスタンス数は、-1 です。これは、クラスター内の各ノードにデプロイされたサービスのインスタンスがあることを意味します。ただし、ローカル開発クラスターに Azure Files ボリュームプラグインアプリケーションをデプロイする場合は、サービスインスタンス数を 1 と指定する必要があります。これは、InstanceCount アプリケーションパラメーターを使用して実行できます。したがって、ローカル開発クラスターに Azure Files ボリュームプラグインアプリケーションを作成するコマンドは、次のようになります。

New-ServiceFabricApplication -ApplicationName fabric:/AzureFilesVolumePluginApp -ApplicationTypeName AzureFilesVolumePluginType -ApplicationTypeVersion 6.5.661.9590  -ApplicationParameter @{ListenPort='19100';InstanceCount='1'}

sfctl application create --app-name fabric:/AzureFilesVolumePluginApp --app-type AzureFilesVolumePluginType --app-version 6.5.661.9590  --parameter '{"ListenPort": "19100","InstanceCount": "1"}'

ボリュームを使用するようにアプリケーションを構成する

次のスニペットは、アプリケーションのアプリケーションマニフェストファイルに、Azure Files ベースのボリュームを指定する方法を示しています。興味のある特定の要素は、Volume タグです。

?xml version="1.0" encoding="UTF-8"?>
<ApplicationManifest ApplicationTypeName="WinNodeJsApp" ApplicationTypeVersion="1.0" xmlns="http://schemas.microsoft.com/2011/01/fabric" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
    <Description>Calculator Application</Description>
    <Parameters>
      <Parameter Name="ServiceInstanceCount" DefaultValue="3"></Parameter>
      <Parameter Name="MyCpuShares" DefaultValue="3"></Parameter>
      <Parameter Name="MyStorageVar" DefaultValue="c:\tmp"></Parameter>
    </Parameters>
    <ServiceManifestImport>
        <ServiceManifestRef ServiceManifestName="NodeServicePackage" ServiceManifestVersion="1.0"/>
     <Policies>
       <ContainerHostPolicies CodePackageRef="NodeService.Code" Isolation="hyperv">
            <PortBinding ContainerPort="8905" EndpointRef="Endpoint1"/>
            <RepositoryCredentials PasswordEncrypted="false" Password="****" AccountName="test"/>
            <Volume Source="azfiles" Destination="c:\VolumeTest\Data" Driver="sfazurefile">
                <DriverOption Name="shareName" Value="" />
                <DriverOption Name="storageAccountName" Value="" />
                <DriverOption Name="storageAccountKey" Value="" />
                <DriverOption Name="storageAccountFQDN" Value="" />
            </Volume>
       </ContainerHostPolicies>
   </Policies>
    </ServiceManifestImport>
    <ServiceTemplates>
        <StatelessService ServiceTypeName="StatelessNodeService" InstanceCount="5">
            <SingletonPartition></SingletonPartition>
        </StatelessService>
    </ServiceTemplates>
</ApplicationManifest>

Azure Files ボリュームプラグインのドライバー名は sfazurefile です。この値を、アプリケーションマニフェストの Volume タグ要素の Driver 属性に設定します。

上記のスニペットの Volume タグでは、Azure Files ボリュームプラグインに次の属性が必要です。

Source - ボリュームの名前です。ユーザーは、ボリュームの名前として任意の名前を選択できます。
Destination - この属性は、実行中のコンテナー内でボリュームがマップされている場所です。そのため、Destination としてコンテナー内の既存の場所を指定することはできません

上記スニペットの DriverOption 要素に示すように、Azure Files ボリュームプラグインは、次のドライバーオプションをサポートしています。

shareName - コンテナーのボリュームを提供する Azure Files ファイル共有の名前。
storageAccountName - Azure Files ファイル共有を含む Azure Storage アカウントの名前。
storageAccountKey - Azure Files ファイル共有を含む Azure Storage アカウントのアクセスキー。

storageAccountFQDN - ストレージアカウントに関連付けられたドメイン名。 storageAccountFQDN が指定されない場合、ドメイン名は既定のサフィックス (.file.core.windows.net) と storageAccountName を使用して形成されます。

- Example1: 
    <DriverOption Name="shareName" Value="myshare1" />
    <DriverOption Name="storageAccountName" Value="myaccount1" />
    <DriverOption Name="storageAccountKey" Value="mykey1" />
    <!-- storageAccountFQDN will be "myaccount1.file.core.windows.net" -->
- Example2: 
    <DriverOption Name="shareName" Value="myshare2" />
    <DriverOption Name="storageAccountName" Value="myaccount2" />
    <DriverOption Name="storageAccountKey" Value="mykey2" />
    <DriverOption Name="storageAccountFQDN" Value="myaccount2.file.core.chinacloudapi.cn" />

独自のボリュームまたはログドライバーの使用

Service Fabric では、独自のカスタムボリュームまたはログドライバーを使用することもできます。 Docker ボリューム/ログドライバーがクラスターにインストールされていない場合は、RDP/SSH プロトコルを使って手動でインストールできます。これらのプロトコルによるインストールは、仮想マシンスケールセットスタートアップスクリプトまたは SetupEntryPoint スクリプトを使って実行できます。

Azure 用 Docker ボリュームドライバーをインストールするスクリプトの例を次に示します。

docker plugin install --alias azure --grant-all-permissions docker4x/cloudstor:17.09.0-ce-azure1  \
    CLOUD_PLATFORM=AZURE \
    AZURE_STORAGE_ACCOUNT="[MY-STORAGE-ACCOUNT-NAME]" \
    AZURE_STORAGE_ACCOUNT_KEY="[MY-STORAGE-ACCOUNT-KEY]" \
    DEBUG=1

アプリケーションで、インストールしたボリュームまたはログドライバーを使用するには、アプリケーションマニフェストの ContainerHostPolicies の下にある Volume 要素と LogConfig 要素に適切な値を指定する必要があります。

<ContainerHostPolicies CodePackageRef="NodeService.Code" Isolation="hyperv">
    <PortBinding ContainerPort="8905" EndpointRef="Endpoint1"/>
    <RepositoryCredentials PasswordEncrypted="false" Password="****" AccountName="test"/>
    <LogConfig Driver="[YOUR_LOG_DRIVER]" >
        <DriverOption Name="test" Value="vale"/>
    </LogConfig>
    <Volume Source="c:\workspace" Destination="c:\testmountlocation1" IsReadOnly="false"></Volume>
    <Volume Source="[MyStorageVar]" Destination="c:\testmountlocation2" IsReadOnly="true"> </Volume>
    <Volume Source="myvolume1" Destination="c:\testmountlocation2" Driver="[YOUR_VOLUME_DRIVER]" IsReadOnly="true">
        <DriverOption Name="[name]" Value="[value]"/>
    </Volume>
</ContainerHostPolicies>

ボリュームプラグインを指定すると、Service Fabric は指定されたパラメーターを使って自動的にボリュームを作成します。 Volume 要素の Source タグはボリュームの名前を示し、Driver タグはボリュームのドライバープラグインを指定します。 Destination タグは、実行中のコンテナー内で Source がマップされている場所です。そのため、Destination としてコンテナー内の既存の場所を指定することはできません。次のように、DriverOption タグを使ってオプションを指定できます。

<Volume Source="myvolume1" Destination="c:\testmountlocation4" Driver="azure" IsReadOnly="true">
           <DriverOption Name="share" Value="models"/>
</Volume>

前述のマニフェストスニペットに示したように、ボリュームに関してはアプリケーションのパラメーターがサポートされます (使用例については MyStorageVar を探してください)。

Docker ログドライバーを指定する場合は、クラスター内のログを処理するエージェント (またはコンテナー) をデプロイする必要があります。 DriverOption タグを使って、ログドライバーのオプションを指定できます。

次のステップ

ボリュームドライバーを含むコンテナーのサンプルを参照するには、Service Fabric コンテナーのサンプルをご覧ください
Service Fabric クラスターにコンテナーをデプロイする方法については、Service Fabric へのコンテナーのデプロイに関する記事をご覧ください

次の方法で共有

Service Fabric 用の Azure Files ボリュームドライバー

前提条件

Service Fabric Azure Files ボリュームドライバーを使用してサンプルアプリケーションをデプロイする

提供された PowerShell スクリプトを介した Azure Resource Manager の使用 (推奨)

スタンドアロンクラスターの手動デプロイ

ローカル開発クラスターにアプリケーションをデプロイする

ボリュームを使用するようにアプリケーションを構成する

独自のボリュームまたはログドライバーの使用

次のステップ

フィードバック

その他のリソース

次の方法で共有

Service Fabric 用の Azure Files ボリューム ドライバー

前提条件

Service Fabric Azure Files ボリューム ドライバーを使用してサンプル アプリケーションをデプロイする

提供された PowerShell スクリプトを介した Azure Resource Manager の使用 (推奨)

スタンドアロン クラスターの手動デプロイ

ローカル開発クラスターにアプリケーションをデプロイする

ボリュームを使用するようにアプリケーションを構成する

独自のボリュームまたはログ ドライバーの使用

次のステップ

フィードバック

その他のリソース

Service Fabric 用の Azure Files ボリュームドライバー

Service Fabric Azure Files ボリュームドライバーを使用してサンプルアプリケーションをデプロイする

スタンドアロンクラスターの手動デプロイ

独自のボリュームまたはログドライバーの使用