モジュール用のウェブデプロイパッケージ
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
以下のセクションでは、オンプレミスでもAzureでもARMテンプレートを使ってデプロイ可能なWeb Deployパッケージ(WDP)を作成するための参照やコマンドについて説明します。
前提条件
開始前にSitecore Azure Toolkitをインストールし、コマンドレットをPowerShellセッションにロードする必要があります。必要なコマンドレットは以下のファイルで定義されています:
- tools\Sitecore.Cloud.Cmdlets.dll
- tools\Sitecore.Cloud.Cmdlets.psm1
初期WDPの生成
!警告Sitecore Azure Toolkit 2.6.0を使ってWeb Deployパッケージに変換されたアップデートパッケージは、SXPリリース10.1のみに対応しています。SXP 10.0.xバージョン以前向けのパッケージをビルドする必要がある場合は、SATバージョン2.5.1を使用してください。
SitecoreモジュールのZIPパッケージやTeam Development for Sitecore.updateパッケージを使い、以下のPowerShellコールを使ってMSDeployと互換性のある同等の.scwdp.zipパッケージに変換できます:
ConvertTo-SCModuleWebDeployPackage -Path
!注 .updateパッケージでは追加されたアイテムとファイルのみがサポートされています。
パラメータ
概要
Path
元のモジュールZIPパッケージ(またはTeam DevelopmentがSitecoreのために作成した.updateパッケージ)へのパス。
Destination
生成されたパッケージを保存したいファイルやフォルダへのパスです。
これにより、以下の内容を含む.scwdp.zipパッケージが作成されます。
内容
概要
Content/Website/*
ウェブサイトにインストールしたいファイルです。
Content/Website/App_Data/Poststeps/*.poststep
元のパッケージの後ステップ(定義されていれば)です。
core.sql
コアデータベースにアイテムをインストールするSQLスクリプトです。このファイルはパッケージがコアデータベースにアイテムをインストールする場合にのみ存在します。
master.sql
マスターデータベースにアイテムをインストールするSQLスクリプトです。このファイルはパッケージがマスターデータベースにアイテムをインストールするときのみ存在します。
.scwdp.zipパッケージは以下のパラメータを受け入れます:
パラメータ
概要
Application Path
アプリケーションをインストールするウェブサイトへのパス(IISアプリケーション名または物理的なフォルダパスを使用)です。
Core Admin Connection String
インストール時にコアデータベースに接続される接続文字列です。このパラメータは、元のパッケージがコアデータベースにアイテムをインストールするときのみ追加されます。
Master Admin Connection String
インストール時にマスターデータベースに接続される接続文字列です。このパラメータは、元のパッケージがマスターデータベースにアイテムをインストールするときのみ追加されます。
高度なシナリオ
より高度なシナリオを実行したい場合は、以下のセクション(変換の適用、 動的変換の埋め込み、パッケージへのファイルの埋め込み、パラメータの調整、複数のコマンドを連続で呼び出し、パッケージのテスト)を参照してください。例えば:
- 例えば、App InsightsやAzure Cognitive Searchの統合を有効にしたい場合は、Azureでインストールする際にデフォルトのモジュール構成を変更することができます。
- ビルドパイプラインの一部として、1つのSitecore ZIPから異なる役割や構成用の複数のWDPを生成すること。
- モジュールと一緒に新しいデータベースをインストールします。
- モジュールをインストールする際のデータベースの更新(新しいテーブルやユーザー、ロールの追加を含む)。
- パッケージのインストールをよりカスタマイズしやすくするためのパラメータを追加すること。
変換の適用
以下のシナリオで変換を適用してモジュールを構成できます:
- Azure上で非標準のモジュールをインストールしたい場合。例えば、Azure Cognitive Searchの統合を有効にしたり、パフォーマンスパラメータを調整したりするために。
- また、変換を使って単一のソースパッケージから役割固有のパッケージを作成することもできます。
!注変換はモジュールパッケージの内容にのみ適用できます。つまり、変換はモジュールが提供するファイルにのみ影響します。
以下の資料を参考にしてください:
Update-SCWebDeployPackage -CargoPayloadPath
パラメータ
概要
CargoPayloadPath
WDPに適用されるSCCPLファイルへのパスの配列です。
Path
変更したいWDPへの経路。
WhatIf
パッケージを修正せずに変換の予行実行を可能にし、実行されるアクションを生成するスイッチです。
動的変換の埋め込み
動的変換により、モジュールはモジュールがインストールされた時点でターゲットとなるSitecoreインストールを変換できます。例えば、Web.configファイルにHTTPハンドラを追加できます。
!注動的変換はモジュールパッケージの展開時にSitecore全体のインストールに適用され、既存のファイルに影響を与えることがあります。動的変換の不適切な使用は、Sitecoreインスタンスを使用不能にすることがあります。
以下の参考文献をご利用ください:
Update-SCWebDeployPackage -EmbedCargoPayloadPath
パラメータ
概要
EmbedCargoPayloadPath
WDPに埋め込むSCCPLファイルへのパスの配列です。変換はContent/Website/App_Data/Transformationsフォルダに格納され、インストール過程でブートローダーによって適用されます。
Path
変更したいWDPへの経路。
WhatIf
パッケージを修正せずに変換の予行実行を可能にし、実行されるアクションを生成するスイッチです。
パッケージへのファイルの埋め込み(.dacpacや.sqlなど)
SCCPL変換は、あらかじめ構築されたファイルセットや設定変更をWDPに追加するのに便利です。しかし、新しいデータベース用のdacpacファイルなど、個別のファイルをWDPに埋め込むことも可能です。
以下の参考文献をご利用ください:
Update-SCWebDeployPackage -SourcePath
パラメータ
概要
SourcePath
追加したいファイルを含むディレクトリへのパスです。
Path
変更したいWDPへの経路。
パラメータの調整
デプロイプロセスをカスタマイズしたい場合や、モジュールでdacpacやSQLファイルをデプロイする必要がある場合は、カスタムparameters.xmlファイルを作成してデプロイパッケージに埋め込む必要があります。また、IIS Web Applicationパッケージの参照を使ってパラメータを定義することもできます。
parameters.xmlファイルをWDPに適用すると、SATは自動的にパッケージマニフェストを再生成し、パラメータに参照したファイルを含めるようにします。つまり、parameters.xmlファイルはパッケージの内部を記述する一種のマニフェストとなります。
以下のコマンドはパラメータを追加し、マニフェストを再生成します:
Update-SCWebDeployPackage -ParametersXmlPath
パラメータ
概要
ParametersXmlPath
埋め込みたいparameters.xmlファイルへのパスです。
Path
変更したいWDPへの経路。
複数のコマンドを連続で呼び出す
また、コマンドを1行にまとめることも可能です。
$WDP = ConvertTo-SCModuleWebDeployPackage $ZIP or $Update | `Update-SCWebDeployPackage -CargoPayloadPath @($SCCPL) | `Update-SCWebDeployPackage -SourcePath $DACPAC | `Update-SCWebDeployPackage -ParametersXmlPath $Parameters
.Netを使う場合は、ConvertTo-SCModuleWebDeployPackageをdotnetに置き換え、公開し、通常通りWDPを操作してください。
パッケージのテスト
Microsoft Web Deployでは、以下のコマンドラインでローカルシステム上でパッケージのインストールをテストできます:
msdeploy -verb
-source=%CD%\test.scwdp.zip -dest=%CD%\output -setParam=TESTVALUEdacpac SQLオプションを無効化し、dacpacを更新のみモードで同期できるようにするサポート
デプロイ時にテーブルやユーザーを作成するためにDisableDacPacOptionsを使いましょう。オンプレミスインスタンスにモジュールWDPパッケージをデプロイする場合は、そのパッケージのSqlDatabaseOptionsを無効にしなければなりません。 SqlDatabaseOptionsを無効にしなければ、msDeployは含まれているデータベースを非包含データベースに変換しようとし、モジュールパッケージを展開中にこれらのオプションを適用しようとすると誤った結果が出ます。
ConvertTo-SCModuleWebDeployPackageおよびUpdate-SCWebDeployPackageで利用可能なプロパティDisableDacPacOptionsは、モジュールパッケージのSqlDatabaseOptionsを無効化する設定を可能にします。
デフォルト値は空です。これはモジュールWDPパッケージのデータベースオプションがすべての用途で同期されていることを意味しますdbdacfx。
「*」の値を入力すると、dbdacfxプロバイダーのすべての利用に対してプロバイダープロパティScriptDatabaseOptionsは「false」に設定されます。また、dbdacfxパスのリストも受け取ることがあります。
以下のコードサンプルは以下の例です:
-
すべてのユーザーdbdacFxのSqlDatabaseOptionsを無効にします。
ConvertTo-SCModuleWebDeployPackage -Path .\example.zip -Destination .\output -DisableDacPacOptions '*'
-
特定のdbdacFxパスでSqlDatabaseOptionsを無効にすること。
Update-SCWebDeployPackage -ParametersXmlPath .\parameters.xml -Path .\example.scwdp.zip -DisableDacPacOptions 'core.dacpac', 'master.dacpac'