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

Edge for Private Cloud v4.19.01

次の例は、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)
    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 ディレクトリに保存してファイルに 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 ノード プロダクション インストールなど、複数の 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 名を列挙する必要があります。

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 名ではない)。最初の 2 つのノードはシードサーバーとして使用されます。すべての Cassandra ノード上で同じ順序で IP アドレスを列挙する必要があります。

Cassandra ノードには、Cassandra ノードのデータセンターとラックを指定するオプションの :dc,ra 接尾辞を付けることができます。この修飾子は、12-ホスト インストールで説明したように複数のデータセンターを作成する場合にのみ指定します。単一のデータセンター インストールでは、修飾子を省略します。

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

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

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 は必須です。

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