Edge の構成方法

Edge for Private Cloud v4.19.01

インストール後に Edge を構成するには、.properties ファイルと Edge ユーティリティを組み合わせて使用します。たとえば、Edge UI で TLS/SSL を構成するには、.properties ファイルを編集して必要なプロパティを設定します。.properties ファイルを変更すると、影響を受ける Edge コンポーネントを再起動する必要があります。

Apigee では、.properties ファイルを編集する手法を構成付きのコードと呼んでいます（CwC と略されることもあります）。基本的に、構成ファイル内のコードは .properties ファイルの設定に基づく Key-Value ルックアップ ツールです。構成のコードでは、鍵をトークンと呼んでいます。Edge を構成するには、.properties ファイルでトークンを設定します。

code with config の場合、Edge コンポーネントの出荷時デフォルト値が設定されていますが、インストール チームはインストール トポロジに基づいてその設定をオーバーライドでき、その後、お客様は任意のプロパティをオーバーライドできます。

階層とみなすと、この設定は以下のように配置されます。お客様の設定は優先事項で、インストーラ チームや Apigee の設定よりも優先されます。

1. お客様
2. インストーラ
3. コンポーネント

トークンの現在の値を確認する

.properties ファイルでトークンの新しい値を設定する前に、まず次のコマンドを使用してそのトークンの現在の値を確認してください。

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

ここで、component_name はコンポーネントの名前、token は検査するトークンです。

このコマンドは、コンポーネントの .properties ファイルの階層を検索してトークンの現在の値を判断します。

次の例では、Router の conf_http_HTTPRequest.line.limit トークンの現在の値を確認します。

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

出力は次のようになります。

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

トークンの値が # で始まっている場合、そのトークンはコメントアウトされており、これを変更するには特殊な構文を使用する必要があります。詳細については、現在コメントアウトされているトークンを設定するをご覧ください。

トークンの完全な名前がわからない場合は、grep などのツールを使用してプロパティ名やキーワードで検索します。詳細については、トークンを見つけるをご覧ください。

プロパティ ファイル

編集可能なコンポーネント構成ファイルと編集不可のコンポーネント構成ファイルがあります。このセクションでは、これらのファイルについて説明します。

編集可能なコンポーネント構成ファイル

次の表に、Apigee コンポーネントと、それらのコンポーネントを構成するために編集できるプロパティ ファイルを示します。

これらのコンポーネント構成ファイルのいずれかにプロパティを設定したいが、存在しない場合は、上記の場所でプロパティを作成できます。

また、プロパティ ファイルの所有者を「apigee」ユーザーにする必要があります。

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

編集不可のコンポーネント構成ファイル

編集可能なコンポーネント構成ファイルのほかに、編集できない構成ファイルもあります。

情報（編集不可）ファイルには次のものが含まれます。

/opt/apigee/token

/opt/apigee/component_name/conf

トークンの値を設定する

.properties ファイルは /opt/apigee/customer/application ディレクトリでのみ変更できます。このディレクトリには、コンポーネントごとに固有の .properties ファイルがあります。たとえば、router.properties や management-server.properties です。プロパティ ファイルの一覧については、.properties ファイルの場所をご覧ください。

.properties ファイルを作成するには:

1. エディタで新しいテキスト ファイルを作成します。ファイル名は、上の表に示されている顧客ファイルのリストと一致する必要があります。
2. 次の例に示すように、ファイルの所有者を「apigee:apigee」に変更します。

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Edge サービスを実行するユーザーを「apigee」ユーザーから変更した場合は、chown を使用して所有権を Edge サービスを実行しているユーザーに変更します。

Edge をアップグレードすると、/opt/apigee/customer/application ディレクトリにある .properties ファイルが読み取られます。つまり、アップグレードするとコンポーネントに設定したプロパティが保持されます。

トークンの値を設定するには:

1. コンポーネントの .properties ファイルを編集します。
2. トークンの値を追加または変更します。次の例では、conf_http_HTTPRequest.line.limit プロパティの値を 10k に設定しています。

   conf_http_HTTPRequest.line.limit=10k

   トークンが複数の値を受け取る場合は、次の例のように各値をカンマで区切ります。

   conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

   このようなリストに新しい値を追加するには、通常、新しい値をリストの末尾に追加します。

3. コンポーネントを再起動します。

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   ここで、component_name は次のいずれかです。

   • apigee-cassandra（Cassandra）
   • apigee-openldap（OpenLDAP）
   • apigee-postgresql（PostgreSQL データベース）
   • apigee-qpidd（Qpidd）
   • apigee-sso（Edge SSO）
   • apigee-zookeeper（ZooKeeper）
   • edge-management-server（Management Server）
   • edge-management-ui（新しい Edge UI）
   • edge-message-processor（Message Processor）
   • edge-postgres-server（Postgres Server）
   • edge-qpid-server（Qpid Server）
   • edge-router（Edge Router）
   • edge-ui（Classic UI）

   たとえば、router.properties の編集後、Router を再起動します。

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

4. （省略可）configure -search オプションを使用して、トークン値が新しい値に設定されていることを確認します。例:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

   configure -search の詳細については、トークンの現在の値を確認するをご覧ください。

トークンを探す

ほとんどの場合、設定する必要のあるトークンはこのガイドに記載されています。ただし、フルネームまたはロケーションが不明な既存のトークンの値をオーバーライドする必要がある場合は、grep を使用してコンポーネントの source ディレクトリを検索します。

たとえば、Edge の以前のリリースで session.maxAge プロパティを設定し、その設定に使用されたトークン値を確認するには、次のように /opt/apigee/edge-ui/source ディレクトリのプロパティに grep を設定します。

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

結果は次の形式で表示されます。

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

次の例は、UI の session.maxAge トークンの値を示しています。

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

{T}{/T} タグ間の文字列は、UI の .properties ファイルで設定できるトークンの名前です。

現在コメントアウトされているトークンを設定する

一部のトークンは Edge 構成ファイルでコメントアウトされています。インストール ファイルまたはコンポーネント構成ファイルでコメントアウトされたトークンを設定しようとしても、その設定は無視されます。

Edge 構成ファイルでコメントアウトされたトークンの値を設定するには、次の形式の特別な構文を使用します。

conf/filename+propertyName=propertyValue

Message Processor の HTTPClient.proxy.host という名前のプロパティを設定するには、まずプロパティの grep でトークンを決定します。

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

grep コマンドは、トークン名を含む結果を返します。プロパティ名がどのようにコメントアウトされているか、# という接頭辞で示されています。

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

このプロパティの値を設定するには、次の例のように /opt/apigee/customer/application/message-processor.properties を編集しますが、特別な構文を使用します。

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

この場合は、プロパティ名の前に conf/http.properties+ を付ける必要がありますこれは、プロパティが含まれる構成ファイルの場所と名前の後に「+」を付けたものです。

Message Processor を再起動したら、ファイル /opt/apigee/edge-message-processor/conf/http.properties を調べます。

cat /opt/apigee/edge-message-processor/conf/http.properties

ファイルの最後に、設定されたプロパティが次の形式で表示されます。

conf/http.properties:HTTPClient.proxy.host=myhost.name.com