Sitecore Azureツールキットの始め方

Sitecore Azureツールキットを使ってSitecoreをAzureにデプロイする

以下は、Sitecore Azureツールキット(SAT)を使ってSitecoreをAzureに展開するプロセスの概要です。

• まず、Sitecore Azureツールキットを使ってWeb Deployパッケージ(WDP)をダウンロード または作成できます。WDPにはSitecore展開に必要なアプリケーションコードとリソース、必要に応じて関連モジュールが含まれています。パッケージングプロセス中、WDPの内容は展開時に正しく動作するように変換されますAzure。これらの変換は、パッケージングプロセス中にSATが参照するSitecore Cargo Payload(SCCPL)パッケージによって定義されます。
• パッケージを取得した後、Azureリソースマネージャーのテンプレート(ARMテンプレート)を準備します。これらのテンプレートはAzureリソースマネージャーにリソースをAzureにデプロイするよう指示します。これにはインフラ(Webアプリなど)とアプリケーション(WDP)の両方が含まれます。Sitecoreはデフォルトのテンプレートを提供しており、準備するには適切なテンプレートを選び、必要な展開を正しく設定するためのパラメータをテンプレートに割り当てる必要があります。
• WDPとテンプレートを準備できれば、SATの1つのコマンドで必要なインフラやSitecoreアプリケーションをすべてAzureにデプロイできます。

Sitecore Azure Toolkitはインフラストラクチャ(ARMテンプレート経由)とアプリケーション(WDP)を単一の操作として同時に展開します。Sitecore Azure Toolkitは既存のAzureインフラにWebデプロイパッケージを独立して展開するサポートはしません。既にプロビジョニングされているリソースにアプリケーションアップデートをデプロイする必要がある場合は、以下のいずれかを行う必要があります。

• Sitecore Azure Toolkitのフルデプロイを再実行してください。これにより、既存のリソースを再作成するのではなく更新されます。これはARMテンプレートの設定によって異なります。
• Azure DevOps パイプラインやGitHub Actionsのようなカスタム展開プロセスを使って、WDPのデプロイメントを別途処理してください。

前提条件

Sitecore Azureツールキットを使用するには、以下のものを必ず備えてください。

• .NET Framework 4.8以降

• PowerShell 5.1

• Microsoft Azure PowerShell ® 2.0.1以降です。インストールされたバージョンを確認するには、PowerShellを開き、以下のコマンドを実行します。

  Get-InstalledModule -Name AZ -AllVersions

  Microsoft Azure PowerShell ®をインストールするには、インストールAzure PowerShellページの指示に従ってください。

  !注すでにAzureRMモジュールをインストールしている場合は、AZモジュールをインストールする前にこれをアンインストールしてください。

• Microsoft SQL Server 2012年以降のサーバー向けデータティアアプリケーションフレームワーク(DacFX)SQL

  !注通常、このフレームワークはMicrosoft SQL Server ®またはMicrosoft Visual Studio ®と一緒にインストールします。MicrosoftダウンロードセンターからDAC FXをダウンロードすることも可能です。DacFXはWeb Deploy 3.6 Microsoft Web Platform Installerを使ってインストールされています。一部のソフトウェア構成ではSitecore Azure Toolkitが適切なDacFxのバージョンを自動的に読み込めない場合があります。

• 展開のためのAzureサブスクリプション。Microsoft Azureのウェブサイトで無料トライアルアカウントに登録できます。

• Sitecore WebDeployパッケージ用のクラウドホストストレージ。この目的にはAzureストレージアカウントを使用できます。

Sitecore Azureツールキットのダウンロード

dev.sitecore.netからSitecore Azureツールキットをダウンロードでき、Azure App Serviceへのソリューションパッケージ化や展開に必要なツールも見つけることができます。

!注Sitecore Azure Toolkitをダウンロードすると、そのzipファイルはWindowsによってブロックされているとマークされるMicrosoft、したがってzipファイルのブロックを解除する必要があります。Windowsエクスプローラーでファイルを右クリックし、プロパティをクリックします。次にプロパティダイアログの一般タブで「アンブロック」をクリックします。

また、Sitecoreソリューションをパッケージ化するにはリソースのダウンロードも必要です。これらのリソースをダウンロードするには:

1. dev.sitecore.net では、該当するSitecoreのバージョンのページに移動します。
2. 「AppService Sitecore Azure Toolkit Resourcesのダウンロードオプション」というセクションAzureスクロールしてください

以下のリソースは別途配布されています:

• Sitecore Experience Platformダウンロードページにある、異なる環境での役割Sitecoreための事前構築されたWebDeployパッケージ。 
• Github上のAzureリソースマネージャー(ARM)プロビジョニングテンプレートおよび関連パラメータファイル。

Sitecore Azureツールキットのインストール

Sitecore Azure Toolkitは、ハードドライブのフォルダにアンパックできるZIPパッケージです。アンパックすると、ToolkitパッケージSitecore Azure以下のファイルとフォルダを作成します:

• Toolsフォルダ – コマンドレットMicrosoft PowerShell必要な補助ライブラリ。
  • Sitecore。Cloud.Cmdlets.psm1 および Sitecore.Cloud.Cmdlets.dll – 必要なコマンドレットを含む主要なモジュールです。
• トップレベルファイルとCopyrightsフォルダー(READMEおよびライセンス情報)があります。

メインモジュールをPowerShellセッションに読み込むには、ツールキットが解凍されているフォルダで以下のコマンドを実行します。

Import-Module .\tools\Sitecore.Cloud.Cmdlets.psm1 -Verbose Import-Module .\tools\Sitecore.Cloud.Cmdlets.dll -Verbose

これらのコマンドはコマンドレットをPowerShellセッションに読み込みます。コマンドレットはSitecore Azureツールキットの機能へのインターフェースを提供します。例えば:

• Start-SitecoreAzurePackaging– SitecoreソリューションをWDP(s)にパッケージ化し、展開の準備を整えます。
• Start-SitecoreAzureModulePackaging– SitecoreモジュールをWDP(s)にパッケージ化し、展開の準備が整います。
• Start-SitecoreAzureDeployment– 必要なリソースインフラをすべて含むAzureへのSitecore展開を開始します。

Sitecore Azure Toolkit Resources {Sitecore version} rev. {revision} zipパッケージには、特定のSitecoreバージョン固有のリソースが含まれており、以下が含まれます:

• CargoPayloads役割固有および機能固有の変換パッケージ。これらはSitecore貨物ペイロードパッケージ(SCCPL)とも呼ばれます。
• MsDeployXmls: パラメータファイルはWebDeployパッケージの中に含まれます。
• Configs
  。
• Addons
  (WDP)を用意しています。
  • Sitecore.Cloud.Integration.Bootload.wdp.zip: ブートローダーモジュールは、サポートされたSitecoreモジュールのインストールを容易にするための小さなモジュールです。

Sitecore.Cloud.Integration.Bootload.wdp.zipファイルをAddonsフォルダに入れる必要があります。

Azure Resource Manager templates

ARMテンプレートはGithub上にあり、App Service上でホストされているSitecore環境の説明Microsoft Azure提供しています。テンプレートには以下のリソースの定義が含まれています:

• Sitecoreインスタンスのホスティング計画。
• コンテンツと報告のためのデータベースMicrosoft Azure SQL。
• セッション状態用のRedis Cacheサービス。
• 診断のためのMicrosoft Application Insights®。
• Microsoft Azure コンテンツ検索および連絡先セグメンテーションインデックスのための認知Search。

テンプレートは、対応するSitecoreバージョンのWebDeployパッケージやdev.sitecore.net Sitecore Azure Toolkitで作成されたものと互換性があります。テンプレートの構造と構成は入れ子状です。メインテンプレートはインフラストラクチャテンプレートとアプリケーションテンプレートを参照しています。デプロイの責任は、リソースを設定するテンプレートとSitecoreアプリケーションをインストールするテンプレートにそれぞれ分かれています。

ウェブ展開パッケージ

既製のWDPはSitecore Experience Platformダウンロードページにあります。WDPは単一の.zipファイルにまとめられ、バージョンやトポロジーごとにグループ化されています。WDPをダウンロードした後、Sitecore Azure Toolkitが使用する前に.zipファイルから解凍しなければなりません。 

Sitecore提供のWeb Deployパッケージ(SCWDP)はSitecore Azureツールキットでの使用を想定して構成されています。これらは標準Microsoft的なWeb Deployパッケージではなく、MicrosoftのWeb Deploy(MSDeploy)ツールだけでは追加の操作なしに展開できません。Sitecore提供のパッケージを使ってSitecoreをAzure PaaSに展開するには、Sitecore Azure Toolkitを使用するか、Sitecore Azure Toolkitが行う変換を再現するカスタムCI/CDパイプラインを実装する必要があります。

本番環境で使用されるトポロジーサイズの各ロールは、それぞれ独自のWDP内に含まれています。例えば、Content Deliveryロール用のWDP、Content Managementロール用のWDPなどが存在します。唯一の例外は、開発やテスト目的で設計された単一のトポロジーの場合です。これらのトポロジーでは、複数のロールを1つのWDPにまとめて、単一の共有リソースにデプロイすることができます。

Sitecoreは、パッケージングプロセス中にAzure上で動作するように修正された標準のSitecore展開パッケージからWDPを作成します。これらのWDPは標準的なSitecoreのオリジナル展開に使用してください。

!注適切な設定変更により、Sitecore Azure Toolkitはユーザーが独自のカスタムSitecore展開をWDPにパッケージ化し、Azure上で動作させることも可能にします。このプロセスの仕組みの詳細はパッケージングトピックでご覧いただけます。

Sitecore Azureツールキットの利用

Sitecore Azureツールキットを使って以下の作業を行います。

• Microsoft Azure App ServiceのSitecoreソリューションをパッケージ化する
• Microsoft Azure App Serviceに新しいSitecore環境を展開する