Edge の構成方法

Edge for Private Cloud v4.19.01

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

.properties ファイルを編集する手法を、code with config(CwC と略されることもあります)と呼びます。基本的に、code with config は .properties ファイルの設定に基づく Key-Value ルックアップ ツールです。code with config では、キーはトークンと呼ばれます。したがって、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 コンポーネントと、これらのコンポーネントを構成するために編集できるプロパティ ファイルを示します。

コンポーネント コンポーネント名 編集可能な構成ファイル
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
Edge UI edge-ui /opt/apigee/customer/application/ui.properties
Edge 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
新しい UE 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.propertiesmanagement-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