边缘配置文件参考

以下是 9 个节点 Edge 安装的完整静默配置文件示例。根据您的配置,根据需要修改此文件。使用 -f 选项 setup.sh 以包含此文件。如需查看特定于每个拓扑的配置文件示例,请参阅安装 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=Apigee1234
    
    # FIPS_OS should be set to true when OPDK 4.53 or later is installed on 
    # FIPS enabled operating system
    FIPS_OS=false
    

下表包含有关这些属性的更多信息:

属性 备注
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

指定 OpenLDAP 密码。

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

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

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

如果您要连接到远程 LDAP 服务器,请将 USE_LDAP_REMOTE_HOST 设置为 y。管理服务器未安装 OpenLDAP。

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

LDAP_TYPE
LDAP_SID
LDAP_PEER

对于不进行复制的 OpenLDAP,请将 LDAP_TYPE 设为 1。LDAP_TYPE=2 对应于使用复制功能的 OpenLDAP。

如果您的 Edge 拓扑使用单个 OpenLDAP 服务器,请指定 1。如果您的 Edge 安装使用多个 OpenLDAP 节点(例如 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 名称。所有 ZooKeeper 节点上的 IP 地址或 DNS 名称必须按相同的顺序列出。

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

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

只有在创建多个数据中心(如 12 台主机安装中所述)时,才能在 ZooKeeper 节点上指定 ":observer" 修饰符。在单个数据中心安装中,省略该修饰符。如需了解详情,请参阅包含 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 个节点。前两个节点用作“种子服务器”。因此,所有 Cassandra 节点上的 IP 地址都必须按相同的顺序列出。

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

IP_address[:data_center_number,rack_number]

Cassandra 节点可以选择指定 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 用户名和密码。

安装完成后,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 用户凭据,请省略 SMTPUSERSMTPPASSWORD

SMTPMAILFROM”为必填字段。

CASS_JMX_USERNAME Cassandra JMX 用户名。如果您启用了 Cassandra JMX 身份验证,则必须提供此值。
CASS_JMX_PASSWORD Cassandra JMX 密码。如果您启用了 Cassandra JMX 身份验证,则必须提供此值。
CASS_JMX_TRUSTSTORE Cassandra JMX SSL 信任库用户名(如果您已在 Cassandra 中启用基于 SSL 的 JMX)。 Apigee 用户应可以读取 JMX 信任库文件。
CASS_JMX_TRUSTSTORE_PASS Cassandra JMX SSL 信任库密码(如果您已在 Cassandra 中启用基于 SSL 的 JMX)。
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
这些凭据提供对 Qpid 代理的 Qpid Web 管理控制台的访问权限。Web 管理控制台提供了一个简单直观的界面,用于管理和控制 Qpid 代理。
FIPS_OS FIPS_OS 可以是 true 或 false,默认为 false。在启用了 FIPS 的操作系统上,将适用于私有云的 Edge 设置为 4.53.00 或更高版本。

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