边缘配置文件参考

下面是一个完整的静默配置文件示例,用于安装 9 节点 Edge 安装。根据需要修改此文件以进行配置。使用 setup.sh 的 -f 选项 来包含此文件。如需查看特定于每种拓扑的配置文件示例,请参阅 安装 Edge 组件。

    # IP address or DNS name of nodes.
    IP1=192.168.1.1  # Management Server, SymasLDAP, 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.
    
    # SymasLDAP information.
    # Set to y if you are connecting to a remote LDAP server.
    # If n, Edge installs SymasLDAP when it installs the Management Server.
    USE_LDAP_REMOTE_HOST=n
    
    # If connecting to remote SymasLDAP server, specify the IP/DNS name and port.
    # LDAP_HOST=$IP1    # IP or DNS name of SymasLDAP node.
    # LDAP_PORT=10389   # Default is 10389.
    APIGEE_LDAPPW=yourLdapPassword
    
    # Specify SymasLDAP 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=Apigee1234
    

下表包含有关这些属性的其他信息:

属性 注意
IP/DNS 名称 指定节点的 IP 地址时,请勿使用映射到 127.0.0.1 的主机名或 IP 地址 127.0.0.1。

请注意,对于 Cassandra 主机定义,请仅使用 IP 地址;请勿使用 DNS 名称。

ENABLE_SYSTEM_CHECK

如果为“y”,请检查系统是否满足要安装的组件的 CPU 和内存要求 。如需了解每个组件的要求,请参阅安装 要求。

默认值为“n”,用于停用检查。

ENABLE_DYNAMIC_HOSTIP

如果服务器有多个接口卡,"hostname -i"命令会返回一个 以空格分隔的 IP 地址列表。默认情况下,Edge 安装程序会使用返回的第一个 IP 地址,但在某些情况下,该地址可能不正确。作为替代方案,您 可以在安装配置文件中设置以下属性。

如果设置为“y”,安装程序会提示您选择要在 安装中使用的 IP 地址。默认值为“n”。

ADMIN_EMAIL
APIGEE_ADMINPW

系统管理员的密码长度必须至少为 8 个字符,并且必须包含一个 大写字母、一个小写字母、一个数字或一个特殊字符。如果您省略 密码,系统会提示您输入密码。

安装完成后,Apigee 建议您从 配置文件中移除密码。

LICENSE_FILE

许可文件的位置,该位置必须可供“apigee”用户访问。 例如,将其存储在 /tmp 目录中,并对该文件执行 chmod 777。该文件会复制 到 Edge 安装目录。

APIGEE_LDAPPW

指定 SymasLDAP 密码。

安装完成后,Apigee 建议您从 配置文件中移除密码。

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

如果 USE_LDAP_REMOTE_HOST 为 n,Edge 会在安装管理服务器时自动安装 SymasLDAP。

如果您要连接到远程 LDAP 服务器,请将 USE_LDAP_REMOTE_HOST 设置为 y。SymasLDAP 不会随管理 服务器一起安装。

如果您要连接到远程 SymasLDAP 服务器,请使用 LDAP_HOST 和 LDAP_PORT 指定主机的 IP 地址 或 DNS 名称以及端口号。

LDAP_TYPE
LDAP_SID
LDAP_PEER

对于没有复制功能的 SymasLDAP,请设置 LDAP_TYPE=1。LDAP_TYPE=2 对应于具有复制功能的 SymasLDAP 。

如果您的 Edge 拓扑使用单个 SymasLDAP 服务器,请指定 1。如果您的 Edge 安装使用多个 SymasLDAP 节点(例如在 13 节点生产安装中), 请指定 2。

如果您启用复制功能,请设置以下属性:

  • LDAP_SID=1 - 此 LDAP 服务器的唯一 ID。每个 LDAP 节点都使用不同的 ID。例如,对于 LDAP 对等互连,请设置为 2。
  • LDAP_PEER=10.0.0.1 - LDAP 对等互连的 IP 或 DNS 名称。
MP_POD 指定消息处理器和路由器 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 名称。IP 地址或 DNS 名称 必须在所有 ZooKeeper 节点上按相同的顺序列出。

请对 HOSTIP 使用与 ZK_HOSTS 相同的格式。也就是说,如果您 为 ZK_HOSTS 指定 IP 地址,请为 HOSTIP 使用 IP 地址。如果您使用 DNS, 请对两者都使用 DNS 名称。

在多数据中心环境中,请列出两个数据中心的所有 ZooKeeper 节点。

仅当 创建多个数据中心(如 12 主机安装中所述)时,才在 ZooKeeper 节点上指定“:observer”修饰符。在单数据 中心安装中,请省略该修饰符。如需了解详情,请参阅 12 主机集群安装。

ZK_CLIENT_HOSTS

此数据中心使用的 ZooKeeper 节点的 IP 地址或 DNS 名称。IP 地址或 DNS 名称必须在所有 ZooKeeper 节点上按相同的顺序列出。

请对 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 名称), 并可选择指定其数据中心编号和 所属的机架。

对于生产拓扑,此列表中必须至少有三个节点。前两个节点用作“种子服务器”。因此,IP 地址必须在所有 Cassandra 节点上按相同的顺序列出。

列表中每个条目的语法如下所示:

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 用户 名和密码。

安装完成后,Apigee 建议您从 配置文件中移除密码。

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG 用于控制如何记录对 配置文件的更改。如果您设置了 CONFIG_DELTA_LOG=y ,则不会记录组件的配置更改。

PG_USER
PG_PWD

默认情况下,PostgreSQL 数据库定义了两个用户:“postgres”和 “apigee”。

您可以使用 PG_USER 更改“apigee”用户的用户名。您无法 更改“postgres”用户的名称。

默认情况下,PostgreSQL 数据库定义了两个用户:“postgres”和“apigee”。 这两个用户的默认密码均为“postgres”。您可以在安装时使用 PG_PWD 为这两个用户设置不同的密码值。

安装完成后,Apigee 建议您从 配置文件中移除密码。

PG_MASTER
PG_STANDBY

设置为启用 Postgres 主备复制,格式如下:

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

配置 SMTP,以便 Edge 可以发送有关密码丢失和其他通知的电子邮件。

如果不需要 SMTP 用户凭据,请省略 SMTPUSER 和 SMTPPASSWORD。

SMTPMAILFROM 是必需的。

CASS_JMX_USERNAME Cassandra JMX 用户名。如果您启用了 Cassandra JMX 身份验证,则此项为必填项。
CASS_JMX_PASSWORD Cassandra JMX 密码。如果您启用了 Cassandra JMX 身份验证,则此项为必填项。
CASS_JMX_TRUSTSTORE 如果您在 Cassandra 中启用了基于 SSL 的 JMX,则为 Cassandra JMX SSL truststore 用户名。JMX 信任库文件应可供 Apigee 用户读取。
CASS_JMX_TRUSTSTORE_PASS 如果您在 Cassandra 中启用了基于 SSL 的 JMX,则为 Cassandra JMX SSL truststore 密码。
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
这些凭据提供对 Qpid 代理的 Qpid Web 管理控制台的访问权限。 Web 管理控制台提供了一个简单直观的界面,用于管理 和控制 Qpid 代理。

除了此处列出的属性之外,还有用于配置 Apigee mTLS 的属性。 如需了解详情,请参阅配置 Apigee mTLS。