1. その他の開発タスク

パッケージ管理サービス

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

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

メモ

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

パッケージ管理サービスを使用して、ユーザーがSitecoreパッケージに関する情報を取得し、アップデート センターを使用してそのようなパッケージをダウンロードしてインストールできるようにするWeb APIを提供します。これらのパッケージはローカルでホストします。

手記

Sitecore 9.1.1以降、Package Management Serviceは2つの設定グループをサポートしています。

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

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

パッケージ管理サービスを使用して組織内でSitecoreパッケージをホストおよび配布する理由には、次のようなものがあります。

  • 開発者が開発環境とテスト環境にインストールしたパッケージを制御します。

  • パッケージは、Sitecoreインフラストラクチャ全体で一貫して配布できます。

Package Management Serviceは、1つの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プラットフォームとモジュールは、セマンティック バージョニングに基づくバージョン名を使用します。

定期的な更新の名前は <Major>.<Minor>.187912757818791275788 (例: 9.0.2) です。

ホットフィックスの名前は < です。メジャー>.<マイナー>.<パッチ>.187912757818578ホットフィックス> (例: 9.0.0.3)。

ファイルストレージ

Package Management Serviceのパッケージは、ファイル システム内の特定のフォルダ構造に格納する必要があります。この構造体は、プラットフォームまたはモジュールの特定のバージョンのパッケージの可用性を定義します。

フォルダ構造では、次のものを定義します。

  • それは更新プログラムですか、それとも修正プログラムですか?

  • プラットフォームまたはモジュールのソースバージョン。

  • プラットフォームまたはモジュールのターゲット バージョン。

Sitecore 9.1.1より前の更新のフォルダー構造

更新は、次のようにフォルダ構造に保存されます。

  • プラットフォームの更新の場合:

    \<updates root>\<source platform version>\Platform\<;target platform version>

  • モジュールの更新の場合:

    <updates root>\<source platform version>\Modules\<module name>\<current module version>\<target modules version>

更新ルート フォルダは、前に説明したようにweb.configファイルで指定します。

例えば：

どこ：

フォルダパス

形容

\最新情報

更新プログラム パッケージのルート フォルダー。

\アップデート\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にアップグレードできます

\更新\9.0.0\モジュール

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

\アップデート\9.0.0\モジュール\SXA\1.5.0

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

\アップデート\9.0.0\モジュール\SXA\1.5.0\1.6.0

SXA 1.5.0がプラットフォーム9.0.0にインストールされている場合は、SXA 1.6.0にアップグレードできます。

Sitecore 9.1.1以降の更新のフォルダー構造

更新は、次のようにフォルダ構造に保存されます。

  • プラットフォームの更新の場合:

    <updates root>\<source platform version>\<platform group name (Platform or Management)>\<target platform version>

  • モジュールの更新の場合:

    <updates root>\<source platform version>\Modules\<module name>\<current module version>\<target modules version>

更新ルート フォルダは、前に説明したようにweb.configファイルで指定します。

例えば：

どこ：

フォルダパス

形容

\最新情報

更新プログラム パッケージのルート フォルダー。

\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

現在のバージョンからアップグレードできるプラットフォーム構成「管理」のターゲットバージョン。この例では、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

SXA 1.5.0がプラットフォーム9.0.0にインストールされている場合は、SXA 1.6.0にアップグレードできます。

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

ホットフィックスは、次のようにフォルダ構造に保存されます。

\<hotfixes root>\<platform or module name>\<source product version>\<target product version>

ホットフィックスは、プラットフォーム用またはモジュール用のいずれかです。修正プログラムのフォルダ構造は、更新プログラムに使用される構造とは異なり、修正プログラムには独自の個別のルート フォルダがあります (前述のように、web.configファイルで指定)。

ホットフィックスのバージョンは4桁です。 <Major>.<Minor>.<Patch>.<Hotfix>

例えば：

フォルダパス

形容

\<hotfixes root>\プラットフォーム\9.0.1\9.0.1.1

ターゲット プラットフォーム バージョン9.0.1の最初の修正プログラム。

\<hotfixes root>\SXA\1.5.0\1.5.0.1

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

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

ホットフィックスは、次のようにフォルダ構造に保存されます。

<hotfixes root>\<package name (Platform, Management or module name like EXM)>\<source product version>\<target product version>

例えば：

どこ：

フォルダパス

形容

<hotfixes root>\管理\9.1.0\9.1.0.1

ターゲット プラットフォーム管理グループ バージョン9.0.1の最初の修正プログラム。

<hotfixes root>\platform\9.1.0\9.1.0.1

ターゲット プラットフォーム バージョン9.0.1の最初の修正プログラム。

<hotfixes root>\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=<number of api version> を追加して、特定のバージョンのAPIを使用します。

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

Sitecoreプラットフォームの更新

APIには、Sitecoreプラットフォームの更新をクエリおよびダウンロードするための次のメソッドがあります。

  • /api/updates/<sitecoreVersion>/platforms

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

  • /api/updates/<sitecoreVersion>/platforms/latest

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

  • /api/updates/<sitecoreVersion>/platforms/<packageVersion>

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

  • /api/download/updates/<sitecoreVersion>/platforms/<packageVersion>

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

例えば：

  • 9.0.0の9.0.1および9.0.2更新プログラムがある場合は、最新の (9.0.2) を返します。

  • 9.0.1パッケージのパッケージ情報を返します。

モジュールの更新

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

  • /api/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>

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

  • /api/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>/latest

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

  • /api/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>/<packageVersion>

    特定のモジュール バージョンのパッケージの説明を、モジュール名、パッケージ バージョン、およびプラットフォーム バージョンで返します。

  • /api/download/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>/<packageVersion>

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

例えば：

  • http://<hostname>/api/updates/9.0.0/modules/SXA/1.6.0/latest

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

  • http://<hostname>/api/updates/9.0.0/modules/SXA/1.6.0/1.70

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

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

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

  • /api/hotfixes/platforms/<sitecoreVersion>

    特定のプラットフォーム バージョンで使用できる修正プログラムの説明の一覧を返します。

  • /api/hotfixes/platforms/<sitecoreVersion>/latest

    特定のプラットフォーム バージョンで使用可能な最新の修正プログラム パッケージの説明を返します。

  • /api/hotfixes/platforms/<sitecoreVersion>/<targetVersion>

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

  • /api/download/hotfixes/platforms/<sitecoreVersion>/<targetVersion>

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

例えば：

  • http://<hostname>/api/hotfixes/platforms/9.0.0/latest

    プラットフォーム バージョン9.0.0で使用可能な最新の修正プログラム パッケージを返します。

  • http://<hostname>/api/hotfixes/platforms/9.0.0/9.0.0.1

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

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

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

  • /api/hotfixes/modules/<moduleName>/<moduleVersion>

    モジュールの特定のバージョンで使用可能なパッケージの説明の一覧を返します。

  • /api/hotfixes/modules/<moduleName>/<moduleVersion>/latest

    モジュールで使用可能な最新の修正プログラム パッケージの説明を返します。

  • /api/hotfixes/modules/<moduleName>/<moduleVersion>/<targetVersion>

    特定のバージョンのモジュールの特定の修正プログラム パッケージの説明を返します。

  • /api/download/hotfixes/modules/<moduleName>/<moduleVersion>/<targetVersion>

    モジュールの特定のバージョンの修正プログラム パッケージ ストリームを返します。

例えば：

  • http://<hostname>/api/hotfixes/modules/SXA/1.6.0/latest

    SXAバージョン1.6.0モジュールで利用可能な最新のHotFixパッケージを返します。

  • http://<hostname>/api/hotfixes/modules/SXA/1.6.0/1.6.0.2

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

Web API 2.0 (英語)

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

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

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

Sitecoreプラットフォームの更新

APIには、Sitecoreプラットフォームの更新をクエリおよびダウンロードするための次のメソッドがあります。

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

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

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

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

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

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

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

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

モジュールの更新

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

  • /api/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>?api-version=2.0

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

  • /api/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>/latest?api-version=2.0

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

  • /api/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>/<packageVersion>?api-version=2.0

    特定のモジュール バージョンのパッケージの説明を、モジュール名、パッケージ バージョン、およびプラットフォーム バージョンで返します。

  • /api/download/updates/<sitecoreVersion>/modules/<moduleName>/<moduleVersion>/<packageVersion>?api-version=2.0

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

SitecoreプラットフォームとモジュールのHotfix

APIには、プラットフォームとモジュールのホットフィックスを照会およびダウンロードするための次のメソッドがあります。

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

    特定のプラットフォーム バージョンで使用できる修正プログラムの説明の一覧を返します。

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

    特定のプラットフォーム グループ バージョンまたはモジュール バージョンで使用可能な修正プログラムの説明の一覧を返します。

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

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

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

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

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