1. その他の開発課題

パッケージ管理サービス

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

!注このトピックはSitecore 9、Update 2以降にも有効です。

パッケージ管理サービスを使って、ユーザーがSitecoreパッケージに関する情報を取得し、Update Centerを使ってパッケージをダウンロード・インストールできるWeb APIを提供します。これらのパッケージはローカルでホストします。

!注Sitecore 9.1.1以降、パッケージ管理サービスは2つの構成グループをサポートしています。

  • Management - このプラットフォームグループにはWCMSの設定、ファイル、DLLのみが含まれています。Sitecore Analyticsにビットを使わないXMです。

  • Platform - このプラットフォームグループにはXPに必要なファイルも含まれており、完全なSitecore構成です。

パッケージ管理サービスを利用して組織内でSitecoreパッケージをホスト・配布する理由は以下の通りです:

  • 開発者が開発環境やテスト環境にインストールするパッケージをコントロールできます。
  • パッケージはSitecoreのインフラ全体で一貫して配布できます。

パッケージ管理サービスは単一のzipアーカイブとして配布されています。アーカイブにはインストール手順を含むSitecore.PackageManagementService.Web.deploy-readme.txtファイルがあります。

インストール後、web.configファイルのappSettingsectionに以下のパラメータの値を指定してサービスを設定します。

  • HotfixesRootとUpdatesRootを指定します。それぞれホットフィックスやアップデートを保存するファイルシステムフォルダです。
  • 以下の2つの認証モードのいずれかを選択してください:
    • 認証を完全に無効にするには、RequiredAuthorizationをfalseに設定してください。
    • カスタムトークンベースの認証プロバイダーを登録するには、OAuthAuthorizationServerProviderを指定します。カスタムプロバイダーはMicrosoft.Owin.Security.OAuth.OAuthAuthorizationServerProviderから継承しなければなりません。

このトピックでは以下の内容を説明します:

パッケージのメタデータと構造

パッケージとは、2つのファイルからなるzipアーカイブのことです。

  • Package.update – 標準的なSitecoreの更新ファイルです。
  • Package.json – パッケージを説明する情報。

情報(JSON形式)にはプロパティの説明、インストール前ステップ、インストール後のステップが含まれます。アップデートセンターはこの情報を読み取り表示します。以下はJSON形式のパッケージ情報の例です:

{ "Properties": { "Description": "This update package will upgrade your current Sitecore Platform version to 9.0.2", "Installation instruction": "https:/dev.sitecore.net/", "Release notes": "https:/dev.sitecore.net/", "Some Property": "something", "Another Property": "something" }, "PostSteps": { "Name": "Name of poststep here", "Description": "Description of poststep here" }, { "Name": "Name of the next poststep here", "Description": "Description of poststep here" }, "PreSteps": { "Name": "Name of prestep here", "Description": "Description of prestep here" }, { "Name": "Name of the next prestep here", "Description": "Description of prestep here" } }

バージョン管理ルール

Sitecoreプラットフォームおよびモジュールは、意味的なバージョン設定に基づくバージョン名を使用しています。

定期的な更新は以下と呼ばれます

、9.0.2。

ホットフィックスの名前は以下の通りです:<;Major>。。。、例えば9.0.0.3。

ファイル保存

パッケージ管理サービス用のパッケージは、ファイルシステムの特定のフォルダ構造に保存しなければなりません。この構造は、プラットフォームやモジュールの特定のバージョンに対するパッケージの可用性を定義します。

フォルダ構造は次のように定義しています:

  • アップデートですか、それともホットフィックスですか?
  • プラットフォームまたはモジュールのソースバージョン。
  • プラットフォームまたはモジュールのターゲットバージョン。

Sitecore 9.1.1以前の更新のためのフォルダ構造

更新情報は以下の方法でフォルダ構造に格納されます:

  • プラットフォームの最新情報:

    \\\プラットフォーム\<;ターゲットプラットフォームversion>

  • モジュールの最新情報:

    \\モジュール\\\

前述の通り、web.configファイルでupdateルートフォルダを指定します。

例えば:

The_Package_Management_Service-Picture_2-rId11-17622959.png

ここで:

フォルダパス

概要

\アップデート

アップデートパッケージのルートフォルダです。

\アップデート\9.0.0

インストールされたプラットフォームのソース(現在の)バージョンです。この例では9.0.0です。

\Updates\9.0.0\Platform\9.0.1 と\Updates\9.0.0\Platform\9.0.2

現在のバージョンからアップグレードできるプラットフォームのターゲットバージョンです。この例では、9.0.0から9.0.1または9.0.2へアップグレードできます

\Updates\9.0.0\Modules

現在インストールされているプラットフォームのバージョンと互換性のあるモジュールです。

\Updates\9.0.0\Modules\SXA\1.5.0

現在のSXAモジュールのバージョンです。この例では1.5.0です。

\Updates\9.0.0\Modules\SXA\1.5.0\1.6.0

プラットフォーム9.0.0にSXA 1.5.0をインストールした場合、SXA 1.6.0へのアップグレードが可能です。

Sitecore 9.1.1以降のアップデート用フォルダ構造

更新情報は以下の方法でフォルダ構造に格納されます:

  • プラットフォームの最新情報:

    \\<platformグループ名(プラットフォームまたはマネジメント)>\

  • モジュールの最新情報:

    \\モジュール\\\

前述の通り、web.configファイルでupdateルートフォルダを指定します。

例えば:

pms9111-1_jpg.png

ここで:

フォルダパス

概要

\更新

アップデートパッケージのルートフォルダです。

\updates\9.1.0

インストールされたプラットフォームのソース(現在の)バージョンです。この例では9.1.0です。

\updates\9.1.0\platform\9.1.1 と\updates\9.1.0\platform\9.1.2

現在のバージョンからアップグレードできるプラットフォームのターゲットバージョンです。この例では、9.1.0から9.1.1または9.1.2へアップグレードできます

\updates\9.1.0\management\9.1.1 と\updates\9.1.0\management\9.1.2

現在のバージョンからアップグレードできるプラットフォーム構成「Management」のターゲットバージョンです。この例では、9.1.0 Managementから9.1.1または9.1.2 Managementへアップグレードできます。

\updates\9.0.0\modules

現在インストールされているプラットフォームのバージョンと互換性のあるモジュール。

\updates\9.0.0\modules\sxa\1.5.0

現在のSXAモジュールのバージョンです。この例では1.5.0です。

\updates\9.0.0\modules\sxa\1.5.0\1.6.0

プラットフォーム9.0.0にSXA 1.5.0をインストールした場合、SXA 1.6.0へアップグレードできます。

Sitecore 9.1.1以前のホットフィックスのファイル構造

ホットフィックスは以下の方法でフォルダ構造に格納されます:

\\\\

ホットフィックスはプラットフォーム用かモジュール用のいずれかです。ホットフィックスのフォルダ構造はアップデート用とは異なり、ホットフィックスは独自のルートフォルダ(前述の通りweb.configファイルで指定)を持ちます。

ホットフィックス版は4桁の数字です: ...

例えば:

フォルダパス

概要

\platform\9.0.1\9.0.1.1

ターゲットプラットフォームバージョン9.0.1の最初のホットフィックスです。

\SXA\1.5.0\1.5.0.1

SXAモジュールバージョン1.5.0の最初のホットフィックス(1.5.0.1)。

Sitecore 9.1.1以降のホットフィックス用ファイル構造

ホットフィックスは以下の方法でフォルダ構造に格納されます:

\<package名称(プラットフォーム、管理、またはモジュール名EXM)>\\

例えば:

pms9111-2_jpg.png

ここで:

フォルダパス

概要

\management\9.1.0\9.1.0.1

ターゲットプラットフォームManagement Groupバージョン9.0.1の最初のホットフィックスです。

\platform\9.1.0\9.1.0.1

ターゲットプラットフォームバージョン9.0.1の最初のホットフィックスです。

\sxa\1.5.0\1.5.0.1

SXAモジュールバージョン1.5.0の最初のホットフィックス(1.5.0.1)。

Web API 1.0

このサービスはパッケージの観察とダウンロードのためのWeb APIを提供します。

APIのバージョン2.0は異なるバージョン管理ポリシーを採用しています。これはSitecore 9.1.1以降に含まれています。

APIのバージョン1.0は管理プラットフォームグループをサポートしていません。

クエリ文字列に ?api-version= を追加して、特定のバージョンのAPIを使います。

クエリ文字列にAPIバージョンがない場合は、APIのバージョン1.0が使用されます。

Sitecoreプラットフォームのアップデート

APIには、Sitecoreプラットフォームのアップデートをクエリおよびダウンロードするための以下の方法があります:

  • /api/updates//platforms

    特定のプラットフォームバージョンのパッケージ説明のリストを返します。

  • /api/updates//platforms/latest

    特定のプラットフォームバージョンの最新パッケージの説明を返します。

  • /api/updates//platforms/

    特定のプラットフォームとパッケージバージョンのパッケージの説明を返します。

  • /api/download/updates//platforms/

    特定のプラットフォームバージョンのパッケージストリームをパッケージ名とバージョンごとに返します。

例えば:

  • 9.0.1および9.0.2のアップデートがある場合、最新の(9.0.2)を返します。
  • 9.0.1パッケージのパッケージ情報を返します。

モジュールの最新情報

APIにはモジュールの更新クエリおよびダウンロードのための以下のメソッドがあります:

  • /api/updates//modules//

    特定のモジュールバージョンのパッケージ記述のリストを返します。

  • /api/updates//modules///latest

    特定のモジュールバージョンの最新パッケージの説明を返します。

  • /api/updates//modules///

    モジュール名、パッケージバージョン、プラットフォームバージョンごとにパッケージの説明を返します。

  • /api/download/updates//modules///

    特定のプラットフォームバージョンのパッケージストリームをパッケージ名とバージョンで返します。

例えば:

  • http:///api/updates/9.0.0/modules/SXA/1.6.0/latest

    SXA 1.6.0で利用可能な最新パッケージに関する情報を返します。これはプラットフォームの9.0.0と互換性があります。

  • http:///api/updates/9.0.0/modules/SXA/1.6.0/1.70

    プラットフォーム9.0.0と互換性のあるSXA 1.6.0向けの特定のアップデートパッケージバージョン1.7.0に関する情報を返します

Sitecoreプラットフォーム向けのホットフィックス

APIには、プラットフォーム向けのホットフィックスのクエリおよびダウンロードのための以下のメソッドがあります:

  • /api/hotfixes/platforms/

    特定のプラットフォームバージョンで利用可能なホットフィックスの説明リストを返します。

  • /api/hotfixes/platforms//latest

    特定のプラットフォームバージョン向けに最新のホットフィックスパッケージの説明を返します。

  • /api/hotfixes/platforms//

    特定のプラットフォームバージョンのホットフィックスパッケージの説明を返します。

  • /api/download/hotfixes/platforms//

    特定のプラットフォームバージョンのホットフィックスパッケージのストリームを返します。

例えば:

  • http:///api/hotfixes/platforms/9.0.0/latest

    プラットフォームバージョン9.0.0で利用可能な最新のホットフィックスパッケージを返送します。

  • http:///api/hotfixes/platforms/9.0.0/9.0.0.1

    プラットフォームバージョン9.0.0用のホットフィックスパッケージ9.0.0.1を返品します。

モジュールのホットフィックス

APIには、モジュールのホットフィックスのクエリおよびダウンロードのための以下のメソッドがあります:

  • /api/hotfixes/modules//

    特定のモジュールバージョンで利用可能なパッケージの説明リストを返します。

  • /api/hotfixes/modules///latest

    モジュール用に利用可能な最新のホットフィックスパッケージの説明を返します。

  • /api/hotfixes/modules///

    特定のバージョンのモジュールのホットフィックスパッケージの説明を返します。

  • /api/download/hotfixes/modules///

    特定のモジュールバージョンのホットフィックスパッケージストリームを返します。

例えば:

  • http:///api/hotfixes/modules/SXA/1.6.0/latest

    SXAバージョン1.6.0モジュール用の最新のホットフィックスパッケージを返品します。

  • http:///api/hotfixes/modules/SXA/1.6.0/1.6.0.2

    SXA 1.6.0モジュール用のホットフィックスパッケージ1.6.0.2を返品しました。

ウェブAPI 2.0

このサービスはパッケージの監視およびダウンロードのためのWeb APIを提供します。APIのバージョン1.0は異なるバージョン管理ポリシーを持っています。APIのバージョン2.0はSitecore 9.1.1以降に含まれています。

クエリ文字列に ?api-version= を追加して、特定のバージョンのAPIを使います。

クエリ文字列にAPIバージョンがない場合は、APIのバージョン1.0が使用されます。

Sitecoreプラットフォームのアップデート

APIには、Sitecoreプラットフォームのアップデートをクエリおよびダウンロードするための以下の方法があります:

  • /api/updates/**/*<platform group name (Platform or Management)>*?api-version=2.0

    特定のプラットフォームバージョンおよびプラットフォームグループのパッケージ説明のリストを返します。

  • /api/updates/**/*<platform group name (Platform or Management)>*/latest?api-version=2.0

    特定のプラットフォームバージョンおよびプラットフォームグループの最新パッケージの説明を返します。

  • /api/updates/**/*<platform group name (Platform or Management)>*/**?api-version=2.0

    特定のプラットフォーム、プラットフォームグループ、パッケージバージョンのパッケージの説明を返します。

  • /api/download/updates/**/platforms/*<platform group name (Platform or Management)>*?api-version=2.0

    特定のプラットフォームバージョンのパッケージストリームをパッケージ名とバージョンごとに返します。

モジュールの最新情報

APIにはモジュールの更新クエリおよびダウンロードのための以下のメソッドがあります:

  • /api/updates/**/modules/**/**?api-version=2.0

    特定のモジュールバージョンのパッケージ記述のリストを返します。

  • /api/updates/**/modules/**/**/latest?api-version=2.0

    特定のモジュールバージョンの最新パッケージの説明を返します。

  • /api/updates/**/modules/**/**/?api-version=2.0

    モジュール名、パッケージバージョン、プラットフォームバージョンごとにパッケージの説明を返します。

  • /api/download/updates/**/modules/**/**/**?api-version=2.0

    特定のプラットフォームバージョンのパッケージストリームをパッケージ名とバージョンで返します。

Sitecoreプラットフォームおよびモジュールのホットフィックス

APIには、プラットフォームおよびモジュールのホットフィックスのクエリおよびダウンロードのための以下のメソッドがあります:

  • /api/hotfixes/*<packageName(Platform, Management or module name like EXM)>*/**/latest?api-version=2.0

    特定のプラットフォームバージョンで利用可能なホットフィックスの説明リストを返します。

  • /api/hotfixes/*<packageName(Platform, Management or module name like EXM)>*/**?api-version=2.0

    特定のプラットフォームグループバージョンまたはモジュールバージョンで利用可能なホットフィックスの説明リストを返します。

  • /api/hotfixes/*<packageName(Platform, Management or module name like EXM)>*/**/**?api-version=2.0

    特定のプラットフォームバージョンのホットフィックスパッケージの説明を返します。

  • /api/download/hotfixes/*<packageName(Platform, Management or module name like EXM)>*/**/**?api-version=2.0

    特定のプラットフォームバージョンのホットフィックスパッケージのストリームを返します。

この記事を改善するための提案がある場合は、 お知らせください!