Edge-Konfigurationsdatei-Referenz

Unten sehen Sie ein Beispiel für eine vollständige stille Konfigurationsdatei für eine Edge-Installation mit 9 Knoten. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option -f, um diese Datei auf setup.sh zu setzen. Beispiele für Konfigurationsdateien für die einzelnen Topologien 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.

# 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>"

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

Attribut Hinweise
IP-/DNS-Namen Verwenden Sie nicht die Hostnamezuordnung für 127.0.0.1 oder die IP-Adresse 127.0.0.1, wenn Sie die IP-Adresse eines Knotens angeben.

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

ENABLE_SYSTEM_CHECK

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

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

ENABLE_DYNAMIC_HOSTIP

Wenn ein Server mehrere Schnittstellenkarten hat, gibt der Befehl „hostname -i“ eine durch Leerzeichen getrennte Liste mit IP-Adressen zurück. Das Edge-Installationsprogramm verwendet standardmäßig die erste IP-Adresse, die möglicherweise nicht richtig ist. Alternativ können Sie in der Installationskonfigurationsdatei folgendes Attribut festlegen.

Wenn „y“ festgelegt ist, werden Sie vom Installationsprogramm aufgefordert, die IP-Adresse auszuwählen, die bei der 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 dazu aufgefordert.

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

LICENSE_FILE

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

APIGEE_LDAPPW

Gibt das OpenLDAP-Passwort an.

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

USE_LDAP_REMOTE_HOST
LDAP_HOST
LDAP_PORT

Wenn USE_LDAP_REMOTE_HOST auf „n“ gesetzt ist, installiert Edge automatisch den LDAP-Server, wenn dieser installiert wird.

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.

Wenn Sie die Replikation aktivieren, legen Sie die folgenden Attribute fest:

  • LDAP_SID=1 – Eindeutige ID für diesen LDAP-Server. Jeder LDAP-Knoten verwendet eine andere ID. Legen Sie beispielsweise 2 für den LDAP-Peer 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 ist der Name Gateway.
REGION

Name der Region. Konventionsgemäß haben Namen in der Regel die Form dc-#, wobei # einer Ganzzahl entspricht. Beispiel: dc-1, dc-2 usw. Sie können dc-1 verwenden, es sei denn, Sie installieren es in einer Multi-Rechenzentrumsumgebung.

Bei der Installation mehrerer Rechenzentren ist der Wert „dc-1“ oder „dc-2“ usw., je nachdem, welches Rechenzentrum Sie installieren. Es sind jedoch nicht nur Namen im Format dc-# zulässig. Sie können einen beliebigen Namen für die Region verwenden.

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.

Verwenden Sie für HOSTIP dasselbe Format wie für ZK_HOSTS. Wenn Sie die IP-Adresse für ZK_HOSTS angeben, müssen Sie eine IP-Adresse für HOSTIP verwenden. Wenn Sie ein DNS verwenden, verwenden Sie einen DNS-Namen für beide.

Listen Sie in einer Multi-Rechenzentrum-Umgebung alle ZooKeeper-Knoten aus beiden Rechenzentren auf.

Geben Sie den Modifikator „:observer“ auf ZooKeeper-Knoten nur beim Erstellen mehrerer Rechenzentren an, wie in einer 12-Host-Installation beschrieben. Bei einer einzelnen Installation eines Rechenzentrums lassen Sie diesen Modifizierer weg. Weitere Informationen finden Sie unter Clusterinstallation mit 12 Hosts.

ZK_CLIENT_HOSTS

Die von diesem Rechenzentrum verwendeten 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.

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

In einer einzelnen Rechenzentrumsinstallation sind dies dieselben Knoten, wie in ZK_HOSTS angegeben.

Listen Sie in einer Multi-Rechenzentrum-Umgebung nur die ZooKeeper-Knoten in diesem Rechenzentrum auf. Weitere Informationen finden Sie unter Clusterinstallation mit 12 Hosts.

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

Gibt eine durch Kommas getrennte Liste der Host-IP-Adressen von Cassandra-Knoten (nicht DNS-Namen) sowie optional deren Rechenzentrumsnummer und das Rack an, zu der sie gehören.

Für Produktionstopologieen muss diese Liste mindestens drei Knoten enthalten. Die ersten beiden Knoten werden als Seed-Server 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 sieht so aus:

IP_address[:data_center_number,rack_number]

Cassandra-Knoten können optional das Rechenzentrum und das Rack des Cassandra-Knotens angeben. Geben Sie den Modifikator data_center_number nur an, wenn Sie mehrere Rechenzentren erstellen, wie in einer 12-Host-Installation beschrieben. Bei einer einzelnen Installation des Rechenzentrums lassen Sie diesen Modifizierer 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.

In einer Multi-Rechenzentrum-Umgebung muss CASS_HOSTS zur Überwindung von Firewallproblemen in einer Weise angeordnet werden (wie im Beispiel oben), dass die Knoten des aktuellen Rechenzentrums am Anfang platziert werden. Weitere Informationen finden Sie unter Clusterinstallation mit 12 Hosts.

Informationen zum Angeben der 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 mit diesen Properties weitergeben.

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

PG_USER
PG_PWD

Standardmäßig hat die PostgreSQL-Datenbank zwei Nutzer definiert: „postgres“ und „apigee“.

Mit PG_USER können Sie den Nutzernamen des Apigee-Nutzers ändern. Sie können den Namen des „postgres“-Nutzers nicht ändern.

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

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

PG_MASTER
PG_STANDBY

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

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

Konfigurieren Sie SMTP so, dass Edge E-Mails für verlorene Passwörter und andere Benachrichtigungen senden kann.

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

Das Feld „SMTPMAILFROM“ darf nicht leer sein.

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