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

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

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

ENABLE_DYNAMIC_HOSTIP

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

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

ADMIN_EMAIL
APIGEE_ADMINPW

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

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

LICENSE_FILE

Расположение файла лицензии, который должен быть доступен пользователю apigee. Например, сохраните его в каталоге /tmp и задайте для него права доступа 777. Файл будет скопирован в каталог установки Edge.

APIGEE_LDAPPW

Указывает пароль SymasLDAP.

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

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Если USE_LDAP_REMOTE_HOST имеет значение n, Edge автоматически устанавливает SymasLDAP при установке сервера управления.

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

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

LDAP_TYPE
LDAP_SID
LDAP_PEER

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

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

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

  • LDAP_SID=1 - Unique ID for this LDAP server. У каждого узла 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 могут дополнительно указывать центр обработки данных и стойку узла 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 в следующем формате:

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

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

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

Необходимо заполнить поле "SMTPMAILFROM".

CASS_JMX_USERNAME Имя пользователя JMX Cassandra. Требуется, если вы включили аутентификацию JMX Cassandra.
CASS_JMX_PASSWORD Пароль JMX Cassandra. Требуется, если вы включили аутентификацию JMX Cassandra.
CASS_JMX_TRUSTSTORE Имя пользователя хранилища доверенных сертификатов SSL JMX Cassandra, если вы включили JMX на основе SSL в Cassandra. Файл хранилища доверенных сертификатов JMX должен быть доступен для чтения пользователю Apigee.
CASS_JMX_TRUSTSTORE_PASS Пароль хранилища доверенных сертификатов SSL JMX Cassandra, если вы включили JMX на основе SSL в Cassandra.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Эти учетные данные предоставляют доступ к веб-консоли управления Qpid брокера Qpid. Консоль управления Qpid – это простой и интуитивно понятный интерфейс для управления брокером Qpid.
FIPS_OS FIPS_OS может принимать значения true или false. По умолчанию используется значение false. Установите значение true для Edge for Private Cloud версии 4.53.00 или более поздней в операционных системах с поддержкой FIPS.

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