Dokumentacja pliku brzegowego

Poniżej znajdziesz przykład pełnego pliku cichej konfiguracji instalacji Edge z 9 węzłami. Odpowiednio zmodyfikuj plik. Aby dołączyć ten plik, użyj opcji -f w polu setup.sh. Przykłady plików konfiguracyjnych właściwych dla każdej topologii znajdziesz w sekcji 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=":dc-1 :dc-2 ... :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 =

Ta tabela zawiera dodatkowe informacje o tych właściwościach:

Usługa Uwaga
Nazwy IP/DNS Podczas określania adresu IP węzła nie używaj mapowania nazwy hosta na adres 127.0.0.1 ani adresu IP 127.0.0.1.

Pamiętaj, że w przypadku definicji hosta Cassandra używaj tylko adresów IP. Nie używaj nazw DNS.

ENABLE_SYSTEM_CHECK

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

Wartość domyślna to „n”, aby wyłączyć sprawdzanie.

ENABLE_DYNAMIC_HOSTIP

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

W przypadku ustawienia „y” instalator poprosi Cię o wybranie adresu IP, który zostanie użyty podczas instalacji. Wartość domyślna to „n”.

ADMIN_EMAIL
APIGEE_ADMINPW

Hasło administratora systemu musi mieć długość co najmniej 8 znaków i zawierać jedną wielką literę, jedną małą literę, jedną cyfrę lub jeden znak specjalny. Jeśli nie pamiętasz hasła, 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óra musi być dostępna dla użytkownika „apigee”. Na przykład umieść go w katalogu /tmp i chmod 777 w pliku. 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 to n, granica automatycznie instaluje OpenLDAP podczas instalowania serwera zarządzania.

Ustaw USE_LDAP_REMOTE_HOST na y, jeśli łączysz się ze zdalnym serwerem LDAP. Protokół OpenLDAP nie jest zainstalowany na serwerze zarządzania.

Jeśli łączysz się ze zdalnym serwerem OpenLDAP, użyj adresów 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 dla OpenLDAP bez replikacji. LDAP_TYPE=2 odpowiada parametrowi OpenLDAP z replikacją.

Jeśli topologia Edge używa 1 serwera OpenLDAP, podaj wartość 1. Jeśli instalacja Edge obejmuje wiele węzłów OpenLDAP, na przykład w 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 połączenia równorzędnego LDAP.
  • LDAP_PEER=10.0.0.1 – adres IP lub nazwa DNS połączenia równorzędnego LDAP.
MP_POD Podaj nazwę poda podmiotu przetwarzającego wiadomości i routera. Domyślnie nazwa to brama.
REGION

Nazwa regionu. Z reguły nazwy mają zwykle postać dc-#, gdzie # odpowiada wartości całkowitej. Na przykład dc-1, dc-2 itd. Możesz używać dc-1, chyba że zainstalujesz je w środowisku multi-danych.

W przypadku instalacji z wieloma centrami danych wartość wynosi dc-1, dc-2 itd. w zależności od tego, które centrum danych instalujesz. Nie musisz jednak wpisywać 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 itp., ustaw tę właściwość, aby zmapować nazwę swojego regionu na odpowiednią nazwę regionu w formacie dc-x. Ta właściwość jest wymagana przez serwer zarządzania do prawidłowego rejestrowania baz danych Cassandra na podstawie centrów danych i regionów tej marki.

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 HOSTIP w tym samym formacie co w ZK_HOSTS. To znaczy, że jeśli określisz adres IP dla dostawcy ZK_HOSTS, użyj adresu IP dla HOSTIP. Jeśli używasz nazwy DNS, użyj nazwy DNS obu.

W środowisku środowiska wielu danych wymień wszystkie węzły ZooKeeper z obu centrów danych.

Modyfikator „:observer” w węzłach ZooKeeper możesz utworzyć tylko podczas tworzenia wielu centrów danych w sposób opisany w instalacji 12-hostowej. Pomiń ten modyfikator w pojedynczej instalacji centrum danych. Więcej informacji znajdziesz w artykule na temat instalacji grupowanej 12 hostów.

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 HOSTIP w tym samym formacie co w ZK_CLIENT_HOSTS. To znaczy, że jeśli określisz adres IP dla dostawcy ZK_CLIENT_HOSTS, użyj adresu IP dla HOSTIP. Jeśli używasz systemu DNS, dla obu musisz użyć nazwy DNS.

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

W środowisku wielu centrów danych wypisz w tym centrum danych tylko węzły ZooKeeper. Więcej informacji znajdziesz w artykule na temat instalacji grupowanej 12 hostów.

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

Określa rozdzieloną przecinkami listę adresów IP hostów węzłów Cassandra (nie nazw DNS), a opcjonalnie także ich numer centrum danych i stojak, do którego 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 wyjściowe”. W związku z tym adresy IP muszą być wymienione w tej samej kolejności we wszystkich węzłach Cassandra.

Składnia poszczególnych pozycji na liście wygląda tak:

IP_address[:data_center_number,rack_number]

Węzły Cassandra mogą opcjonalnie określać centrum danych i stojak węzła Cassandra. Modyfikator data_center_number możesz określić tylko podczas tworzenia wielu centrów danych w sposób opisany w sekcji 12-hostowej. Pomiń ten modyfikator w pojedynczej instalacji centrum danych.

Na przykład „192.168.124.201:1,1 = centrum danych 1 i strefa szafy/dostępności 1 oraz „192.168.124.204:2,1 = centrum danych 2 oraz strefa 1 stojaka/dostępności 1.

W przypadku środowiska z wieloma centrami danych CASS_HOSTS są musiały być uporządkowane w sposób opisany powyżej, tak aby węzły bieżącego centrum danych były umieszczane na początku. Więcej informacji znajdziesz w artykule na temat instalacji grupowanej 12 hostów.

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

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

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

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

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG kontroluje sposób, w jaki 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 2 użytkowników: „postgres” i „apigee”.

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

Domyślnie baza danych PostgreSQL ma zdefiniowanych 2 użytkowników: „postgres” i „apigee”. Oba konta użytkowników mają domyślne hasło „postgres”. Ustaw PG_PWD, aby ustawić tę samą wartość hasła dla obu użytkowników w czasie instalacji.

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

PG_MASTER
PG_STANDBY

Włącza 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 w przypadku utraty haseł i innych powiadomień.

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 masz włączone uwierzytelnianie Cassandra JMX.
CASS_JMX_PASSWORD Hasło JMX Cassandra. Wymagane, jeśli masz włączone uwierzytelnianie Cassandra JMX.
CASS_JMX_TRUSTSTORE Nazwa użytkownika magazynu zaufania SSL MX dla Cassandra, jeśli włączono w tej usłudze protokół JMX oparty na SSL. Plik JMX Truststore powinien być czytelny dla użytkownika Apigee.
CASS_JMX_TRUSTSTORE_PASS Hasło magazynu certyfikatów SSL dla Cassandra JMX SSL, jeśli masz włączone je w standardzie SSL na platformie Cassandra.

Oprócz wymienionych tu usług istnieją usługi do konfigurowania mTLS w Apigee. Więcej informacji znajdziesz w artykule Konfigurowanie Apigee mTLS.