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

Edge для частного облака версии 4.17.09

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

# IP (not DNS names) of the Cassandra hosts separated by spaces.
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 или IP-адрес 127.0.0.1.

ENABLE_SYSTEM_CHECK

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

По умолчанию проверка отключена (значение "n").

ENABLE_DYNAMIC_HOSTIP

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

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

Внимание! Если вы задали значение ENABLE_DYNAMIC_HOSTIP=y, убедитесь, что в файле свойств не задано значение HOSTIP.

ADMIN_EMAIL
APIGEE_ADMINPW

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

После завершения установки Apigee рекомендует удалить пароль из файла конфигурации.

LICENSE_FILE

Расположение файла лицензии, который должен быть доступен пользователю apigee. Например, сохраните его в каталоге /tmp и задайте для него права доступа 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_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 свой идентификатор. Например, для 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-#. Вы можете использовать любое название региона.

ZK_HOSTS

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

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

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

ZK_CLIENT_HOSTS

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

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

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

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

CASS_HOSTS

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

У узлов Cassandra может быть необязательный суффикс ":dc,ra", который указывает на центр обработки данных и стойку узла Cassandra. Укажите этот модификатор, только если вы создаете несколько центров обработки данных, как описано в разделе об установке на 12 хостах. Если вы устанавливаете продукт в одном центре обработки данных, не указывайте этот модификатор.

Например, "192.168.124.201:1,1" означает центр обработки данных 1 и стойку/зону доступности 1, а "192.168.124.204:2,1" – центр обработки данных 2 и стойку/зону доступности 1.

В среде с несколькими центрами обработки данных, чтобы избежать проблем с межсетевым экраном, хосты CASS_HOSTS должны быть упорядочены таким образом (как показано в примере выше), чтобы узлы текущего центра обработки данных находились в начале списка. Подробнее о кластерной установке на 12 хостов можно узнать в статье Как установить компоненты Edge на узле.

CASS_AUTH
CASS_USERNAME

CASS_PASSWORD

Если вы включили аутентификацию Cassandra (CASS_AUTH=y), вы можете передать имя пользователя и пароль Cassandra, используя следующие свойства:

После завершения установки Apigee рекомендует удалить пароль из файла конфигурации.

PG_USER
PG_PWD

По умолчанию в базе данных PostgreSQL определены два пользователя: postgres и apigee.

PG_USER позволяет изменить имя пользователя apigee. Имя пользователя postgres изменить нельзя.

У обоих пользователей пароль по умолчанию – 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 – обязательный параметр.