Edge の構成方法

インストール後に 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 ファイルの階層を検索して、トークンの現在の値を特定します。

次の例では、ルーターの 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 コンポーネントと、それらのコンポーネントを構成するために編集できるプロパティ ファイルを示します。

コンポーネント コンポーネント名 編集可能な構成ファイル
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
Apigee SSO apigee-sso /opt/apigee/customer/application/sso.properties
管理サーバー edge-management-server /opt/apigee/customer/application/management-server.properties
Message Processor edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
Classic UI（新しい Edge UI には影響しません） edge-ui /opt/apigee/customer/application/ui.properties
Edge UI（新しい Edge UI のみ。Classic UI には影響しません） apigee-management-ui 該当なし（インストール構成ファイルを使用）
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
Postgres サーバー edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
PostgreSQL データベース apigee-postgresql /opt/apigee/customer/application/postgressql.properties
Qpid サーバー edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
Qpidd apigee-qpidd /opt/apigee/customer/application/qpidd.properties
ルーター edge-router /opt/apigee/customer/application/router.properties
Zookeeper apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

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

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

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

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

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

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

オーナー ファイル名またはディレクトリ
インストール 
/opt/apigee/token
コンポーネント 
/opt/apigee/component_name/conf

ここで 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）

トークン値を設定する

変更できるのは、/opt/apigee/customer/application ディレクトリ内の .properties ファイルのみです。各コンポーネントには、そのディレクトリに独自の .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

Trace UI の [リクエストの送信] セクションからのリクエスト用に転送プロキシを構成する

このセクションでは、オプションのプロキシ認証情報を使用して、Trace UI の [リクエストの送信] セクションからのリクエスト用に転送プロキシを構成する方法について説明します。 転送プロキシを構成するには:

  1. /opt/apigee/customer/application/ui.properties を編集して、ファイルのオーナーを apigee:apigee にします。
  2. 次のオーバーライドを追加します（特定のプロキシ構成に値を変更します）。 
    conf_application_http.proxyhost=proxy.example.com
conf_application_http.proxyport=8080
conf_application_http.proxyuser=apigee
conf_application_http.proxypassword=Apigee123!
  3. Classic UI を保存して再起動します。