Desired State Configuration プルサービス

[アーティクル]
06/21/2023

重要

プルサーバー (Windows Feature DSC-Service) は、Windows Server のサポート対象のコンポーネントですが、新機能がオファーされる予定はありません。新しいバージョンの DSC が一般提供され、名前付きゲスト構成の機能によって管理Azure Policy。ゲスト構成サービスでは、DSC 拡張機能と Azure Automation State Configuration の機能のほか、顧客のフィードバックで最も一般的に要求されている機能が組み合わされています。ゲスト構成にはまた、Arc 対応サーバーによるハイブリッドマシンのサポートも含まれています。

Local Configuration Manager (LCM) は、プルサービスソリューションで一元管理できます。この方法を使用する場合、管理対象のノードはサービスに登録され、LCM 設定で構成が割り当てられます。構成の依存関係として必要な構成とすべての DSC リソースは、マシンにダウンロードされ、構成を管理するために LCM によって使用されます。管理対象のマシンの状態に関する情報は、レポートのためにサービスにアップロードされます。この概念は "プルサービス" と呼ばれます。

現在選択できるプルサービスは以下のとおりです。

Azure Automation Desired State Configuration サービス
Windows Server で実行されるプルサービス
コミュニティが維持するオープンソースのソリューション
SMB 共有

各ソリューションの推奨スケールは次のとおりです。

解決策	クライアントノード
MDB/ESENT データベースを使用する Windows プルサーバー	最大 500 ノード
SQL データベースを使用する Windows プルサーバー	最大 3500 ノード
Azure Automation DSC	小規模環境と大規模環境の両方

推奨されるソリューションであり、最も多くの機能を使用できる選択肢は Azure Automation DSC です。 Automation アカウントあたりのノード数の上限は指定されていません。

Azure サービスでは、プライベートデータセンター内にあるオンプレミスノードと、パブリッククラウド（Azure や AWS など) 内にあるノードのどちらも管理できます。インターネットへのサーバーの直接接続が許可されないプライベート環境の場合は、公開されている Azure の IP 範囲 (Azure データセンターの IP 範囲に関するページを参照) のみに送信トラフィックを制限することを検討してください。

現時点で Windows Server 上のプルサービスでは利用できないオンラインサービスの機能は以下のとおりです。

転送中および保存中のすべてのデータの暗号化
クライアント証明書の自動作成および管理
パスワード/資格情報または変数 (サーバー名や接続文字列など) を一元管理するためのシークレットストア
LCM 構成ノードの一元管理
クライアントノードへ構成を一元的に割り当てる
運用環境への適用前に "カナリアグループ" へ構成の変更をリリースしてテストする
グラフィカルレポート
- きめ細かな DSC リソースレベルでの状態の詳細
- クライアントマシンからの詳細なエラーメッセージによるトラブルシューティング
Azure Log Analytics との統合によるアラートとタスクの自動化、およびレポートとアラート用の Android/iOS アプリ

Windows Server の DSC プルサービス

Windows Server 上で実行するようにプルサービスを構成することができます。 Windows Server に含まれるプルサービスソリューションには、ダウンロード用の構成とモジュールを格納する機能と、レポートデータをデータベースにキャプチャする機能のみが含まれている点に注意してください。 Azure のサービスで提供される機能の多くは含まれていないため、サービスの使用方法を評価する場合に適したツールではありません。

Windows Server で提供されるプルサービスは、OData インターフェイスを使用してターゲットノードからの要求に応じて DSC 構成ファイルをそのターゲットノードで使用できるようにする、IIS 内の Web サービスです。

プルサーバーを使用するための要件:

次のものを実行するサーバー。
- WMF/PowerShell 4.0 以降
- IIS サーバーロール
- DSC サービス
理想としては、証明書を生成する何らかの手段。これは、ターゲットノードのローカル構成マネージャー (LCM) に渡された資格情報をセキュリティ保護するためのものです。

プルサービスをホストするように Windows Server を構成するには、DSC 構成を使用する方法が最適です。スクリプトの例を以下に示します。

サポートされているデータベースシステム

WMF 4.0	WMF 5.0	WMF 5.1	WMF 5.1 (Windows Server Insider プレビュー 17090)
MDB	ESENT (既定)、MDB	ESENT (既定)、MDB	ESENT (既定)、SQL Server、MDB

Windows Server のリリース 17090 以降では、SQL Server は、プルサービス (Windows Feature DSC-Service) でサポートされるオプションです。これは、Azure Automation DSC に移行されていない大規模な DSC 環境をスケーリングする新しいオプションです。

Note

SQL Server は WMF 5.1 以前のバージョンには追加されず、17090 以降の Windows Server バージョンでのみ使用できます。

プルサーバーで SQL Server を使用するよう構成するには、SqlProvider を $true に、そして SqlConnectionString を有効な SQL Server 接続文字列に設定します。詳細については、「SqlClient 接続文字列」を参照してください。 xDscWebService を使用した SQL Server の構成例については、まず「xDscWebService リソースの使用」に目を通してから、GitHub の「2-xDscWebService_RegistrationUseSQLProvider_Config.ps1」を参照してください。

xDscWebService リソースの使用

Web プルサーバーをセットアップする最も簡単な方法は、xPSDesiredStateConfiguration モジュールに含まれる xDscWebService リソースを使用することです。次の手順では、Web サービスを設定する Configuration 内でリソースを使用する方法について説明します。

Install-Module コマンドレットを呼び出して、xPSDesiredStateConfiguration モジュールをインストールします。

Note

Install-Module は、PowerShellGet モジュールに含まれています。これは PowerShell 5.0 以降に含まれています。
DSC プルサーバーの SSL 証明書を、自社組織内またはパブリック証明機関のいずれかの信頼された証明機関から取得します。証明機関から受け取る証明書は、通常、PFX 形式です。
証明書は、DSC プルサーバーになるノードの既定の場所 (CERT:\LocalMachine\My である必要があります) にインストールします。
- 証明書の拇印をメモしておきます。
登録キーとして使う GUID を選択します。 PowerShell を使って GUID を生成するには、PS プロンプトに「[guid]::newGuid()」または「New-Guid」と入力し、Enter キーを押します。このキーは、登録時にクライアントノードによって認証のために共有キーとして使用されます。詳細については、この後の「登録キー」セクションを参照してください。

PowerShell ISE で、次の構成スクリプトを起動 (F5) します (xPSDesiredStateConfiguration モジュールのフォルダーに Sample_xDscWebServiceRegistration.ps1 として含まれています)。このスクリプトは、プルサーバーをセットアップします。

configuration Sample_xDscWebServiceRegistration
{
    param
    (
        [string[]]$NodeName = 'localhost',

        [ValidateNotNullOrEmpty()]
        [string] $certificateThumbPrint,

        [Parameter(HelpMessage='This should be a string with enough entropy (randomness)' +
            ' to protect the registration of clients to the pull server.  We will use new' +
            ' GUID by default.'
        )]
        [ValidateNotNullOrEmpty()]
        [string] $RegistrationKey   # A guid that clients use to initiate conversation with pull server
    )

    Import-DSCResource -ModuleName PSDesiredStateConfiguration
    Import-DSCResource -ModuleName xPSDesiredStateConfiguration

    Node $NodeName
    {
        WindowsFeature DSCServiceFeature
        {
            Ensure = "Present"
            Name   = "DSC-Service"
        }

        xDscWebService PSDSCPullServer
        {
            Ensure                  = "Present"
            EndpointName            = "PSDSCPullServer"
            Port                    = 8080
            PhysicalPath            = "$env:SystemDrive\inetpub\PSDSCPullServer"
            CertificateThumbPrint   = $certificateThumbPrint
            ModulePath              = "$env:PROGRAMFILES\WindowsPowerShell\DscService\Modules"
            ConfigurationPath       = "$env:PROGRAMFILES\WindowsPowerShell\DscService\Configuration"
            State                   = "Started"
            DependsOn               = "[WindowsFeature]DSCServiceFeature"
            RegistrationKeyPath     = "$env:PROGRAMFILES\WindowsPowerShell\DscService"
            AcceptSelfSignedCertificates = $true
            UseSecurityBestPractices     = $true
            Enable32BitAppOnWin64   = $false
        }

        File RegistrationKeyFile
        {
            Ensure          = 'Present'
            Type            = 'File'
            DestinationPath = "$env:ProgramFiles\WindowsPowerShell\DscService\RegistrationKeys.txt"
            Contents        = $RegistrationKey
        }
    }
}

構成を実行します。このとき、SSL 証明書の拇印を certificateThumbPrint パラメーターとして渡し、GUID 登録キーを RegistrationKey パラメーターとして渡します。

# To find the Thumbprint for an installed SSL certificate for use with the pull server list all
# certificates in your local store and then copy the thumbprint for the appropriate certificate
# by     reviewing the certificate subjects

dir Cert:\LocalMachine\my

# Then include this thumbprint when running the configuration
$sample_xDscWebServiceRegistrationSplat = @{
    certificateThumbprint = 'A7000024B753FA6FFF88E966FD6E19301FAE9CCC'
    RegistrationKey = '140a952b-b9d6-406b-b416-e0f759c9c0e4'
    OutputPath = 'C:\Configs\PullServer'
}
Sample_xDscWebServiceRegistration @sample_xDscWebServiceRegistrationSplat

# Run the compiled configuration to make the target node a DSC Pull Server
Start-DscConfiguration -Path c:\Configs\PullServer -Wait -Verbose

登録キー

サーバーにクライアントノードを登録して、構成 ID の代わりに構成名を使用できるように、上の構成で作成された登録キーは、C:\Program Files\WindowsPowerShell\DscService にある RegistrationKeys.txt という名前のファイルに保存されます。登録キーは、クライアントがプルサーバーに初期登録を行うときに共有シークレットとして機能します。登録が正常に完了すると、クライアントは、プルサーバーに一意に認証されるために使う自己署名証明書を生成します。この証明書の拇印がローカルに保存され、プルサーバーの URL に関連付けられます。

Note

登録キーは、PowerShell 4.0 ではサポートされていません。

プルサーバーで認証するようにノードを構成するには、登録キーが、このプルサーバーに登録されるすべてのターゲットノードのメタ構成に含まれている必要があります。なお、次のメタ構成にある RegistrationKey は、ターゲットコンピューターが正常に登録された後に削除され、値はプルサーバーの RegistrationKeys.txt ファイルに格納されている値と一致する必要があります (この例では '140a952b-b9d6-406b-b416-e0f759c9c0e4')。登録キー値を知ると、任意のターゲットコンピューターをプルサーバーに登録できるようになるので、登録キー値は常にセキュリティで保護してください。

[DSCLocalConfigurationManager()]
configuration Sample_MetaConfigurationToRegisterWithLessSecurePullServer
{
    param
    (
        [ValidateNotNullOrEmpty()]
        [string] $NodeName = 'localhost',

        [ValidateNotNullOrEmpty()]
        [string] $RegistrationKey, # the key used to set up pull server in previous configuration

        [ValidateNotNullOrEmpty()]
        [string] $ServerName = 'localhost' # The name of the pull server, same as $NodeName used in previous configuration
    )

    Node $NodeName
    {
        Settings
        {
            RefreshMode        = 'Pull'
        }

        ConfigurationRepositoryWeb CONTOSO-PullSrv
        {
            ServerURL          = "https://$ServerName`:8080/PSDSCPullServer.svc"
            RegistrationKey    = $RegistrationKey
            ConfigurationNames = @('ClientConfig')
        }

        ReportServerWeb CONTOSO-PullSrv
        {
            ServerURL       = "https://$ServerName`:8080/PSDSCPullServer.svc"
            RegistrationKey = $RegistrationKey
        }
    }
}

$MetaConfigurationSplat = @{
    RegistrationKey = $RegistrationKey
    OutputPath = 'c:\Configs\TargetNodes'
}

Sample_MetaConfigurationToRegisterWithLessSecurePullServer @MetaConfigurationSplat

Note

ReportServerWeb セクションでは、レポートするデータをプルサーバーに送信できるようにしています。

メタ構成ファイルに ConfigurationID プロパティがないことは、暗黙的に、そのプルサーバーが V2 バージョンのプルサーバープロトコルをサポートしていることを示すので、初期登録が必要になります。逆に、ConfigurationID が存在することは、V1 バージョンのプルサーバープロトコルが使用され、登録処理がないことを意味します。

Note

プッシュのシナリオでは、現在のリリースにバグが存在するため、プルサーバーに登録されていないノードにも、メタ構成ファイルに ConfigurationID プロパティを定義する必要があります。こうすると、V1 プルサーバープロトコルが強制されるので、登録エラーのメッセージが表示されません。

構成とリソースの配置

プルサーバーのセットアップが完了すると、プルサーバーの構成で ConfigurationPath プロパティと ModulePath のプロパティによって定義されているフォルダーは、プルするためにターゲットノードで使用可能にするモジュールと構成を配置する場所になります。これらのファイルをプルサーバーが正しく処理するためには、特定の形式である必要があります。

DSC リソースモジュールのパッケージの形式

各リソースモジュールは、圧縮し、{Module Name}_{Module Version}.zip というパターンで名前を付ける必要があります。

たとえば、モジュール名が xWebAdminstration で、バージョンが 3.1.2.0 のモジュールでは、xWebAdministration_3.1.2.0.zip という名前になります。各バージョンのモジュールを 1 つの zip ファイルに含める必要があります。各 zip ファイルには 1 つのバージョンのリソースのみが含まれるので、WMF 5.0 で追加された、単一のディレクトリに複数のモジュールバージョンを入れるモジュール形式はサポートされていません。このため、プルサーバーで使うための DSC リソースモジュールをパッケージ化する前に、ディレクトリ構造に少しの変更が必要です。 WMF 5.0 の DSC リソースを含むモジュールの既定の形式は、{Module Folder}\{Module Version}\DscResources\{DSC Resource Folder}\ です。プルサーバー用にパッケージ化する前に、パスが {Module Folder}\DscResources\{DSC Resource Folder}\ になるように {Module version} フォルダーを削除します。この変更を加えた後、上で説明したようにフォルダーを zip 圧縮し、これらの zip ファイルを ModulePath フォルダーに置きます。

新しく追加したモジュールのチェックサムファイルを作成するには、New-DscChecksum {module zip file} を使用します。

構成 MOF の形式

ターゲットノード上の LCM が構成を検証できるように、構成 MOF ファイルはチェックサムファイルと組み合わせて使用する必要があります。チェックサムを作成するには、New-DscChecksum コマンドレットを呼び出します。このコマンドレットは、構成 MOF が存在するフォルダーが指定された Path パラメーターを受け取ります。このコマンドレットは、ConfigurationMOFName.mof.checksum という名前でチェックサムファイルを作成します。ここで、ConfigurationMOFName は構成 MOF ファイルの名前です。指定のフォルダーに複数の構成 MOF ファイルがある場合は、そのフォルダー内の構成ごとにチェックサムが作成されます。 MOF ファイルと、それに関連するチェックサムファイルは、ConfigurationPath フォルダーに配置します。

Note

何らかの方法で構成 MOF ファイルを変更した場合は、チェックサムファイルも作成し直す必要があります。

ツール

プルサーバーのセットアップ、検証、管理を簡素化するために、次のツールが、xPSDesiredStateConfiguration モジュールの最新バージョンに例として含まれています。

プルサーバーに使用する DSC リソースモジュールおよび構成ファイルをパッケージ化するために役立つモジュール。 PublishModulesAndMofsToPullServer.psm1。次の例です。

# Example 1 - Package all versions of given modules installed locally and MOF files are in c:\LocalDepot
$moduleList = @('xWebAdministration', 'xPhp')
Publish-DSCModuleAndMof -Source C:\LocalDepot -ModuleNameList $moduleList

# Example 2 - Package modules and mof documents from c:\LocalDepot
Publish-DSCModuleAndMof -Source C:\LocalDepot -Force

プルサーバーが正しく構成されていることを検証するスクリプト。 PullServerSetupTests.ps1。

プルサービスのコミュニティソリューション

DSC コミュニティは、プルサービスプロトコルを実装するための複数のソリューションを作成しています。これらはオンプレミス環境向けに、プルサービス機能と、段階的な機能強化でコミュニティに貢献する機会を提供します。

プルクライアントの構成

次のトピックでは、プルクライアントのセットアップについて詳しく説明します。

次の方法で共有

Desired State Configuration プルサービス

Windows Server の DSC プルサービス

サポートされているデータベースシステム

xDscWebService リソースの使用

登録キー

構成とリソースの配置

DSC リソースモジュールのパッケージの形式

構成 MOF の形式

ツール

プルサービスのコミュニティソリューション

プルクライアントの構成

関連項目

その他のリソース

次の方法で共有

Desired State Configuration プル サービス

Windows Server の DSC プル サービス

サポートされているデータベース システム

xDscWebService リソースの使用

登録キー

構成とリソースの配置

DSC リソース モジュールのパッケージの形式

構成 MOF の形式

ツール

プル サービスのコミュニティ ソリューション

プル クライアントの構成

関連項目

その他のリソース

Desired State Configuration プルサービス

Windows Server の DSC プルサービス

サポートされているデータベースシステム

DSC リソースモジュールのパッケージの形式

プルサービスのコミュニティソリューション

プルクライアントの構成