Edge の構成方法

Edge for Private Cloud v4.18.05

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

Apigee では、.properties ファイルを編集する手法を、config を使用したコードと呼びます。基本的に、code with config は .properties ファイル内の設定に基づく Key-Value ルックアップ ツールです。code with config では、キーはトークンと呼ばれます。したがって、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」から変更した場合は、chown を使用して Edge サービスを実行しているユーザーにファイルを移行します。

コンポーネントのプロパティを設定するには、対応する .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 トークンは制限された 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