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

Ниже показан пример полного файла автоматической конфигурации для установки Edge с 9 узлами. Отредактируйте этот файл, если это необходимо для вашей конфигурации. Используйте опцию -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 =

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

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

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

ENABLE_SYSTEM_CHECK

Если «y», убедитесь, что система соответствует требованиям к процессору и памяти для устанавливаемого компонента. Требования к каждому компоненту см. в разделе «Требования к установке» .

Значение по умолчанию — «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 при установке сервера управления.

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

Если вы подключаетесь к удаленному серверу OpenLDAP, используйте LDAP_HOST и LDAP_PORT чтобы указать IP-адрес или DNS-имя и номер порта хоста.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Установите LDAP_TYPE =1 для OpenLDAP без репликации. LDAP_TYPE =2 соответствует OpenLDAP с репликацией.

Если в вашей топологии Edge используется один сервер OpenLDAP, укажите 1. Если в вашей установке Edge используется несколько узлов OpenLDAP, например, в производственной установке из 13 узлов, укажите 2.

Если вы включили репликацию, установите следующие свойства:

  • LDAP_SID =1 — уникальный идентификатор этого сервера LDAP. Каждый узел LDAP использует свой идентификатор. Например, установите значение 2 для узла LDAP.
  • LDAP_PEER =10.0.0.1 — IP- или DNS-имя узла LDAP.
MP_POD Укажите имя модуля «Обработчик сообщений и маршрутизатор». По умолчанию имя — шлюз.
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 могут дополнительно указать центр обработки данных и стойку узла 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

Установите для включения репликации Master-Standby Postgres в форме:

PG_MASTER=IPofNewMaster
PG_STANDBY=IPofOldMaster
SKIP_SMTP
SMTPHOST
SMTPUSER
SMTPPASSWORD
SMTPSSL
SMTPPORT
SMTPMAILFROM

Настройте SMTP, чтобы Edge мог отправлять электронные письма о потерянных паролях и другие уведомления.

Если учетные данные пользователя SMTP не требуются, опустите SMTPUSER и SMTPPASSWORD .

Требуется SMTPMAILFROM .

CASS_JMX_USERNAME Имя пользователя Кассандра JMX. Требуется, если вы включили аутентификацию Cassandra JMX.
CASS_JMX_PASSWORD Пароль Кассандры JMX. Требуется, если вы включили аутентификацию Cassandra JMX.
CASS_JMX_TRUSTSTORE Имя пользователя хранилища доверенных сертификатов Cassandra JMX SSL, если вы включили JMX на основе SSL в Cassandra. Файл JMX Truststore должен быть доступен для чтения пользователю Apigee.
CASS_JMX_TRUSTSTORE_PASS Пароль хранилища доверенных сертификатов Cassandra JMX SSL, если вы включили JMX на основе SSL в Cassandra.

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