概要 ： システムの Web ゲートウェイの設定

InterSystems IRIS インストールの一部としてのインストール

InterSystems IRIS は、管理ポータルなどの Web アプリケーションを介して、複数の重要なシステム機能へのアクセスを提供します。このため、インターシステムズのインストーラには、必要な Web ゲートウェイ・ファイルが以下のセットアップ・タイプの一部として含まれています。

• 開発

• サーバ

• Web サーバ (Windows の場合)

• カスタム、Web サーバ・ゲートウェイ・コンポーネントが選択されている場合

スタンドアロン・コンポーネントとしてのインストール

InterSystems IRIS インスタンスをホストするマシンとは別のマシンに Web サーバを導入する場合は、次のいずれかの方法で、Web ゲートウェイをスタンドアロン・コンポーネントとして Web サーバ・マシンにインストールします。

• スタンドアロン Web ゲートウェイ・インストーラを実行します。このインストーラは、WRC のダウンロード・ページ (https://wrc.intersystems.com/wrc/coDistGen.cspOpens in a new tab) で入手できます。[名前] 列に web gateway と入力して、お使いのシステムのキットを見つけます。InterSystems IRIS インストーラと同様に、スタンドアロン Web ゲートウェイ・インストーラは、Windows の場合は実行可能ファイルとして、他のすべてのシステムの場合はスクリプト (GatewayInstall) として実装されます。

• 以下のいずれかのセットアップ・タイプを使用して、InterSystems IRIS インストーラを実行します。

  • Web サーバ (Windows の場合)

  • カスタム、Web サーバ・ゲートウェイ・コンポーネントのみを選択

• InterSystems Container RegistryOpens in a new tab から webgateway コンテナの Docker イメージをプルします。詳細は、"webgateway コンテナの導入" を参照してください。

多くの場合、スタンドアロン・インストーラには、Web ゲートウェイを使用するように Web サーバを自動的に構成するオプションが用意されています。自動構成後、Web ゲートウェイを Web サーバ構成に追加するためにさらなる操作は必要ありません。ただし、システム内の各 InterSystems IRIS インスタンスの組み込みシステム・アプリケーションを含む、InterSystems Web アプリケーションのハンドラとして Web ゲートウェイを 呼び出すように、Web サーバを手動で構成する必要があります。また、手動で接続セキュリティを構成することも必要です。

webgateway コンテナの導入

InterSystems Container RegistryOpens in a new tab は、webgateway コンテナの Docker イメージを提供します。これらのコンテナには、Web ゲートウェイ拡張で事前構成されている Web サーバ (Apache または nginx) が含まれます。

webgateway コンテナを使用して Web ゲートウェイ接続を構成するには、構成が以下のセクションで説明する条件を満たしている必要があります。ただし、コンテナ化された導入の場合、構成方法はこのページで説明する方法とはかなり異なります。webgateway コンテナを使用する場合 ：

• Web ゲートウェイを Web サーバ構成に追加するのにさらなる操作は必要ありません。

• 導入時の Web サーバ構成を自動化するには、特定のパスに送信された要求に対して Web ゲートウェイを呼び出すように、webgateway コンテナで Web サーバを構成する必要があります。それには、イメージの Dockerfile 内で構成ファイルをプログラムによって変更するか、コンテナ・クラスタの YAML ファイルで構成を記述します。

• 導入時の Web ゲートウェイ構成を自動化するには、CSP.ini マージ機能を利用して、webgateway コンテナのサーバ・アクセス・プロファイルとアプリケーション・アクセス・プロファイルを、それらの CSP.ini ファイル内で直接定義します。

具体的な手順は、"InterSystems Web ゲートウェイ・コンテナの使用法" を参照してください。

Web サーバ構成への Web ゲートウェイの追加

インターシステムズでサポートされているテクノロジのページには、このバージョンの製品と互換性のある Web サーバがリストされています。多くの場合、InterSystems IRIS インストーラは Web ゲートウェイを Web サーバに自動的に追加できます。

Web ゲートウェイを Web サーバに手動で追加する手順は、オペレーティング・システム、使用する Web サーバ、およびユース・ケースによって大きく異なります。最初に考慮すべきことを以下に示します。

• 一般に、インターシステムズでは Web サーバの Web ゲートウェイ拡張をバイナリのペアとして実装します。1 つのバイナリはコア・ランタイム機能を担当し、もう 1 つのバイナリは Web ゲートウェイ管理ページの機能を担当します。管理バイナリはファイル名の末尾に Sys を追加することで、ランタイム・バイナリと区別されます (例 ： CSPa24.so と CSPa24Sys.so)。どちらのバイナリも同じディレクトリに置く必要があります。

• Apache (UNIX®/Linux/macOS) および Microsoft IIS (Windows) の場合、Web ゲートウェイを導入するには、Web サーバ独自の API を利用して、動的にロードされる拡張モジュール (Apache の場合は .so ファイル、IIS の場合は .dll ファイル) を追加するのが最も簡単です。Nginx (UNIX®/Linux/macOS または Windows) は、コンパイル時に Web ゲートウェイ拡張のソース・コードを Web サーバに組み込むことによる Web ゲートウェイ拡張の追加のみをサポートします。

• Nginx の Web ゲートウェイ拡張では、Web ゲートウェイの機能を実行する外部プロセスを呼び出します。このプロセスは、Network Service Daemon (NSD) と呼ばれます。Web ゲートウェイのオペレーションを Web サーバから切り離す必要がある場合、インターシステムズは Apache および Microsoft IIS でそれぞれ独自の API を使用して NSD Web ゲートウェイを導入するための拡張機能も提供しています。

  Important:

  セキュリティ上の理由により、Web サーバのプロセスから NSD ファイルにアクセスすることはできません。NSD ファイルは、Web サーバのプロセスがアクセスできるディレクトリの外にあるファイル・システムの場所にインストールすることをお勧めします。

• Common Gateway Interface (CGI) 拡張を使用する必要がある場合、インターシステムズは Apache および Microsoft IIS 向けに NSD Web ゲートウェイを構成するための CGI 実行可能ファイルも提供しています。

• 選択する導入方法に関係なく、Web サーバのワーカ・プロセスが以下のディレクトリ (およびそのコンテンツ) にアクセスするための適切な権限を持つように、システムを構成する必要があります。

  • Web ゲートウェイ・バイナリのインストール・ディレクトリ。既定では、これらの場所は UNIX®/Linux/macOS では /opt/webgateway、Windows では C:\Inetpub\CSPGateway です。

  • Web ゲートウェイの構成ファイル (CSP.ini) を含むディレクトリ。

  • Web ゲートウェイ・キャッシュの内容を .dat ファイルの形式で記録する、Web ゲートウェイのインストール・ディレクトリ内の /temp サブディレクトリ。

  • Web アプリケーションが処理する可能性のある静的ファイルのディレクトリ。CSP アプリケーションに関連付けられている静的ファイルは、<IRISinstallDir>/csp/ パス内の対応するディレクトリに格納されます。<IRISinstallDir> は、アプリケーションをホストする InterSystems IRIS インスタンスのインストール・パスです。<IRISinstallDir>/csp/broker パスには、複数の組み込みのシステム・アプリケーションの静的ファイルが含まれます。

以下の表では、オペレーティング・システムと Web サーバに基づいて、Web ゲートウェイを Web サーバ構成に追加するための具体的な手順へのリンクを提供します。お使いの Web サーバに固有の詳細情報は、Web サーバの製品ドキュメントを参照してください。

Web サーバが Web ゲートウェイを介してルーティングする要求の指定

InterSystems Web アプリケーションを提供するには、Web サーバは Web ゲートウェイ拡張を呼び出して、そのアプリケーションに指定された URL パスで受け取った HTTP 要求を処理する必要があります。この構成手順は、Web サーバによって異なります。

お使いの Web サーバに関係なく、インターシステムズは Web ゲートウェイが処理すべき要求を指定するための 2 つの方法を提供しています。

1. クライアントが指定されたパスで特定のファイル・タイプを要求したときに、Web ゲートウェイを呼び出します。InterSystems Web アプリケーション要求の多くは、末尾が以下のいずれかのインターシステムズ･ファイル・タイプ拡張子になっています。

   .csp .cls .zen .cxw
   

   

   最初の 3 つのファイル・タイプは、InterSystems IRIS で実行できるコードの種類を示します。最後のファイル・タイプ (.cxw) は、Web ゲートウェイ管理ページで排他的に使用するために予約されています。Web アプリケーションが応答の一部として静的ファイル (.jpg、.js など) を処理する場合、それらの静的ファイル・タイプの要求に対する応答として Web ゲートウェイを呼び出すように、Web サーバを構成することも必要です。

2. 指定されたパスでの任意の要求に対して、Web ゲートウェイを呼び出します。

ほとんどの REST API はファイルまたはファイル・タイプを指定せずに、エンドポイント・パスを公開します (例えば、InterSystems IRIS パフォーマンス・データを収集するためのエンドポイント ： /api/monitor/metrics)。このようなアプリケーションを提供するには、アプリケーションの URL パスでのすべての要求に対して、Web ゲートウェイを呼び出す必要があります。

以下の表は、Web ゲートウェイを呼び出す両方の方法を、サポート対象の Web サーバごとに簡単にまとめたものです。お使いの Web サーバの構成手順の詳細は、Web サーバの製品ドキュメントを参照してください。

Web サーバが Web ゲートウェイを呼び出す URL パスを選択する前に、Web サーバからアプリケーションを提供する InterSystems IRIS インスタンスにアプリケーション要求をルーティングするプロセス全体を検討することをお勧めします。これは、システムに複数の InterSystems IRIS アプリケーション・サーバが搭載されている場合、または組織に特定の URL 命名規則がある場合に特にお勧めです。詳細は、"Web ゲートウェイを介して要求をルーティングするパスの選択" を参照してください。

InterSystems IRIS インスタンスの Web ゲートウェイへの接続

Web ゲートウェイが InterSystems IRIS インスタンスのアプリケーション・サーバ・プロセスへの接続を確立し、維持できるようにするには、各インスタンスの接続情報 (IP アドレス、スーパーサーバ・ポート番号、接続セキュリティの認証情報など) を提供するサーバ・アクセス・プロファイルを定義する必要があります。"InterSystems IRIS インスタンスのサーバ・アクセス・プロファイルの定義" を参照してください。

インスタンスのアプリケーションとの関連付け

単一の Web ゲートウェイが、複数の InterSystems IRIS インスタンスに、そのインスタンス固有のアプリケーションの要求をルーティングすることができます (各インスタンスの管理ポータルなど)。さらに、Web ゲートウェイは、単一のアプリケーションの要求を、同じアプリケーション･コードをホストする複数のインスタンスに関連付けることができるため、負荷分散とフェイルオーバーが可能になります。

Web ゲートウェイは、アプリケーション・アクセス・プロファイルに基づいて宛先インスタンスを決定します。アプリケーション・アクセス・プロファイルは、要求で指定された URL パスと、1 つ以上の InterSystems IRIS インスタンス (サーバ・アクセス・プロファイルで示された) との間のリレーションシップを定義します。アプリケーション・アクセス・プロファイルには、Web ゲートウェイがそのパスのトラフィックを処理する方法に関するその他の詳細も含まれます。"Web アプリケーション・パスのアプリケーション・アクセス・プロファイルの定義" を参照してください。

アプリケーション・アクセス・プロファイルを定義する URL パスを選択する前に、Web サーバからアプリケーションを提供する InterSystems IRIS インスタンスにアプリケーション要求をルーティングするプロセス全体を検討することをお勧めします。これは、システムに複数の InterSystems IRIS アプリケーション・サーバが搭載されている場合、または組織に特定の URL 命名規則がある場合に特にお勧めです。詳細は、"Web ゲートウェイを介して要求をルーティングするパスの選択" を参照してください。