Edge-Konfigurationsdatei-Referenz

Unten sehen Sie ein Beispiel für eine vollständige Konfigurationsdatei für die unbeaufsichtigte Installation einer Edge -Installation mit 9 Knoten. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die -f Option für setup.sh um diese Datei einzufügen. Beispiele für Konfigurationsdateien, die für jede Topologie spezifisch sind, finden Sie unter Edge-Komponenten installieren.

    # 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
    

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

Attribut Hinweis
IP-/DNS-Namen Verwenden Sie keine Hostnamenszuordnung zu 127.0.0.1 oder eine IP-Adresse von 127.0.0.1, wenn Sie die IP-Adresse eines Knotens angeben.

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 zu installierende Komponente erfüllt. Die Anforderungen für jede Komponente finden Sie unter Installation Anforderungen.

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 in allen Situationen möglicherweise nicht korrekt ist. Alternativ können Sie das folgende Attribut in der Installationskonfigurationsdatei 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, auf die der Nutzer „apigee“ zugreifen können muss. Speichern Sie sie beispielsweise im Verzeichnis /tmp und legen Sie die Berechtigungen für die Datei mit chmod 777 fest. Die Datei wird in das Edge-Installationsverzeichnis kopiert.

APIGEE_LDAPPW

Gibt das SymasLDAP-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 SymasLDAP automatisch, wenn der Management Server installiert wird.

Setzen Sie USE_LDAP_REMOTE_HOST auf „y“, wenn Sie eine Verbindung zu einem Remote-LDAP-Server herstellen. SymasLDAP wird nicht mit dem Management Server installiert.

Wenn Sie eine Verbindung zu einem Remote-SymasLDAP-Server herstellen, geben Sie mit LDAP_HOST und LDAP_PORT die IP-Adresse oder den DNS-Namen und die Portnummer des Hosts an.

LDAP_TYPE
LDAP_SID
LDAP_PEER

Setzen Sie LDAP_TYPE=1 für SymasLDAP ohne Replikation. LDAP_TYPE=2 entspricht SymasLDAP mit Replikation.

Wenn Ihre Edge-Topologie einen einzelnen SymasLDAP-Server verwendet, geben Sie „1“ an. Wenn Ihre Edge Installation mehrere SymasLDAP-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. Setzen Sie sie beispielsweise auf „2“ für den LDAP-Peer.
  • LDAP_PEER=10.0.0.1 – IP-Adresse 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

Regionsname. Konventionsgemäß haben Namen in der Regel das Format „dc-#“, wobei „#“ einem ganzzahligen Wert entspricht. Beispiel: dc-1, dc-2 usw. Sie können „dc-1“ verwenden, es sei denn, Sie installieren in einer Umgebung mit mehreren Rechenzentren.

Bei einer Installation mit mehreren Rechenzentren ist der Wert „dc-1“ oder „dc-2“ usw., je nachdem, in welchem 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 Ihren Regionsnamen dem entsprechenden Regionsnamen im Format „dc-x“ zuzuordnen. Dieses Attribut ist für den Management Server erforderlich, 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 sein.

Verwenden Sie 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 DNS verwenden, dann verwenden Sie für beide einen DNS-Namen.

In einer Umgebung mit mehreren Rechenzentren müssen alle ZooKeeper-Knoten aus beiden Rechen zentren aufgeführt sein.

Geben Sie den Modifikator „:observer“ für ZooKeeper-Knoten nur an, wenn Sie mehrere Rechenzentren erstellen, wie unter Installation mit 12 Hosts beschrieben. Bei einer Installation mit einem einzelnen Rechenzentrum lassen Sie diesen Modifikator weg. Weitere Informationen finden Sie unter Clusterinstallation mit 12 Hosts.

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 derselben Reihenfolge aufgeführt sein.

Verwenden Sie 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 DNS verwenden, verwenden Sie für beide einen DNS-Namen.

Bei einer Installation mit einem einzelnen Rechenzentrum sind dies dieselben Knoten, die von ZK_HOSTS angegeben werden.

In einer Umgebung mit mehreren Rechenzentren müssen nur die ZooKeeper-Knoten in diesem Rechenzentrum aufgeführt sein. Weitere Informationen finden Sie unter Clusterinstallation mit 12 Hosts.

CASS_CLUSTERNAME Optional können Sie den Namen des Cassandra-Clusters angeben. Der Standardname ist „Apigee“.
CASS_HOSTS

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

Für Produktionsumgebungen müssen mindestens drei Knoten in dieser Liste enthalten sein. Die ersten beiden Knoten werden als „Seed-Server“ verwendet. Daher müssen die IP-Adressen auf allen Cassandra-Knoten in derselben Reihenfolge aufgeführt sein.

Die Syntax für jeden Eintrag in der Liste ist 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 unter Installation mit 12 Hosts beschrieben. Bei einer Installation mit einem einzelnen Rechenzentrum 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.

In einer Umgebung mit mehreren Rechenzentren muss CASS_HOSTS so angeordnet sein (wie im obigen Beispiel gezeigt), dass die Knoten des aktuellen Rechenzentrums am Anfang stehen, um Firewallprobleme zu vermeiden. Weitere Informationen finden Sie unter Clusterinstallation mit 12 Hosts.

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

CASS_AUTH
CASS_USERNAME
CASS_PASSWORD

Wenn Sie die Cassandra-Authentifizierung aktivieren (CASS_AUTH=y), können Sie den Cassandra-Nutzer namen und das Passwort mit diesen Attributen übergeben.

Nach Abschluss der Installation empfiehlt Apigee, das Passwort aus der Konfigurationsdatei zu 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 Nutzernamen des Nutzers „apigee“ ändern. Der Name des Nutzers „postgres“ kann nicht geändert werden.

Standardmäßig sind in der PostgreSQL-Datenbank zwei Nutzer definiert: „postgres“ und „apigee“. Beide Nutzer haben das Standardpasswort „postgres“. Mit PG_PWD können Sie das Passwort für beide Nutzer bei der Installation auf einen anderen Wert setzen.

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

PG_MASTER
PG_STANDBY

Legen Sie diese Attribute fest, um die Postgres-Master-Standby-Replikation zu aktivieren. Die Form ist:

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

Konfigurieren Sie SMTP, damit 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.

SMTPMAILFROM ist erforderlich.

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 Cassandra-JMX-SSL-Truststore-Nutzername, wenn Sie SSL-basiertes JMX in Cassandra aktiviert haben. Die JMX-Truststore-Datei muss für den 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
Mit diesen Anmeldedaten können Sie auf die Qpid-Webverwaltungskonsole des Qpid-Brokers zugreifen. Die Webverwaltungskonsole bietet eine einfache und intuitive Benutzeroberfläche für die Verwaltung und Steuerung des Qpid-Brokers.

Neben den hier aufgeführten Attributen gibt es auch Attribute zum Konfigurieren von Apigee mTLS. Weitere Informationen finden Sie unter Apigee mTLS konfigurieren.