Sitecore CommerceコンテナSDK
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore Commerce Container SDKは、コンテナ化されたコマース ソリューションを使用するための出発点を開発者に提供します。
SDKパッケージには、Dockerファイル、環境変数ファイル、Docker Compose YAMLファイル、Kubernetes YAMLファイル、サンプル スクリプトなどのリソースが含まれており、これらを使用して次の操作を行うことができます。
-
コンテナを使用して、Sitecore XCを開発者ワークステーションにインストールします。
-
Sitecore Experience Commerce (XC) コンテナをAzure Kubernetes Serviceにデプロイします。
Sitecore.Commerce.Container.SDK.*.ZIPパッケージとサポートのインストール ガイドは、SitecoreのダウンロードWebサイトで入手できます。
Sitecore Commerce Container SDKの構造
Sitecore.Commerce.Container.SDK.*.ZIPパッケージは複数のフォルダーに分割されており、特定のトポロジにSitecore XCをデプロイするために必要なアーティファクトが含まれているものもあれば、複数の設定で共有される共通ファイルが含まれているフォルダーもあります。
最上位レベルでは、Sitecore.Commerce.Container.*.ZIPパッケージには次のフォルダーが含まれています。
|
フォルダ名 |
形容 |
|---|---|
|
k8s-commerce-xc1 |
Kubernetes XC1デプロイメント・トポロジーに必要なファイルが含まれています。 |
|
postman |
DockerまたはKubernetesで実行されるCommerceデプロイで使用するPostman環境ファイル (JSON形式) のサンプル セットが含まれています。 |
|
scripts |
例として提供される一連のサポート スクリプトとJSONファイルが含まれており、Dockerを使用してSitecore Experience Commerceコンテナー イメージを簡単に作成できます。 また、各スクリプトの目的を説明するREADMEファイルも含まれています。 |
|
xc0 |
Commerce Engineのデプロイのみを目的として、XC0トポロジでSitecore XCインスタンスをビルドおよび実行するために使用されるファイルが含まれています。 メモ 開発者ワークステーションのXC0トポロジには、SXAストアフロントまたはサポート モジュールのコンテナ イメージは含まれていません。 SXAストアフロントをサポートするために必要なモジュールを含むデプロイメントでは、XC1-CXAトポロジをインストールする必要があります。 |
|
xc1 |
Sitecore XC1トポロジ イメージのビルドに使用されるファイルが含まれています。XC1トポロジは、SXA Storefrontをサポートするモジュールを除外するスケーリングされた展開用です。このトポロジは、SXA Storefrontを使用しない、スケーリングされたCommerce Engineのみのデプロイで使用します。 手記 Sitecore Commerce Container SDKには、XC1トポロジのコンテナ イメージをデプロイするために必要なすべてのDocker Compose YAMLファイルが含まれているわけではありません。 |
|
xc1-cxa |
XC1トポロジでSitecore XCインスタンスをビルドして実行するために必要なファイルが含まれています。このデプロイ トポロジには、SXA Storefrontが含まれます。 |
|
xc-common |
一般的なSitecore XCイメージをビルドするために必要なファイルが含まれています。 手記 共通のイメージは、すべてのSitecore XCトポロジで使用されます。 |
|
xc-resources |
他のSitecore XCイメージをビルドするときに使用される基本リソースが含まれています。 |
xc-resourcesフォルダ
xc-resourcesフォルダには、すべての基本設定、変換、スクリプト、および一般的なツールが含まれています。xc-resourcesイメージはローカルでビルドし、他のSitecore XCコンテナ イメージが提供する基本リソースを消費できるように、常に最初にビルドする必要があります。
次に、xc-resourcesフォルダ構造の例を示します。
xc-commonフォルダ
xc-commonフォルダーには、SDKに含まれるすべてのデフォルトのデプロイメント トポロジに共通するSitecore XCイメージをビルドするために必要なすべてのファイルが含まれています。
次に、xc-commonフォルダ構造の例を示します。
serviceフォルダ
service各フォルダ:
-
コンテナを表します
-
少なくともDockerfileが含まれています。
-
Docker Composeファイル内の対応するサービスのDockerビルド コンテキストとして使用されます。
Docker composeビルドYAMLファイル
docker-compose.build.ymlファイルは、XC0とXC1の両方のデプロイメントトポロジで使用される次のサービスのイメージビルドを定義します。
このフォルダ内のイメージは、xc0 、xc1、およびxc1-cxaフォルダにあるイメージの前にビルドする必要があります。
-
id
-
bizfx
-
engine
xc0フォルダ
xc0フォルダーには、Sitecore XC0トポロジ イメージのビルドと実行に必要なすべてのファイルが含まれています。
次に、xc0フォルダ構造の例を示します。
serviceフォルダ
service各フォルダ:
-
コンテナを表します。
-
Docker Composeファイル内の対応するサービスのDockerビルド コンテキストとして使用されます。
docker compose build YAMLファイル
docker-compose.build.ymlファイルは、次のサービス用にビルドされたイメージを定義します。
-
mssql non-production
-
solr non-production
-
cm
-
xconnect
-
xdbsearchworker
-
xdbautomationworker
このdocker-compose.ymlには、XC0インスタンスに必要なすべてのコンテナに関する情報が含まれています。
xc1フォルダ
xc1フォルダには、XC1トポロジ イメージのビルドに必要なすべてのファイルが含まれています。
次に、xc1フォルダ構造の例を示します。
serviceフォルダ
service各フォルダ:
-
コンテナを表します。
-
Docker Composeファイル内の対応するサービスのDockerビルド コンテキストとして使用されます。
docker compose build YAMLファイル
docker-compose.build.ymlファイルは、次のサービス用にビルドされたイメージを定義します。
このフォルダ内の画像は、xc1-cxa フォルダに含まれる画像よりも先にビルドする必要があります。
-
mssql non-production
-
mssql-init
-
solr non-production
-
solr-init
-
rep
-
xdbcollection
-
prc
-
cm
-
cd
-
xdbsearch
-
xdbsearchworker
-
xdbautomation
-
xdbautomationworker
xc1-cxaフォルダ
xc1-cxaフォルダーには、SXAストアフロントを含むXC1トポロジ イメージのビルドと実行に必要なすべてのファイルが含まれています。
次に、xc1-cxaフォルダ構造の例を示します。
serviceフォルダ
xc1-cxaフォルダ内には、service各フォルダがあります。
-
コンテナを表します。
-
少なくともDockerfileが含まれています。
-
Docker Composeファイル内の対応するサービスのDockerビルド コンテキストとして使用されます。
CommerceビルドYAMLファイル
commerce.build.ymlファイルは、次のサービス用にビルドされたコマース イメージを定義します。
docker compose build YAMLファイル
docker-compose.build.ymlファイルは、次のサービス用にビルドされたイメージを定義します。
-
mssql non-production
-
mssql-init
-
solr non-production
-
solr-init
-
cd
-
cm
手記cmイメージとcdイメージには、Sitecore PowerShell Extensions (SPE) とSitecore Experience Accelerator (SXA) が含まれます
docker compose YAMLファイル
docker-compose.ymlファイルには、XC1インスタンスに必要なすべてのコンテナに関する情報が含まれています。
Scriptsフォルダ
このscriptsフォルダーには、Dockerを使用したSitecore Experience Commerceコンテナー イメージの作成を容易にする一連のサポート スクリプトとJSONファイルが含まれています。
次の表に、scriptsフォルダの内容をリストし、簡単に説明します。
詳細については、scriptフォルダに含まれるreadme.mdファイルを参照してください。スクリプトファイル自体にも、追加情報とガイダンスがコメントされています。
|
ファイル |
形容 |
|---|---|
|
CleanContainerCache.ps1 |
Dockerコンテナイメージのキャッシュをクリーンアップするために使用されるスクリプト。コンテナイメージキャッシュは、レジストリからコンテナイメージをプルする必要があるアクションを高速化するために使用されます。コンテナイメージキャッシュを使用するDockerコマンドの例としては、docker pull、docker-compose up、docker-compose buildなどがあります。 |
|
ContainerBuild.ps1 |
docker-compose.build.ymlファイルの内容に基づいてコンテナイメージを構築するために使用されるスクリプト。結果は、タグが "latest" のコンテナー イメージです。 |
|
ContainerTag.ps1 |
指定されたタグ値に基づいてコンテナイメージにタグを付けるために使用されるスクリプト。 |
|
PrepContainerBuild.ps1 |
Sitecore Experience Commerceリリース パッケージのアーティファクトを取得し、それらをソース コード ディレクトリ構造に展開するスクリプト。 |
|
UpdateEnvTag.ps1 |
コンテナイメージのレジストリ、名前空間、プロジェクト、およびコンテナイメージのタグを設定するスクリプト。 |
|
UpdateEnvCompose.ps1 |
指定された値で /topology/.env ファイルを更新するスクリプト。 |
|
UpdateK8SYaml.ps1 |
Kubernetesシークレット ファイルにconfigltsc2019.jsonファイルの値を設定するスクリプト。Kubernetesは、Windows LTSC 2019環境でのみサポートされます。 |
|
ScriptSupport.psm1 |
他のスクリプト ファイルで使用されるサポート関数を含むスクリプト。 |
|
WDPMapping.json |
PrepContainerBuild.ps1スクリプトで使用されるファイル。このファイルには、docker-compose buildコマンドの実行時に使用する正しい場所にリリース・パッケージ成果物の内容を配置するために使用されるマッピング情報が含まれています。 |
|
configltsc2019.json config20H2.json config2004.json config2009.json |
更新スクリプトUpdateEnvTag.ps1、UpdateEnvCompose.ps1、および UpdateK8SYaml.ps1によって使用されるファイルは、.envファイルとymlファイル内のトークンを上書きまたは置換するために使用します。これにより、ビルドおよび実行プロセスで使用するためにファイルをカスタマイズできます。 |
|
FakeLicenseFile.txt |
偽のライセンスを含むファイル。 |
|
CreateCertsXC0.cmd CreateCertsXC1-CXA.cmd |
さまざまなデプロイメント・トポロジーに適切な証明書を作成するスクリプト。 |
WDPマッピング
WDPMapping.jsonファイルには、Sitecore XCリリース パッケージの一部であるWDPパッケージを、Docker Composeビルド プロセスで使用する適切なフォルダー構造に配置するために使用されるマッピング情報が含まれています。
WDPMapping.jsonは、PrepContainerBuild.ps1スクリプトによって使用されます。
次のマッピング例では、一覧表示されたWDPパッケージ内の "Content/Website" フォルダーの内容が、 Sitecore.Commerce.Container.SDKフォルダー内の宛先フォルダーxc1-cxa/cd/wdpコピーされます。
WDPMapping.jsonには、最も排他的なパッケージ名を持つWDPから始まり、最も排他的でないパッケージ名で終わる、類似した名前のWDPが一覧表示されます。
次の例では、一覧表示されているWDPパッケージ内の .dacpacファイルが、Sitecore.Commerce.Container.SDKフォルダー内の宛先フォルダーxc1-cxa/mssql/dacpacsコピーされます。master、core、またはwebの名前に一致する.dacpacファイルは、宛先フォルダでそれぞれSitecore.Master、Sitecore.Core、およびSitecore.Webに名前が変更されます。