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

以下に、9 ノードの Edge インストールの完全なサイレント構成ファイルの例を示します。このファイルは、構成に応じて編集してください。このファイルを含めるには、setup.sh-f オプションを使用します。各トポロジに固有の構成ファイルの例については、Edge コンポーネントをインストールするをご覧ください。

# IP address or DNS name of nodes.
IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra (IP address only; do not use a DNS name)
IP2=192.168.1.2  # ZooKeeper, Cassandra (IP address only; do not use a DNS name)
IP3=192.168.1.3  # ZooKeeper, Cassandra (IP address only; do not use a DNS name)
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.

# If you are using region names other than dc-1, dc-2 etc, set this property to map your region
# name to the appropriate dc-x format region name. This property is required by Management server
# to appropriately register Cassandra data stores based on Cassandra's data centers and regions.
REGION_MAPPING="<custom-region-1>:dc-1 <custom-region-2>:dc-2 ... <custom-region-x>:dc-x"

# 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 addresses of the Cassandra hosts (previously defined; do not use DNS names)
# 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>"

# The following four properties are only effective for Management server:
# Cassandra JMX uname/pword required if you enabled Cassandra JMX authentication.
# CASS_JMX_USERNAME =
# CASS_JMX_PASSWORD =

# Cassandra JMX SSL truststore details if you have enabled SSL based JMX in Cassandra.
# JMX Truststore file should be readable by Apigee user
# CASS_JMX_TRUSTSTORE =
# CASS_JMX_TRUSTSTORE_PASS =
    
# Set up username and password to access Qpid broker's management console

QPID_MGMT_USERNAME=qpid
QPID_MGMT_PASSWORD=pass1234

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

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

Cassandra ホストの定義には IP アドレスのみを使用し、DNS 名は使用しないでください。

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 ディレクトリに保存し、そのファイルの chmod 777 にします。このファイルは Edge インストール ディレクトリにコピーされます。

APIGEE_LDAPPW

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

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

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

USE_LDAP_REMOTE_HOST が n の場合、Edge は 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 ノードの本番環境など、Edge のインストールで複数の OpenLDAP ノードを使用する場合は、2 を指定します。

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

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

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

複数データセンターのインストールでは、インストールするデータセンターに応じて、値は dc-1 や dc-2 などになります。ただし、dc-# の形式の名前のみを使用できるわけではありません。リージョンには任意の名前を使用できます。

REGION_MAPPING

dc-1、dc-2 など以外のリージョン名を使用している場合は、このプロパティを設定して、リージョン名を適切な dc-x 形式のリージョン名にマッピングします。このプロパティは、管理サーバーが Cassandra のデータセンターとリージョンに基づいて Cassandra データストアを適切に登録するために必要です。

ZK_HOSTS

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

HOSTIP には、ZK_HOSTS と同じ形式を使用します。つまり、ZK_HOSTS に IP アドレスを指定する場合は、HOSTIP の IP アドレスを使用します。DNS を使用する場合は、両方に DNS 名を使用します。

マルチ データセンター環境では、両方のデータセンターのすべての ZooKeeper ノードをリストアップします。

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

ZK_CLIENT_HOSTS

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

HOSTIP には、ZK_CLIENT_HOSTS と同じ形式を使用します。つまり、ZK_CLIENT_HOSTS に IP アドレスを指定する場合は、HOSTIP の IP アドレスを使用します。DNS を使用する場合は、両方に DNS 名を使用します。

単一データセンター インストールでは、ZK_HOSTS で指定されたノードと同じノードになります。

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

CASS_CLUSTERNAME 必要に応じて、Cassandra クラスタの名前を指定します。デフォルト名は「Apigee」です。
CASS_HOSTS

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

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

リスト内の各エントリの構文は次のとおりです。

IP_address[:data_center_number,rack_number]

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

たとえば、'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 のユーザー名とパスワードを渡すことができます。

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

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG は、構成ファイルに対する変更の記録方法を制御します。CONFIG_DELTA_LOG=y を設定した場合、コンポーネントの構成変更はログに記録されません。

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」は入力が必須です。

CASS_JMX_USERNAME Cassandra JMX のユーザー名。Cassandra JMX 認証を有効にした場合は必須です。
CASS_JMX_PASSWORD Cassandra JMX のパスワード。Cassandra JMX 認証を有効にした場合は必須です。
CASS_JMX_TRUSTSTORE Cassandra で SSL ベースの JMX を有効にしている場合、Cassandra JMX SSL トラストストアのユーザー名。JMX トラストストア ファイルは、Apigee ユーザーが読み取り可能である必要があります。
CASS_JMX_TRUSTSTORE_PASS Cassandra で SSL ベースの JMX を有効にしている場合は、Cassandra JMX SSL トラストストアのパスワード。
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
これらの認証情報により、Qpid ブローカーの Qpid Web 管理コンソールにアクセスできます。ウェブ管理コンソールには、Qpid ブローカーの管理と制御のためのシンプルで直感的なインターフェースが用意されています。

ここに記載されているプロパティ以外にも、Apigee mTLS を構成するためのプロパティがあります。詳細については、Apigee mTLS の構成をご覧ください。