Edge for Private Cloud v4.18.01
インストール後に Edge を構成するには、.properties ファイルと Edge ユーティリティを組み合わせて使用します。たとえば、Edge UI で TLS/SSL を構成するには、.properties ファイルを編集して必要なプロパティを設定します。.properties ファイルを変更するには、影響を受ける Edge コンポーネントを再起動する必要があります。
Apigee では、.properties ファイルを編集する手法を config with code と呼んでいます。基本的に、config を使用するコードは .properties ファイルの設定に基づく Key-Value ルックアップ ツールです。構成の場合、この鍵はトークンと呼ばれます。そのため、Edge を構成するには、.properties ファイルでトークンを設定します。
code with config の場合、Edge コンポーネントの出荷時デフォルト値が設定されていますが、インストール チームはインストール トポロジに基づいてその設定をオーバーライドでき、その後、お客様は任意のプロパティをオーバーライドできます。
これを階層と見なすと、インストーラ チームまたは Apigee の設定をオーバーライドする顧客設定が特に優先されるよう設定されます。
- お客様
- インストーラ
- Apigee
.properties ファイルの使用方法
お客様は、/opt/apigee/customer/application ディレクトリにある .properties ファイルのみを変更できます。このディレクトリには、コンポーネントごとに固有の .properties ファイルがあります。たとえば、router.properties や management-server.properties などです。
たとえば、.properties ファイルを作成するには、次のコマンドを実行します。
- このファイルを任意のユーザーとしてエディタで作成します。
- ファイルの所有者を apigee:apigee に変更します。Edge サービスを実行するユーザーを apigee ユーザーから変更する場合は、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 ファイルには、インストール オーナーと customers という 3 つの最上位ディレクトリがあります。次の表にデフォルトのロケーションを示します。
警告: Edge のお客様は、/opt/apigee/customer 下にある .properties ファイルのみ変更できます。コンポーネントとインストール ディレクトリの下のファイルは表示できますが、ファイルを変更しないでください。
|
所有者 |
デフォルト トークンのルート ディレクトリ |
|---|---|
|
コンポーネント |
/opt/apigee/<接頭辞>-<コンポーネント名>/conf ここで、/<prefix>-<component> は、edge-router や apigee-cassandra などのコンポーネントを表します。 |
|
インストール |
/opt/apigee/token |
|
お客様 |
/opt/apigee/customer |
トークンの現在の値を確認する
コンポーネントの .properties ファイルでトークンを設定する前に、次のコマンドを使用して現在の値を確認できます。
> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token
comp はコンポーネントの名前、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 ファイルでトークンを設定する
トークンの値をオーバーライドするには:
- コンポーネントの .properties ファイルを編集してトークン値を設定します。ファイルが存在しない場合は作成します。
- コンポーネントを再起動します。
- トークンの値を確認します。
たとえば、Edge Router のリクエスト行の上限を設定するには、次のようにします。
- /opt/apigee/customer/application/router.properties ファイルを編集して conf_http_HTTPRequest.line.limit トークンを設定します。
conf_http_HTTPRequest.line.limit=8k - Edge Router を再起動します。
> /opt/apigee/apigee-service/bin/apigee-service edge-router restart - トークンの値を確認します。
> /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/*
トークンを探す
ほとんどの場合、設定する必要のあるトークンはこのガイドに記載されています。ただし、プロパティのオーバーライドに使用するトークンを決定する必要がある場合は、コンポーネントのソースソース フォルダで 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