Edge の構成方法

Edge for Private Cloud v4.18.05

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

Apigee では、.properties ファイルを編集する手法を「構成を含むコード」と呼びます。基本的に、コードと構成は、.properties ファイルの設定に基づく Key-Value ルックアップ ツールです。構成ファイルを含むコードでは、キーはトークンと呼ばれます。したがって、Edge を構成するには、.properties ファイルにトークンを設定します。

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

これを階層として考えると、設定は次のように配置され、お客様の設定が最も優先度が高く、インストーラ チームまたは Apigee の設定をオーバーライドします。

  1. お客様
  2. インストーラ
  3. Apigee

.properties ファイルの使用方法

お客様は、/opt/apigee/customer/application ディレクトリ内の .properties ファイルのみを変更できます。各コンポーネントには、そのディレクトリに独自の .properties ファイルがあります。たとえば、router.properties や management-server.properties です。

たとえば、.properties ファイルを作成するには、次のようにします。

  1. 任意のユーザーとしてエディタでファイルを作成します。
  2. chown を使用して、ファイルの所有者を「apigee:apigee」に変更します。Edge サービスを実行しているユーザーを「apigee」ユーザーから変更した場合は、Edge サービスを実行しているユーザーにファイルを chown します。

コンポーネントのプロパティを設定するには、対応する .properties ファイルを編集してトークンを設定し、コンポーネントを再起動します。

/opt/apigee/apigee-service/bin/apigee-service component restart

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

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

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

.properties ファイルの場所

Edge コンポーネントの .properties ファイルには、インストール、オーナー、お客様の 3 つの最上位ディレクトリがあります。デフォルトの場所を次の表に示します。

オーナー デフォルトのトークン ルート ディレクトリ
コンポーネント 
/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/token
お客様 
/opt/apigee/customer

トークンの現在の値を特定する

コンポーネントの .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

.properties ファイルでトークンを設定する

トークンの値をオーバーライドするには:

  1. コンポーネントの .properties ファイルを編集して、トークン値を設定します。ファイルが存在しない場合は作成します。
  2. コンポーネントを再起動します。
  3. トークン値を確認します。

たとえば、Edge Router のリクエスト行の上限を設定するには、次のようにします。

  1. /opt/apigee/customer/application/router.properties ファイルを編集して、conf_http_HTTPRequest.line.limit トークンを設定します。
    conf_http_HTTPRequest.line.limit=8k
  2. Edge Router を再起動します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  3. トークンの値を確認します。
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

複数の値を取るトークンを設定する

一部のトークンは、カンマ区切りの値のリストを受け取ります。たとえば、conf_security_rbac.restricted.resources トークンは、sysadmin のみが呼び出せるように制限された URI のリストを受け取ります。conf_security_rbac.restricted.resources の値を確認するには:

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

出力には次のものが含まれます。

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

値のリストを受け取るトークンを設定するには、.properties ファイル内のトークンの現在の値に新しい値を追加します。したがって、URI /myuri/* を conf_security_rbac.restricted.resources に追加するには、次のように /opt/apigee/customer/application/management-server.properties ファイルを編集します。

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

トークンを見つける

ほとんどの場合、設定する必要があるトークンはこのガイドで特定されています。ただし、プロパティのオーバーライドに使用されるトークンを特定する必要がある場合は、コンポーネントの source フォルダで grep を実行します。

たとえば、以前の Edge リリースで session.maxAge プロパティを設定したことがわかっていて、その設定に使用したトークン値を知りたい場合は、/opt/apigee/edge-ui/source ディレクトリ内のプロパティに対して grep を実行します。

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

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

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

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

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

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

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

conf/file.extension+propertyName=propertyValue

たとえば、Message Processor で HTTPClient.proxy.host という名前のプロパティを設定するとします。次に、プロパティの grep を使用してトークンを決定します。

cd /opt/apigee/edge-message-processor
grep -ri "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