Dokumentacja pliku brzegowego

Poniżej znajdziesz przykład kompletnego pliku konfiguracji instalacji nienadzorowanej dla 9-węzłowej instalacji Edge. W razie potrzeby zmodyfikuj ten plik, aby dostosować go do swojej konfiguracji. Aby uwzględnić ten plik, użyj opcji -f, aby setup.sh. Przykłady plików konfiguracji dla poszczególnych topologii znajdziesz w artykule Instalowanie komponentów 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

Poniższa tabela zawiera dodatkowe informacje o tych właściwościach:

Właściwość Uwaga
Adresy IP/nazwy DNS Podczas określania adresu IP węzła nie używaj nazwy hosta mapowanej na adres 127.0.0.1 ani adresu IP 127.0.0.1.

Pamiętaj, że w definicjach hostów Cassandra należy używać tylko adresów IP, a nie nazw DNS.

ENABLE_SYSTEM_CHECK

Jeśli „y”, sprawdź, czy system spełnia wymagania dotyczące procesora i pamięci dla instalowanego komponentu. Wymagania dotyczące poszczególnych komponentów znajdziesz w artykule Wymagania dotyczące instalacji.

Wartość domyślna to „n”, co oznacza wyłączenie sprawdzania.

ENABLE_DYNAMIC_HOSTIP

Jeśli serwer ma kilka kart interfejsu, polecenie „hostname -i” zwraca rozdzielaną spacjami listę adresów IP. Domyślnie instalator Edge używa pierwszego zwróconego adresu IP, który nie we wszystkich sytuacjach może być prawidłowy. Możesz też ustawić tę właściwość w pliku konfiguracji instalacji.

Jeśli ustawisz wartość „y”, instalator poprosi Cię o wybranie adresu IP, który ma być używany podczas instalacji. Wartość domyślna to „n”.

ADMIN_EMAIL
APIGEE_ADMINPW

Hasło administratora systemu musi składać się z co najmniej 8 znaków i zawierać 1 wielką literę, 1 małą literę, 1 cyfrę lub 1 znak specjalny. Jeśli pominiesz hasło, pojawi się prośba o jego podanie.

Po zakończeniu instalacji Apigee zaleca usunięcie hasła z pliku konfiguracji.

LICENSE_FILE

Lokalizacja pliku licencji, który musi być dostępny dla użytkownika „apigee”. Możesz na przykład zapisać go w katalogu /tmp i nadać mu uprawnienia chmod 777. Plik zostanie skopiowany do katalogu instalacyjnego Edge.

APIGEE_LDAPPW

Określa hasło OpenLDAP.

Po zakończeniu instalacji Apigee zaleca usunięcie hasła z pliku konfiguracji.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Jeśli USE_LDAP_REMOTE_HOST ma wartość n, Edge automatycznie instaluje OpenLDAP podczas instalowania serwera zarządzania.

Jeśli łączysz się ze zdalnym serwerem LDAP, ustaw USE_LDAP_REMOTE_HOST na y. OpenLDAP nie jest instalowany z serwerem zarządzania.

Jeśli łączysz się ze zdalnym serwerem OpenLDAP, użyj LDAP_HOST i LDAP_PORT, aby określić adres IP lub nazwę DNS i numer portu hosta.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Ustaw LDAP_TYPE=1 w przypadku OpenLDAP bez replikacji. LDAP_TYPE=2 odpowiada OpenLDAP z replikacją.

Jeśli topologia Edge używa jednego serwera OpenLDAP, wpisz 1. Jeśli instalacja Edge korzysta z wielu węzłów OpenLDAP, np. w przypadku instalacji produkcyjnej z 13 węzłami, podaj 2.

Jeśli włączysz replikację, ustaw te właściwości:

  • LDAP_SID=1 – unikalny identyfikator tego serwera LDAP. Każdy węzeł LDAP używa innego identyfikatora. Na przykład ustaw wartość 2 dla węzła LDAP.
  • LDAP_PEER=10.0.0.1 – adres IP lub nazwa DNS połączenia równorzędnego LDAP.
MP_POD Podaj nazwę poda procesora komunikatów i routera. Domyślna nazwa to gateway.
REGION

Nazwa regionu. Zgodnie z konwencją nazwy mają zwykle postać dc-#, gdzie # odpowiada wartości całkowitej. Na przykład dc-1, dc-2 itd. Możesz użyć dc-1, chyba że instalujesz w środowisku z wieloma centrami danych.

W przypadku instalacji w wielu centrach danych wartość to dc-1, dc-2 itd. w zależności od tego, które centrum danych instalujesz. Nie musisz jednak używać tylko nazw w formacie dc-#. Możesz użyć dowolnej nazwy regionu.

REGION_MAPPING

Jeśli używasz nazw regionów innych niż dc-1, dc-2 itd., ustaw tę właściwość, aby zmapować nazwę regionu na odpowiednią nazwę regionu w formacie dc-x. Ta właściwość jest wymagana przez serwer zarządzania do prawidłowego rejestrowania magazynów danych Cassandra na podstawie centrów danych i regionów Cassandra.

ZK_HOSTS

Adresy IP lub nazwy DNS węzłów ZooKeeper. Adresy IP lub nazwy DNS muszą być wymienione w tej samej kolejności we wszystkich węzłach ZooKeeper.

Użyj tego samego formatu dla atrybutu HOSTIP co dla atrybutu ZK_HOSTS. Jeśli więc podasz adres IP dla ZK_HOSTS, użyj adresu IP dla HOSTIP. Jeśli używasz DNS, użyj nazwy DNS dla obu tych elementów.

W środowisku z wieloma centrami danych wyświetl listę wszystkich węzłów ZooKeeper z obu centrów danych.

Modyfikator „:observer” w węzłach ZooKeeper należy określać tylko podczas tworzenia wielu centrów danych zgodnie z opisem w instalacji na 12 hostach. W przypadku instalacji w jednym centrum danych pomiń ten modyfikator. Więcej informacji znajdziesz w artykule o instalacji klastrowej na 12 hostach.

ZK_CLIENT_HOSTS

Adresy IP lub nazwy DNS węzłów ZooKeeper używanych przez to centrum danych. Adresy IP lub nazwy DNS muszą być wymienione w tej samej kolejności we wszystkich węzłach ZooKeeper.

Użyj tego samego formatu dla atrybutu HOSTIP co dla atrybutu ZK_CLIENT_HOSTS. Oznacza to, że jeśli podasz adres IP dla ZK_CLIENT_HOSTS, użyj adresu IP dla HOSTIP. Jeśli używasz DNS, użyj nazwy DNS dla obu tych elementów.

W przypadku instalacji w jednym centrum danych są to te same węzły, które są określone przez ZK_HOSTS.

W środowisku z wieloma centrami danych podaj tylko węzły ZooKeeper w tym centrum danych. Więcej informacji znajdziesz w artykule o instalacji klastrowej na 12 hostach.

CASS_CLUSTERNAME Opcjonalnie podaj nazwę klastra Cassandra. Domyślna nazwa to „Apigee”.
CASS_HOSTS

Określa rozdzielaną przecinkami listę adresów IP hostów węzłów Cassandra (nie nazw DNS) oraz opcjonalnie numer centrum danych i szafę, do której należą.

W przypadku topologii produkcyjnych na tej liście muszą znajdować się co najmniej 3 węzły. Pierwsze 2 węzły są używane jako „serwery źródłowe”. W związku z tym adresy IP muszą być wymienione w tej samej kolejności we wszystkich węzłach Cassandra.

Składnia każdego wpisu na liście jest następująca:

IP_address[:data_center_number,rack_number]

Węzły Cassandra mogą opcjonalnie określać centrum danych i szafę serwerową węzła Cassandra. Modyfikator data_center_number podawaj tylko podczas tworzenia wielu centrów danych, jak opisano w instalacji z 12 hostami. W przypadku instalacji w jednym centrum danych pomiń ten modyfikator.

Na przykład „192.168.124.201:1,1” = centrum danych 1 i szafa rack/strefa dostępności 1, a „192.168.124.204:2,1” = centrum danych 2 i szafa rack/strefa dostępności 1.

W środowisku z wieloma centrami danych, aby rozwiązać problemy z zaporą sieciową, właściwość CASS_HOSTS musi być uporządkowana w taki sposób (jak pokazano w przykładzie powyżej), aby węzły bieżącego centrum danych znajdowały się na początku. Więcej informacji znajdziesz w artykule o instalacji klastrowej na 12 hostach.

Informacje o określaniu rack_number dla hosta Cassandra znajdziesz w artykule Dodawanie obsługi szafy Cassandra.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Jeśli włączysz uwierzytelnianie Cassandra (CASS_AUTH=y), możesz przekazać nazwę użytkownika i hasło Cassandra za pomocą tych właściwości.

Po zakończeniu instalacji Apigee zaleca usunięcie hasła z pliku konfiguracji.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG określa, jak są rejestrowane zmiany w plikach konfiguracji. Jeśli ustawisz CONFIG_DELTA_LOG=y, zmiany konfiguracji komponentu nie będą rejestrowane.

PG_USER
PG_PWD

Domyślnie baza danych PostgreSQL ma zdefiniowanych 2 użytkowników: „postgres” i „apigee”.

PG_USER umożliwia zmianę nazwy użytkownika „apigee”. Nie możesz zmienić nazwy użytkownika „postgres”.

Domyślnie baza danych PostgreSQL ma zdefiniowanych 2 użytkowników: „postgres” i „apigee”. Obaj użytkownicy mają domyślne hasło „postgres”. Użyj PG_PWD, aby ustawić inną wartość hasła dla obu użytkowników podczas instalacji.

Po zakończeniu instalacji Apigee zaleca usunięcie hasła z pliku konfiguracji.

PG_MASTER
PG_STANDBY

Ustaw, aby włączyć replikację Postgres master-standby, w formacie:

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

Skonfiguruj SMTP, aby Edge mógł wysyłać e-maile dotyczące utraconych haseł i inne powiadomienia.

Jeśli dane logowania użytkownika SMTP nie są wymagane, pomiń SMTPUSER i SMTPPASSWORD.

Pole SMTPMAILFROM jest wymagane.

CASS_JMX_USERNAME Nazwa użytkownika Cassandra JMX. Wymagane, jeśli włączono uwierzytelnianie Cassandra JMX.
CASS_JMX_PASSWORD Hasło JMX Cassandra. Wymagane, jeśli włączono uwierzytelnianie Cassandra JMX.
CASS_JMX_TRUSTSTORE Nazwa użytkownika magazynu zaufanych certyfikatów Cassandra JMX SSL, jeśli w systemie Cassandra włączono JMX oparty na SSL. Plik magazynu zaufanych certyfikatów JMX powinien być możliwy do odczytania przez użytkownika Apigee.
CASS_JMX_TRUSTSTORE_PASS Hasło do magazynu zaufanych certyfikatów Cassandra JMX SSL, jeśli w systemie Cassandra włączono JMX oparty na SSL.
CONFIG_DELTA_LOG Steruje logowaniem zmian konfiguracji. Ustaw tę wartość na „y”, aby wydrukować zmiany konfiguracji. Ustaw wartość „n”, aby wyłączyć drukowanie zmian konfiguracji.

Oprócz właściwości wymienionych tutaj dostępne są też właściwości do konfigurowania Apigee mTLS. Więcej informacji znajdziesz w artykule o konfigurowaniu mTLS w Apigee.