Edge 構成ファイル リファレンス

次の例は、Edge を 9 ノード構成でインストールする場合の完全なサイレント構成ファイルを示しています。実際の構成に応じてこのファイルを適宜編集してください。setup.sh を実行するときに -f オプションでこのファイルを指定します。各トポロジに固有の構成ファイルの例については、Edge コンポーネントをインストールするをご覧ください。

    # IP address or DNS name of nodes.
    IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra
    IP2=192.168.1.2  # ZooKeeper, Cassandra
    IP3=192.168.1.3  # ZooKeeper, Cassandra
    IP4=192.168.1.4  # Router, Message Processor
    IP5=192.168.1.5  # Router, Message Processor
    IP6=192.168.1.6  # Qpid
    IP7=192.168.1.7  # Qpid
    IP8=192.168.1.8  # Postgres
    IP9=192.168.1.9  # Postgres

    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
    HOSTIP=$(hostname -i)

    # Specify "y" to check that the system meets the CPU and memory requirements
    # for the component being installed. See Installation Requirements for requirements
    # for each component. The default value is "n" to disable check.
    ENABLE_SYSTEM_CHECK=n

    # When "hostname -i" returns multiple IP addresses,
    # set to "y", to have the installer prompt you to select the IP address to use.
    ENABLE_DYNAMIC_HOSTIP=n

    # Set Edge sys admin credentials.
    ADMIN_EMAIL=your@email.com
    APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

    # Location of Edge license file.
    LICENSE_FILE=/tmp/license.txt

    # Management Server information.
    MSIP=$IP1    # IP or DNS name of Management Server node.
    # Specify the port the Management Server listens on for API calls.
    # APIGEE_PORT_HTTP_MS=8080    # Default is 8080.

    #
    # OpenLDAP information.
    #
    # Set to y if you are connecting to a remote LDAP server.
    # If n, Edge installs OpenLDAP when it installs the Management Server.
    USE_LDAP_REMOTE_HOST=n

    # If connecting to remote OpenLDAP server, specify the IP/DNS name and port.
    # LDAP_HOST=$IP1    # IP or DNS name of OpenLDAP node.
    # LDAP_PORT=10389   # Default is 10389.
    APIGEE_LDAPPW=yourLdapPassword

    # Specify OpenLDAP without replication, 1, or with replication, 2.
    LDAP_TYPE=1

    # Set only if using replication.
    # LDAP_SID=1    # Unique ID for this LDAP server.
    # LDAP_PEER=    # IP or DNS name of LDAP peer.

    # The Message Processor and Router pod.
    MP_POD=gateway

    # The name of the region, corresponding to the data center name.
    REGION=dc-1 # Use dc-1 unless installing in a
                # multi-data center environment.

    # ZooKeeper information.
    # See table below if installing in a multi-data center environment.
    ZK_HOSTS="$IP1 $IP2 $IP3"         # IP/DNS names of all ZooKeeper nodes.
    ZK_CLIENT_HOSTS="$IP1 $IP2 $IP3"  # IP/DNS names of all ZooKeeper nodes.

    # Cassandra information.
    CASS_CLUSTERNAME=Apigee    # Default name is Apigee.

    # Space-separated IP/DNS names of the Cassandra hosts (previously defined)
    # Syntax is: IP_address:host_number,rack_number
    CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"

    # Set to enable Cassandra authentication.
    # CASS_AUTH=y    # The default value is n.
    # Cassandra uname/pword required if you enabled Cassandra authentication.
    # CASS_USERNAME=
    # CASS_PASSWORD=''

    # Postgres username and password as set when you installed Edge.
    # Default is apigee:postgres.
    PG_USER=apigee
    PG_PWD=postgres

    # Use to enable Postgres master-standby replication
    # when you have multiple Postgres nodes.
    # PG_MASTER=IPorDNSofNewMaster
    # PG_STANDBY=IPorDNSofOldMaster

    # SMTP information.
    SKIP_SMTP=n       # Skip now and configure later by specifying "y".
    SMTPHOST=smtp.gmail.com
    SMTPUSER=your@email.com
    SMTPPASSWORD=yourEmailPassword
    SMTPSSL=y
    SMTPPORT=465      # If no SSL, use a different port, such as 25.
    SMTPMAILFROM="My Company <myco@company.com>"
    

次の表は、これらのプロパティに関する追加情報を示しています。

プロパティ
IP / DNS 名 ノードの IP アドレスを指定するときは、127.0.0.1 へのホスト名マッピングまたは 127.0.0.1 の IP アドレスを使用しないでください。
ENABLE_SYSTEM_CHECK

y に設定すると、インストールするコンポーネントの CPU とメモリの要件をシステムが満たしているかどうかがチェックされます。各コンポーネントの要件については、インストール要件をご覧ください。

デフォルト値は n で、このチェックは行われません。

ENABLE_DYNAMIC_HOSTIP

サーバーに複数のインターフェース カードが搭載されている場合、hostname -i コマンドはスペースで区切られた IP アドレスのリストを返します。デフォルトでは、Edge インストーラは返ってきたリストの最初の IP アドレスを使用しますが、必ずしも正しい IP アドレスというわけではありません。代わりの方法として、インストール構成ファイルで次のプロパティを設定できます。

y に設定すると、インストール中に使用する IP アドレスを選択するよう求められます。デフォルト値は n です。

ADMIN_EMAIL
APIGEE_ADMINPW

システム管理者のパスワードは 8 文字以上で、大文字、小文字、数字、特殊文字を 1 文字含める必要があります。パスワードを省略すると、パスワードの入力が求められます。

インストールが完了した後、構成ファイルからパスワードを削除することをおすすめします。

LICENSE_FILE

ライセンス ファイルの場所。これは「apigee」ユーザーがアクセス可能である必要があります。たとえば、ライセンス ファイルを /tmp ディレクトリに保存し、ファイルのモードを 777 に変更します。このファイルは Edge インストール ディレクトリにコピーされます。

APIGEE_LDAPPW

OpenLDAP パスワードを指定します。

インストールが完了した後、構成ファイルからパスワードを削除することをおすすめします。

LDAP_HOSTLDAP_PORTUSE_LDAP_REMOTE_HOST

USE_LDAP_REMOTE_HOST を n に設定すると、Management Server のインストール時に OpenLDAP が自動的にインストールされます。

リモートの LDAP サーバーに接続する場合は、USE_LDAP_REMOTE_HOST を y に設定します。OpenLDAP は Management Server とともにインストールされません。

リモートの OpenLDAP サーバーに接続する場合は、LDAP_HOSTLDAP_PORT を使用してそのホストの IP アドレスまたは DNS 名とポート番号を指定します。

LDAP_TYPE
LDAP_SID
LDAP_PEER

レプリケーションなしの OpenLDAP の場合は、LDAP_TYPE=1 に設定します。LDAP_TYPE=2 は、レプリケーションありの OpenLDAP に対応します。

Edge トポロジで単一の OpenLDAP サーバーを使用する場合は、1 を指定します。13 ノード プロダクション インストールなど、複数の OpenLDAP ノードを Edge インストールで使用する場合は 2 を指定します。

レプリケーションを有効にする場合は、次のプロパティを設定します。

  • LDAP_SID=1 - この LDAP サーバーの一意の ID。LDAP ノードごとに異なる ID を使用します。たとえば、LDAP ピアの場合は 2 に設定します。
  • LDAP_PEER=10.0.0.1 - LDAP ピアの IP または DNS 名。
MP_POD Message Processor と Router ポッドの名前を指定します。デフォルトの名前は gateway です。
REGION

リージョン名。一般には、名前は通常 dc-# の形式で、# は整数値に対応しています。たとえば、dc-1、dc-2 などです。マルチ データセンター環境にインストールしない限り、dc-1 を使用できます。

マルチ データセンター構成の場合は、インストールするデータセンターに応じて値を dc-1、dc-2 などに設定します。ただし、必ずしもリージョン名を dc-# の形式にする必要はありません。リージョンには任意の名前を付けることができます。

ZK_HOSTS

ZooKeeper ノードの IP アドレスまたは DNS 名。すべての ZooKeeper ノードで、IP アドレスまたは DNS 名を同じ順序で列挙する必要があります。

HOSTIPZK_HOSTS には同じ形式を使用します。つまり、HOSTIP に対して IP アドレスを使用する場合は ZK_HOSTS でも IP アドレスを使用します。DNS を使用する場合は、両方のプロパティで DNS を使用します。

マルチ データセンター環境では、すべてのデータセンターのすべての ZooKeeper ノードを列挙します。

ZooKeeper ノードの :observer 修飾子は、12 ホスト構成で説明されているように複数のデータセンターを作成する場合にのみ指定します。単一のデータセンター インストールでは、修飾子を省略します。詳細については、12 ホストクラスタ インストールをご覧ください。

ZK_CLIENT_HOSTS

このデータセンターで使用する ZooKeeper ノードの IP アドレスまたは DNS 名。すべての ZooKeeper ノードで、IP アドレスまたは DNS 名を同じ順序で列挙する必要があります。

HOSTIPZK_CLIENT_HOSTS には同じ形式を使用します。つまり、HOSTIP に対して IP アドレスを使用する場合は ZK_CLIENT_HOSTS でも IP アドレスを使用します。DNS を使用する場合は、両方のプロパティで DNS を使用します。

単一データセンター環境では、これらは ZK_HOSTS で指定したのと同じノードになります。

マルチ データセンター環境では、このデータセンターに属する ZooKeeper ノードのみを列挙します。詳細については、12 ホストクラスタ インストールをご覧ください。

CASS_CLUSTERNAME (省略可)Cassandra クラスタの名前を指定します。デフォルトの名前は Apigee です。
CASS_HOSTS

Cassandra ノードのホスト IP アドレス(DNS 名ではない)のカンマ区切りのリストを指定します。必要に応じて、そのデータセンター番号と所属するラックも指定できます。

本番環境トポロジの場合、このリストには少なくとも 3 つのノードが必要です。最初の 2 つのノードは「シードサーバー」として使用されます。そのため、それらの IP アドレスはすべての Cassandra ノードで同じ順序で列挙されている必要があります。

リストの各項目の構文は次のとおりです。


IP_address[:data_center_number,rack_number]

必要に応じて Cassandra ノードのデータセンターとラックを指定できます。data_center_number 修飾子は、12 ホスト構成で説明されているように複数のデータセンターを作成する場合にのみ指定します。単一データセンター環境では、この修飾子は省略します。

たとえば、「192.168.124.201:1,1」はデータセンター 1 のラック / アベイラビリティ ゾーン 1 を表し、「192.168.124.204:2,1」 はデータセンター 2 のラック / アベイラビリティ ゾーン 1 を表します。

マルチ データセンター環境で CASS_HOSTS を指定する場合は、ファイアウォールの問題を克服するため、(上記の例に示すように)現在のデータセンターのノードが最初に来るように並べる必要があります。詳細については、12 ホストクラスタ インストールをご覧ください。

Cassandra ホストの rack_number の指定については、Cassandra ラックのサポートを追加するをご覧ください。

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Cassandra 認証を有効にする場合は、CASS_AUTH を y に設定し、これらのプロパティを使用して Cassandra のユーザー名とパスワードを渡すことができます。

インストールが完了した後、構成ファイルからパスワードを削除することをおすすめします。

PG_USER
PG_PWD

デフォルトで、PostgreSQL データベースには postgres と apigee の 2 つのユーザーが設定されています。

PG_USER を使用して、apigee ユーザーのユーザー名を変更できます。postgres ユーザーの名前は変更できません。

デフォルトで、PostgreSQL データベースには、postgres と apigee の 2 つのユーザーが設定されています。どちらのユーザーも、デフォルトのパスワードは「postgres」です。PG_PWD を使用して、インストール時に両方のユーザーのパスワードを別の値に設定します。

インストールが完了した後、構成ファイルからパスワードを削除することをおすすめします。

PG_MASTER
PG_STANDBY

次の形式で、Postgres のマスター / スタンバイ レプリケーションを有効に設定します。


PG_MASTER=IPorDNSofNewMaster
    PG_STANDBY=IPorDNSofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

パスワード紛失やその他の通知メールを Edge から送信できるように、SMTP を構成します。

SMTP ユーザーの認証情報が不要な場合、SMTPUSERSMTPPASSWORD は省略します。

SMTPMAILFROM は必須です。

追加情報については、以下をご覧ください。