Edge-Konfigurationsdatei-Referenz

Unten sehen Sie ein Beispiel für eine vollständige Konfigurationsdatei im automatischen Modus für eine Edge-Installation mit 9 Knoten. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option -f, um setup.sh zu verwenden, um diese Datei einzubeziehen. Beispiele für Konfigurationsdateien für die jeweilige Topologie finden Sie unter Edge-Komponenten installieren.

# 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=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=pass1234

Die folgende Tabelle enthält zusätzliche Informationen zu diesen Attributen:

Property Hinweise
IP-/DNS-Namen Verwenden Sie bei der Angabe der IP-Adresse eines Knotens keine Hostnamenzuordnung zu 127.0.0.1 oder die IP-Adresse 127.0.0.1.

Verwenden Sie für Cassandra-Hostdefinitionen nur IP-Adressen und keine DNS-Namen.

ENABLE_SYSTEM_CHECK

Wenn „y“, prüfen Sie, ob das System die CPU- und Arbeitsspeicheranforderungen für die installierte Komponente erfüllt. Weitere Informationen zu den Anforderungen der einzelnen Komponenten finden Sie unter Installationsanforderungen.

Der Standardwert ist „n“, um die Prüfung zu deaktivieren.

ENABLE_DYNAMIC_HOSTIP

Wenn ein Server mehrere Schnittstellenkarten hat, gibt der Befehl „hostname -i“ eine durch Leerzeichen getrennte Liste von IP-Adressen zurück. Standardmäßig verwendet das Edge-Installationsprogramm die erste zurückgegebene IP-Adresse, die möglicherweise nicht in allen Situationen korrekt ist. Alternativ können Sie die folgende Eigenschaft in der Konfigurationsdatei für die Installation festlegen.

Wenn „y“ festgelegt ist, fordert das Installationsprogramm Sie auf, die IP-Adresse auszuwählen, die für die Installation verwendet werden soll. Der Standardwert ist „n“.

ADMIN_EMAIL
APIGEE_ADMINPW

Das Passwort des Systemadministrators muss mindestens 8 Zeichen lang sein und einen Großbuchstaben, einen Kleinbuchstaben, eine Ziffer oder ein Sonderzeichen enthalten. Wenn Sie das Passwort weglassen, werden Sie aufgefordert, es anzugeben.

Nach Abschluss der Installation empfiehlt Apigee, dass Sie das Passwort aus der Konfigurationsdatei entfernen.

LICENSE_FILE

Der Speicherort der Lizenzdatei, die für den „Apigee“-Benutzer zugänglich sein muss. Speichern Sie die Datei beispielsweise im Verzeichnis „/tmp“ und im Verzeichnis „chmod 777“. Die Datei wird in das Edge-Installationsverzeichnis kopiert.

APIGEE_LDAPPW

Gibt das OpenLDAP-Passwort an.

Nach Abschluss der Installation empfiehlt Apigee, dass Sie das Passwort aus der Konfigurationsdatei entfernen.

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Wenn USE_LDAP_REMOTE_HOST n ist, installiert Edge automatisch OpenLDAP bei der Installation des Verwaltungsservers.

Legen Sie USE_LDAP_REMOTE_HOST auf y fest, wenn Sie eine Verbindung zu einem Remote-LDAP-Server herstellen. OpenLDAP ist nicht mit dem Verwaltungsserver installiert.

Wenn Sie eine Verbindung zu einem Remote-OpenLDAP-Server herstellen, verwenden Sie LDAP_HOST und LDAP_PORT, um die IP-Adresse oder den DNS-Namen und die Portnummer des Hosts anzugeben.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Legen Sie LDAP_TYPE=1 für OpenLDAP ohne Replikation fest. LDAP_TYPE=2 entspricht OpenLDAP mit Replikation.

Wenn Ihre Edge-Topologie einen einzelnen OpenLDAP-Server verwendet, geben Sie 1 an. Wenn Ihre Edge-Installation mehrere OpenLDAP-Knoten verwendet, z. B. in einer Produktionsinstallation mit 13 Knoten, geben Sie 2 an.

Legen Sie die folgenden Attribute fest, wenn Sie die Replikation aktivieren:

  • LDAP_SID=1 – eindeutige ID für diesen LDAP-Server. Jeder LDAP-Knoten verwendet eine andere ID. Legen Sie diese Einstellung beispielsweise für LDAP-Peer auf 2 fest.
  • LDAP_PEER=10.0.0.1 – IP- oder DNS-Name des LDAP-Peers.
MP_POD Geben Sie den Namen des Message Processor- und Router-Pods an. Standardmäßig lautet der Name „Gateway“.
REGION

Name der Region. Konventionsgemäß haben Namen normalerweise die Form dc-#, wobei # einem Ganzzahlwert entspricht. Beispiel: dc-1, dc-2 usw. Sie können dc-1 verwenden, sofern die Installation nicht in einer Umgebung mit mehreren Rechenzentren erfolgt.

In einer Installation mit mehreren Rechenzentren lautet der Wert dc-1, dc-2 usw., je nachdem, welches Rechenzentrum Sie installieren. Sie sind jedoch nicht darauf beschränkt, nur Namen im Format dc-# zu verwenden. Sie können einen beliebigen Namen für die Region verwenden.

REGION_MAPPING

Wenn Sie andere Regionsnamen als „dc-1“, „dc-2“ usw. verwenden, legen Sie dieses Attribut fest, um den Namen der Region dem Namen der Region im entsprechenden dc-x-Format zuzuordnen. Diese Eigenschaft wird vom Verwaltungsserver benötigt, um Cassandra-Datenspeicher basierend auf den Rechenzentren und Regionen von Cassandra entsprechend zu registrieren.

ZK_HOSTS

Die IP-Adressen oder DNS-Namen der ZooKeeper-Knoten. Die IP-Adressen oder DNS-Namen müssen auf allen ZooKeeper-Knoten in derselben Reihenfolge aufgeführt werden.

Verwende für HOSTIP dasselbe Format wie für ZK_HOSTS. Wenn Sie also die IP-Adresse für ZK_HOSTS angeben, verwenden Sie eine IP-Adresse für HOSTIP. Wenn Sie einen DNS nutzen, geben Sie für beide einen DNS-Namen an.

Listen Sie in einer Umgebung mit mehreren Rechenzentren alle ZooKeeper-Knoten aus beiden Rechenzentren auf.

Geben Sie den Modifikator „:observer“ auf ZooKeeper-Knoten nur an, wenn Sie mehrere Rechenzentren erstellen, wie in einer Installation mit 12 Hosts beschrieben. In der Installation eines einzelnen Rechenzentrums lassen Sie diesen Modifikator weg. Weitere Informationen finden Sie unter Installation von 12-Host-Clustern.

ZK_CLIENT_HOSTS

Die IP-Adressen oder DNS-Namen der ZooKeeper-Knoten, die von diesem Rechenzentrum verwendet werden. Die IP-Adressen oder DNS-Namen müssen auf allen ZooKeeper-Knoten in der gleichen Reihenfolge aufgelistet werden.

Verwende für HOSTIP dasselbe Format wie für ZK_CLIENT_HOSTS. Wenn Sie also die IP-Adresse für ZK_CLIENT_HOSTS angeben, verwenden Sie eine IP-Adresse für HOSTIP. Wenn Sie ein DNS verwenden, geben Sie für beide einen DNS-Namen an.

In einer Installation eines einzelnen Rechenzentrums sind dies dieselben Knoten, die von ZK_HOSTS angegeben werden.

Geben Sie in einer Umgebung mit mehreren Rechenzentren nur die ZooKeeper-Knoten in diesem Rechenzentrum an. Weitere Informationen finden Sie unter Installation von 12-Host-Clustern.

CASS_CLUSTERNAME Geben Sie optional den Namen des Cassandra-Clusters an. Der Standardname lautet „Apigee“.
CASS_HOSTS

Gibt eine durch Kommas getrennte Liste von Host-IP-Adressen der Cassandra-Knoten (nicht DNS-Namen) und optional der Nummer des Rechenzentrums sowie des Racks an, zu dem sie gehören.

Für Produktionstopologien muss diese Liste mindestens drei Knoten enthalten. Die ersten beiden Knoten werden als „Startserver“ verwendet. Daher müssen die IP-Adressen auf allen Cassandra-Knoten in derselben Reihenfolge aufgeführt werden.

Die Syntax für jeden Eintrag in der Liste lautet wie folgt:

IP_address[:data_center_number,rack_number]

Für Cassandra-Knoten können optional das Rechenzentrum und das Rack des Cassandra-Knotens angegeben werden. Geben Sie den data_center_number-Modifikator nur an, wenn Sie mehrere Rechenzentren erstellen, wie in einer Installation mit 12 Hosts beschrieben. Bei der Installation eines einzelnen Rechenzentrums lassen Sie diesen Modifikator weg.

Beispiel: "192.168.124.201:1,1 = Rechenzentrum 1 und Rack-/Verfügbarkeitszone 1 und "192.168.124.204:2,1 = Rechenzentrum 2 und Rack-/Verfügbarkeitszone 1.

Zur Vermeidung von Firewallproblemen muss CASS_HOSTS in einer Umgebung mit mehreren Rechenzentren so angeordnet werden (wie im obigen Beispiel gezeigt), dass die Knoten des aktuellen Rechenzentrums am Anfang platziert werden. Weitere Informationen finden Sie unter Installation von 12-Host-Clustern.

Informationen zum Angeben des rack_number für einen Cassandra-Host finden Sie unter Cassandra-Rack-Unterstützung hinzufügen.

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Wenn Sie die Cassandra-Authentifizierung (CASS_AUTH=y) aktivieren, können Sie den Cassandra-Nutzernamen und das Passwort mithilfe dieser Attribute übergeben.

Nach Abschluss der Installation empfiehlt Apigee, dass Sie das Passwort aus der Konfigurationsdatei entfernen.

CONFIG_DELTA_LOG

CONFIG_DELTA_LOG steuert, wie Änderungen an Konfigurationsdateien protokolliert werden. Wenn Sie CONFIG_DELTA_LOG=y festlegen, werden Konfigurationsänderungen für eine Komponente nicht protokolliert.

PG_USER
PG_PWD

Standardmäßig sind in der PostgreSQL-Datenbank zwei Nutzer definiert: „postgres“ und „apigee“.

Mit PG_USER können Sie den Benutzernamen des Benutzers „apigee“ ändern. Sie können den Namen des Nutzers „postgres“ nicht ändern.

Standardmäßig sind in der PostgreSQL-Datenbank zwei Benutzer definiert: „postgres“ und „apigee“. Beide Nutzer haben das Standardpasswort „postgres“. Verwende PG_PWD, um das Passwort für beide Nutzer bei der Installation auf einen anderen Wert festzulegen.

Nach Abschluss der Installation empfiehlt Apigee, dass Sie das Passwort aus der Konfigurationsdatei entfernen.

PG_MASTER
PG_STANDBY

Legen Sie fest, dass die Postgres-Master-Standby-Replikation in folgendem Format aktiviert wird:

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

Konfigurieren Sie SMTP so, dass Edge E-Mails bei verlorenen Passwörtern und andere Benachrichtigungen senden kann.

Wenn keine SMTP-Nutzeranmeldedaten erforderlich sind, lassen Sie SMTPUSER und SMTPPASSWORD weg.

Das Feld „SMTPMAILFROM“ darf nicht leer sein.

CASS_JMX_USERNAME Cassandra-JMX-Nutzername. Erforderlich, wenn Sie die Cassandra-JMX-Authentifizierung aktiviert haben.
CASS_JMX_PASSWORD Cassandra-JMX-Passwort. Erforderlich, wenn Sie die Cassandra-JMX-Authentifizierung aktiviert haben.
CASS_JMX_TRUSTSTORE Nutzername für Cassandra JMX SSL Truststore, wenn Sie SSL-basiertes JMX in Cassandra aktiviert haben. Die JMX Truststore-Datei sollte für Apigee-Nutzer lesbar sein.
CASS_JMX_TRUSTSTORE_PASS Cassandra JMX SSL Truststore-Passwort, wenn Sie SSL-basiertes JMX in Cassandra aktiviert haben.
QPID_MGMT_USERNAME
QPID_MGMT_PASSWORD
Diese Anmeldedaten ermöglichen den Zugriff auf die Qpid Web Management Console des Qpid-Brokers. Die Web Management Console bietet eine einfache und intuitive Benutzeroberfläche für die Verwaltung und Steuerung des Qpid-Brokers.

Zusätzlich zu den hier aufgeführten Attributen gibt es Attribute zum Konfigurieren von Apigee mTLS. Weitere Informationen finden Sie unter Apigee mTLS konfigurieren.