---
title: "Sitecore Commerce Container SDK"
slug: "sitecore-commerce-container-sdk"
abstract: "Sitecore Experience Commerceコンテナソフトウェア開発キットの内容を説明します。"
---
# Sitecore Commerce Container SDK

Sitecore Commerce Container SDKは、コンテナ化されたCommerceソリューションを扱うための開発者の出発点を提供します。

SDKパッケージには、Dockerファイル、環境変数ファイル、Docker compose YAMLファイル、Kubernetes YAMLファイル、そして使用・修正可能なサンプルスクリプトなどのリソースが含まれています。

-   コンテナを使って開発者ワークステーションにSitecore XCをインストールしてください。
-   Sitecore Experience Commerce(XC)コンテナをAzure Kubernetesサービスに展開します。
-   [カスタマイズされたCommerceソリューションから独自のコンテナセットを構築しましょう。](https://doc.sitecore.com/xp/ja/developers/103/sitecore-experience-commerce/workflow-for-creating-custom-commerce-container-images.html "Workflow for creating custom Commerce container images")

Sitecore.Commerce.Container.SDK.\*.ZIPパッケージおよびサポートするインストールガイドは[Sitecore Downloads](https://dev.sitecore.net/Downloads/Sitecore_Commerce.aspx)のウェブサイトで入手可能です。

## 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形式)を含みます。

*文字*

Dockerを使ったSitecore Experience Commerceコンテナ画像の作成を促進するサポートスクリプトとJSONファイルのセットを例として含んでいます。  
  
また、各スクリプトの目的を説明するREADMEファイルも含まれています。

*Upgrade*

データベースコンテンツのアップグレードに使用される設定および環境ファイルSitecore XC含まれています。

*XC0*

XC0トポロジーでSitecore XCインスタンスを構築・実行するためのファイルが含まれており、Commerce Engineのデプロイ専用です。  
  
\> \[!注\]  
\> 開発者向けワークステーション用のXC0トポロジーには、SXAストアフロントやサポートモジュール用のコンテナイメージは含まれていません。  
\> SXAストアフロントをサポートするために必要なモジュールを含む展開には、XC1-CXAトポロジーをインストールする必要があります。

*XC1*

Sitecore XC1トポロジーイメージを構築するために使用されたファイルが含まれています。XC1トポロジーは、SXA Storefrontをサポートするモジュールを除外したスケール型デプロイメント用です。このトポロジーは、SXA Storefrontを使わないスケールされたCommerce Engineのみのデプロイで使用されます。  
  
\> \[!注\]  
\> Sitecore Commerce Container SDKには、XC1トポロジーのコンテナイメージを展開するために必要なすべてのDocker YAML(YAML)ファイルを構成するものは含まれていません。

*XC1-CXA*

XC1トポロジーでSitecore XCインスタンスを構築し実行するために必要なファイルを含みます。このデプロイメントトポロジーにはSXA Storefrontが含まれます。

*XC-コモン*

共通Sitecore XC画像を作成するために必要なファイルが含まれています。  
  
\> \[!注\]  
\>共通像はすべてのSitecore XC位相で使用されます。

### *xc-common*フォルダー

xc-commonフォルダには、SDKに含まれるすべてのデフォルトの展開トポロジーに共通するSitecore XCイメージを構築するために必要なすべてのファイルが含まれています。

以下はxc-commonフォルダー構造の例を示しています:

-   XC-コモン
    -   \[サービス\]
        -   Dockerfile
        -   \[...\]
    -   .env
    -   docker-compose.build.yml

#### サービスフォルダー

それぞれserviceフォルダー:

-   コンテナを表す
-   最低でも Dockerfileを含みます。
-   Docker Composeファイル内の対応するサービスのDockerビルドコンテキストとして使用されます。

#### Docker compose build YAMLファイル

docker-compose.build.ymlファイルは、XC0およびXC1の展開トポロジーで使用される以下のサービスのイメージビルドを定義しています。

> !注このフォルダ内の画像は、xc0 、xc1、xc1-cxaフォルダにある画像より先に構築しなければなりません。

-   id
-   bizfx
-   engine

### *xc0*フォルダ

xc0フォルダには、XC0トポロジーイメージの構築と実行に必要なすべてのファイルSitecore含まれています。

以下はxc0フォルダー構造の例を示しています:

-   XC0
    -   \[サービス\]
        -   \[...\]
    -   \[...\]
    -   .env
    -   docker-compose.build.yml
    -   docker-compose.yml

#### サービスフォルダー

それぞれserviceフォルダー:

-   コンテナを表しています。
-   Docker Composeファイル内の対応するサービスのDockerビルドコンテキストとして使用されます。

#### docker compose build YAMLファイル

docker-compose.build.ymlファイルは以下のサービス向けに画像構築を定義しています:

-   solr-init
-   cm
-   xconnect
-   xdbsearchworker
-   xdbautomationworker

docker-compose.ymlにはXC0インスタンスに必要なすべてのコンテナに関する情報が含まれています。

### *xc1*フォルダ

xc1フォルダにはXC1トポロジーイメージを構築するために必要なすべてのファイルが含まれています。

以下はxc1フォルダー構造の例を示しています:

-   XC1
    -   \[サービス\]
        -   \[...\]
    -   \[...\]
    -   .env
    -   docker-compose.build.yml

#### サービスフォルダー

それぞれserviceフォルダー:

-   コンテナを表しています。
-   Docker Composeファイル内の対応するサービスのDockerビルドコンテキストとして使用されます。

#### docker compose build YAMLファイル

docker-compose.build.ymlファイルは以下のサービス向けに画像構築を定義しています:

> !注このフォルダ内の画像は、xc1-cxaフォルダに含まれる画像よりも先に構築する必要があります。

-   mssql-init
-   solr-init
-   solr-init-searchstax
-   xdbcollection
-   prc
-   cm
-   cd
-   xdbsearch
-   xdbsearchworker
-   xdbautomation
-   xdbautomationworker

### *xc1-cxa*フォルダ

xc1-cxaフォルダには、XC1トポロジーイメージの構築と実行に必要なすべてのファイルが含まれており、SXAストアフロントも含まれています。

以下はxc1-cxaフォルダー構造の例を示しています:

-   XC1
    -   \[サービス\]
        -   \[...\]
    -   \[...\].env commerce.build.yml docker-compose.build.yml docker-compose.yml

#### サービスフォルダー

xc1-cxaフォルダ内には、それぞれserviceフォルダがあります:

-   コンテナを表しています。
-   最低でも Dockerfileを含みます。
-   Docker Composeファイル内の対応するサービスのDockerビルドコンテキストとして使用されます。

#### docker compose build YAMLファイル

docker-compose.build.ymlファイルは以下のサービス向けに画像構築を定義しています:

-   mssql-init
    
-   solr-init
    
-   solr-init-searchstax
    
-   cd
    
-   cm
    
    > cmcd[画像にはSitecore PowerShell Extensions(SPE)](https://doc.sitecorepowershell.com/)[とSitecore Experience Accelerator(SXA)が含まれています](https://doc.sitecore.com/developers/sxa/100/sitecore-experience-accelerator/en/index-en.html)
    

#### dockerのcompose YAMLファイル

docker-compose.ymlファイルには、XC1インスタンスに必要なすべてのコンテナに関する情報が含まれています。

### *スクリプト*フォルダ

このscriptsフォルダーには、Dockerを使ってSitecore Experience Commerceコンテナイメージを作成するためのサポートスクリプトやJSONファイル群が含まれています。

以下の表は、scriptsフォルダーの内容を一覧かつ簡単に説明しています。

> !注詳細については、scriptフォルダに含まれるreadme.mdファイルをご参照ください。スクリプトファイル自体にも追加情報やガイダンスが注釈されています。

ファイル

概要

CleanContainerCache.ps1

Dockerコンテナイメージキャッシュをクリーンアップするために使われるスクリプト。コンテナイメージキャッシュは、レジストリからコンテナイメージを取得する必要があるすべての操作を迅速化するために使われます。コンテナイメージキャッシュを使用するDockerコマンドの例には、 docker pull、 docker-compose up、 docker-compose buildがあります。

ComposeInit.ps1

Windows Docker環境を初期化し、環境を迅速に準備し、Docker展開の準備を整えるためのスクリプト。

ContainerBuild.ps1

docker-compose.build.ymlファイルの内容に基づいてコンテナ画像を作成するためのスクリプトです。結果はタグlatestを持つコンテナ画像です。

ContainerTag.ps1

提供されたタグ値に基づいてコンテナ画像にタグ付けするためのスクリプトです。

PrepEngineContainerBuild.ps1

Commerce.Engine.OnPrem.SolrとSitecore.BizFx.OnPrem WDPを受け取り、Sitecore XCコンテナDockerファイルが期待する構造に内容を展開するスクリプトです。

UpdateEnvTag.ps1

コンテナイメージのレジストリ、名前空間、プロジェクト、タグを設定するスクリプトです。

UpdateK8SYaml.ps1

configltsc2019.jsonファイルの値でKubernetesシークレットファイルを設定するスクリプトです。KubernetesはWindows LTSC 2019環境でのみサポートされています。

UpdateK8SUpgradeYaml.ps1

コンテナアップグレードシナリオのために秘密ファイルを更新するために使われるスクリプト。KubernetesはWindows LTSC 2019環境でのみサポートされています。

configltsc2019.json  
  
config20H2.json  
  
config2009.json

UpdateEnvTag.ps1、ComposeInit.ps1、UpdateK8SYaml.ps1スクリプトが.envおよびymlファイルのトークンを上書きまたは置き換えるために使用するファイルです。これにより、ビルドおよび実行プロセスで使用するためにファイルをカスタマイズできます。

readme.md

提供されたスクリプトの詳細を含むreadmeファイル。

### *アップグレード*フォルダ

upgradeフォルダには、コンテンツのアップグレードに必要なdockerやKubernetesファイルSitecore XC入っています。

以下はアップグレードフォルダ構造の一例です:

+ upgrade
 + k8s-sitecore-xc1
 + configuration
 + ...
 + kustomization.yaml
 + mssql-upgrade.yaml
 + sitecore-xc
 + docker-compose-upgrade.yml
 + upgrade.env

#### The k8s-sitecore-xc1 folder

The \`k8s-sitecore-xc1\` folder contains the Kubernetes files for the Sitecore XC upgrade.

The following table lists and briefly describes the contents the of \`k8s-sitecore-xc1scripts\` folder:

| File | Description |
| --- | --- |
| \`mssql-upgrade.yaml\` | The Kubernetes specification file that you use to deploy, configure, and run the upgrade container in a Kubernetes cluster. |
| \`kustomization.yaml\` | The file that deploys all the secret names and values required by the upgrade container. |

#### The ks8s-sitecore-xc1/configuration folder

The \`ks8s-sitecore-xc1/configuration\` folder contains the \`secrets\` and \`ConfigMap\` files. These text files store Kubernetes \*secrets\* and \*ConfigMap\* values used by the upgrade container.

#### The sitecore-xc folder

The \`sitecore-xc\` folder contains the docker compose files used for the Sitecore XC upgrade.

The following table lists and briefly describes the files within the \`sitecore-xc\` folder:

| File | Description |
| --- | --- |
| \`docker-compose-upgrade.yaml\` | The docker compose file used to upgrade Sitecore XC Mssql containers. |
| \`upgrade.env\` | The environment file that contains the variables used for the upgrade. |