Справочник по файлу конфигурации Edge

Ниже приведен пример полного файла конфигурации для установки 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=IPofNewMaster
# PG_STANDBY=IPofOldMaster

# 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 =
    
# Use this property to enable logging of delta changes to configuration files. To disable, set the value to 'n'.
CONFIG_DELTA_LOG=y

В таблице ниже приведена дополнительная информация об этих свойствах.

Свойство Примечание
IP-адреса и имена DNS При указании IP-адреса узла не используйте имя хоста, сопоставленное с адресом 127.0.0.1, или IP-адрес 127.0.0.1.

Обратите внимание, что для определений хостов Cassandra следует использовать только IP-адреса, а не имена DNS.

ENABLE_SYSTEM_CHECK

Если вы ввели "y", убедитесь, что система соответствует требованиям к ЦП и памяти для устанавливаемого компонента. Требования к каждому компоненту приведены в разделе Требования к установке.

Значение по умолчанию – n (проверка отключена).

ENABLE_DYNAMIC_HOSTIP

Если у сервера несколько сетевых карт, команда hostname -i возвращает список IP-адресов, разделенных пробелами. По умолчанию установщик Edge использует первый возвращенный IP-адрес, который не всегда может быть правильным. В качестве альтернативы вы можете задать следующее свойство в файле конфигурации установки.

Если задано значение "y", установщик предложит выбрать IP-адрес, который будет использоваться при установке. Значение по умолчанию – n.

ADMIN_EMAIL
APIGEE_ADMINPW

Пароль системного администратора должен содержать не менее восьми символов, включая одну прописную букву, одну строчную букву, одну цифру или один специальный символ. Если вы не укажете пароль, вам будет предложено ввести его.

После завершения установки 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 при установке Management Server.

Если вы подключаетесь к удаленному серверу LDAP, задайте для параметра USE_LDAP_REMOTE_HOST значение y. OpenLDAP не устанавливается вместе с сервером управления.

Если вы подключаетесь к удаленному серверу OpenLDAP, используйте LDAP_HOST и LDAP_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. У каждого узла LDAP свой идентификатор. Например, для однорангового узла LDAP задайте значение 2.
  • LDAP_PEER=10.0.0.1 – IP-адрес или DNS-имя узла LDAP.
MP_POD Укажите название пода Message Processor и Router. По умолчанию используется название 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

IP-адреса или имена DNS узлов ZooKeeper. IP-адреса или имена DNS должны быть указаны в одном и том же порядке на всех узлах ZooKeeper.

Используйте для атрибута HOSTIP тот же формат, что и для атрибута ZK_HOSTS. То есть если вы указываете IP-адрес для ZK_HOSTS, используйте IP-адрес и для HOSTIP. Если вы используете DNS, укажите имя DNS для обоих адресов.

В среде с несколькими центрами обработки данных перечислите все узлы ZooKeeper из обоих центров обработки данных.

Указывайте модификатор :observer в узлах ZooKeeper, только когда создаете несколько центров обработки данных, как описано в инструкциях по установке на 12 хостах. Если у вас один центр обработки данных, опустите этот модификатор. Подробнее о кластерной установке с 12 хостами…

ZK_CLIENT_HOSTS

IP-адреса или DNS-имена узлов ZooKeeper, используемых этим центром обработки данных. IP-адреса или DNS-имена должны быть перечислены в одном и том же порядке на всех узлах ZooKeeper.

Используйте для атрибута HOSTIP тот же формат, что и для атрибута ZK_CLIENT_HOSTS. То есть если вы указываете IP-адрес для ZK_CLIENT_HOSTS, используйте IP-адрес и для HOSTIP. Если вы используете DNS, укажите имя DNS для обоих адресов.

В случае установки в одном центре обработки данных это те же узлы, которые указаны в свойстве ZK_HOSTS.

В среде с несколькими центрами обработки данных перечислите только узлы ZooKeeper в этом центре обработки данных. Подробнее о кластерной установке с 12 хостами…

CASS_CLUSTERNAME При необходимости укажите название кластера Cassandra. По умолчанию используется название Apigee.
CASS_HOSTS

Указывает разделенный запятыми список IP-адресов хостов узлов Cassandra (не DNS-имен) и, при необходимости, номер их центра обработки данных и стойку, к которой они принадлежат.

Для рабочих топологий в этом списке должно быть не менее трех узлов. Первые два узла используются в качестве серверов начальной загрузки. В результате 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 хостами…

Информацию о том, как указать rack_number для хоста Cassandra, можно найти в разделе Как добавить поддержку стойки 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 master-standby, в следующем формате:

PG_MASTER=IPofNewMaster
PG_STANDBY=IPofOldMaster
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 JMX SSL, если вы включили JMX на основе SSL в Cassandra. Файл хранилища доверенных сертификатов JMX должен быть доступен для чтения пользователю Apigee.
CASS_JMX_TRUSTSTORE_PASS Пароль хранилища доверенных сертификатов Cassandra JMX SSL, если вы включили JMX на основе SSL в Cassandra.
CONFIG_DELTA_LOG Управляет ведением журнала изменений конфигурации. Чтобы распечатать изменения конфигурации, задайте для этого параметра значение "y". Чтобы отключить печать изменений конфигурации, задайте значение n.

Помимо перечисленных здесь свойств, существуют свойства для настройки Apigee mTLS. Подробнее о том, как настроить mTLS в Apigee…