オンデマンド Sandbox をコピーする

学習の目的

オンデマンド Sandbox コピーの主な特徴、含まれるもの、除外されるものを説明する。
Sandbox のコピー処理における 4 つの主な進行ステージと手順の概要を説明する。
Control Center を使用して Sandbox コピー操作を実行する。
新しくコピーされた Sandbox で必要なカスタム設定を特定して更新する。
オンデマンド Sandbox REST API の 3 つの主なコピー操作を説明する。

オンデマンド Sandbox のコピー機能を使用すると、既存の Sandbox の正確なレプリカを数分で作成できます。チームは、開発、テスト、運用ワークフローのそれぞれを目的とした、完全に分離された環境で作業することで、作業を迅速化し、リスクを軽減できます。コピーされた各 Sandbox には、専用のコンピューティング、ストレージ、データベースのリソースが割り当てられます。

たとえば、本番環境のエラーを安全に再現する、災害復旧計画を検証する、現実に即したトレーニング環境を提供するといったユースケースがあります。

コピーされた Sandbox に含まれるものと除外されるものを確認する

Sandbox のコピーでは、環境の重要な要素がすべて再現されます。コピーに含まれるものは次のとおりです。

データベーススキーマとデータ
カスタムコードとカートリッジ
ストアフロント、サイトデータ、設定
カタログと価格表
注文やコンテンツのデータ
機能スイッチ
メンテナンスページ
標準プラットフォーム設定ファイル

一方、セキュリティ、プライバシー、テナントの整合性を保護するため、コピーでは特定のデータが除外されます。除外されるものは次のとおりです。

ログとジョブの履歴
顧客の PII と GDPR 関連データ
Analytics データ
地理位置データ
注文アクティビティ
為替レートデータ
変更ログ
テナント固有の設定

プラットフォームのセキュリティとプライバシー要件に準拠するため、機密データは省略または変換されます。

Sandbox のコピーのしくみを確認する

コピー処理では、6 つの詳細な手順が 4 つの主な進行ステージにグループ化されます。

インスタンスの準備: コピー元 Sandbox の状況、権限、リソースの可用性を検証します。
データのバックアップ: コピー元データベース、sharedata、設定の一貫性のあるスナップショットを作成します。
データの復元: 新しい Sandbox にコンピューティング、ストレージ、ネットワークリソースを割り当てます。データベーステーブル、インデックス、ファイルがコピー環境に複製されます。その後、独立性を確保するためにシステムファイルとログイン情報が更新されます。
事後検証: Sandbox の正常性を検証し、接続をテストして、コピーを有効化します。

コピー中は、データの整合性と設定の一貫性を保証するために、コピー元 Sandbox は一時的に保護された停止状態になります。コピーが完了すると、コピー元 Sandbox は通常の動作を再開します。所要時間は Sandbox のサイズとデータ量に応じて変わりますが、通常は 10 ～ 30 分です。

Sandbox のコピー前に前提条件を確認する

コピー操作を開始する前に、次の要件を確認します。

Account Manager で、<realm_id>_sbx 形式のテナント検索条件を指定した Sandbox API ユーザーロールが割り当てられている。
コピー元 Sandbox の状況が有効である。
コピー元 Sandbox が実行中または停止中の状態である。
コピー元 Sandbox に保留中の操作がない。
自分のアカウントにコピー元 Sandbox データへのアクセス権がある。

Control Center でコピーされた Sandbox を作成して管理する

Control Center を使用して既存のオンデマンド Sandbox をコピーする手順は、次のとおりです。

Control Center にログインします。
コピーを作成するレルムを選択します。
コピーするインスタンスの横にある [Clone (コピー)] ボタンをクリックします。
[Clone On-Demand Sandbox (オンデマンド Sandbox をコピー)] フォームに入力します。

Time to live (TTL): コピーされた Sandbox が有効である期間を時間数で選択します。選択できる値は、24 (デフォルトの最小値)、48、72、168 (1 週間)、0 (無期限) があります。
Resource profile (リソースプロファイル): リソースの割り当て (medium、large、x large、xx large) を選択します。コピー先プロファイルは、コピー元 Sandbox プロファイルと同じまたはそれより大きいサイズである必要があります。
Notification emails (通知メール): 通知を受け取る 1 つ以上のメールアドレスを入力するか、[Retain Email Addresses (メールアドレスを保持)] オプションを選択したままにして、コピー元 Sandbox の通知先アドレスを使用します。

[Clone Instance (インスタンスをコピー)] をクリックします。

処理が開始されると、コピー元 Sandbox の状況が Cloning (コピー中) に変わります。コピーが完了するまで、Control Center ではコピー元 Sandbox のすべてのアクション (開始、停止、リセット、コピー、削除) が無効になります。

コピーを管理および監視する

Control Center で、コピー操作の進行状況を追跡し、コピーされた Sandbox の詳細を直接確認できます。コピー先 Sandbox は、状況が Setting Up (設定中) としてインスタンスリストに表示されます。設定が完了すると、状況は Running (稼働中、成功した場合) または Failed (失敗) に更新されます。

コピーされたインスタンスの横にある [Clone (コピー)] バッジをクリックすると、コピー元とコピー先のインスタンス識別子、コピーのタイムスタンプ、ストアフロント数、カスタムコードバージョン、データベースサイズ、ファイルシステムサイズなどの詳細を確認できます。

特定の Sandbox に関連付けられたすべてのコピー操作を確認するには、その Sandbox の [Activity Timeline (活動タイムライン)] タブに移動します。このタブには操作が時系列で表示され、状況 (Completed (完了)、Failed (失敗)、In Progress (処理中)) 別のコピー数が示されます。[Filter & Search (絞り込みと検索)] オプションを使用して、日付範囲や特定の状況で結果を絞り込みます。

コピーが完了したら、すべてのインテグレーションをテストし、コピー元 Sandbox を参照しているサードパーティエンドポイントやカスタム設定を更新します。コピーされた Sandbox が不要になったら、削除してクレジット消費を停止します。コピー操作中はコピー元 Sandbox が停止するため、コピー操作を実行する前に、開いている作業を必ず保存してください。

コピー操作が完了したら、新しい Sandbox が正しく機能するように、いくつかの項目を手動で更新します。システムは標準プラットフォームファイルを自動的に更新しますが、カスタム設定は変更しません。作業環境を維持するため、これらのカスタム設定を確認して調整します。

具体的には、環境に次の要素がある場合は更新します。

カスタムのテナント固有設定
カスタムカートリッジやスクリプト内のハードコードされた URL
サードパーティサービス URL と外部 API エンドポイント
コピー元 Sandbox に関連付けられたキーストア参照とカスタム証明書
元のコピー元インスタンスを参照するカスタムジョブまたはスケジュール
Business Manager のカスタマイズ設定

REST API を使用して Sandbox をコピーする

Commerce for B2C オンデマンド Sandbox REST API を使用して Sandbox をコピーできます。コピー API を使用すると、開発者はコピーされた環境の作成、プロビジョニング、監視をプログラムで制御できます。

Commerce for B2C オンデマンド Sandbox REST API には、Sandbox コピー用に 3 つの固有の操作が用意されています。

コピーを作成する

POST エンドポイントを使用してコピー操作を開始します。要求には、コピー元 Sandbox の一意の sandboxId と、medium、large、xlarge、xxlarge のいずれかの targetProfile サイズが必要です。コピー先プロファイルは、コピー元 Sandbox プロファイルと同じまたはそれより大きいサイズである必要があります。通知メールアドレスのリストと TTL (時間数で指定) のパラメーターは省略可能です。要求が成功すると、操作の状況を追跡するための cloneId を含む 200 OK 応答が返されます。

Sandbox コピー操作を監視する

有効なコピー操作の進行状況を追跡するか、特定のコピーされた Sandbox の詳細を取得します。この要求には、コピー元の sandboxId と特定の cloneId が必要です。成功を示す 200 OK 応答では、コピー先インスタンス ID、タイムスタンプ、経過時間、進行率、現在の状況 (IN_PROGRESS、COMPLETED、FAILED) などの詳細が返されます。

すべてのコピーを一覧表示する

特定のコピー元 Sandbox に関連付けられたすべてのコピー操作の詳細を取得します。この要求には、コピー元の sandboxId が必要です。fromDate や toDate、または Pending (保留中)、In Progress (処理中)、Failed (失敗)、Completed (完了) などのstatus (状況)を指定して、結果を絞り込むことができます。200 OK 応答では、関連付けられたすべてのコピー操作とそれぞれの詳細を含む包括的なリストが返されます。

API クライアント ID で認証すると、https://admin.dx.commercecloud.salesforce.com/ にある Sandbox API ユーザーインターフェースから、ドキュメントにアクセスして API コールを直接発行できます。

オンデマンド Sandbox REST API を使用したコピーの詳細は、「Clone On-Demand Sandboxes (オンデマンド Sandbox をコピーする)」を参照してください。

まとめ

この最後の単元では、ODS をコピーする方法を確認しました。ODS をコピーすると、PII やログなどの機密データを除外しつつ、データベース、カスタムコード、設定などを含む、開発およびテスト用の環境の正確なレプリカを作成できます。また、Control Center UI と Sandbox REST API の両方を使用して、これらのコピー操作を実行する方法も学習しました。

このバッジを通して、e コマースの迅速な開発や配信に向けて ODS 環境を設定および管理する方法を習得できました。さらに、ODS と POD ベースの Sandbox の基本的な違い、ユーザーロールを設定し、クレジットシステムと TTL システムを使用してコストを管理する方法、Sandbox API と Control Center を通してすべての Sandbox ライフサイクル操作を実行する方法についても理解できました。

予想時間

トピック

ヘルプをお探しですか?