So konfigurieren Sie Edge

Edge für Private Cloud v4.19.01

Zum Konfigurieren von Edge nach der Installation verwenden Sie eine Kombination aus .properties-Dateien und Edge-Dienstprogrammen. Wenn Sie beispielsweise TLS/SSL auf der Edge-UI konfigurieren möchten, bearbeiten Sie .properties-Dateien, um die erforderlichen Attribute festzulegen. Bei Änderungen an .properties-Dateien müssen Sie die betroffene Edge-Komponente neu starten.

Apigee bezeichnet das Bearbeiten von .properties-Dateien als Code mit Konfiguration (manchmal als CwC abgekürzt). Im Grunde ist Code mit „config“ ein Schlüssel-/Wertsuchtool, das auf Einstellungen in .properties-Dateien basiert. Im Code mit „config“ werden die Schlüssel als Tokens bezeichnet. Zum Konfigurieren von Edge legen Sie daher Tokens in .properties-Dateien fest.

Mit dem Code mit Konfiguration können Edge-Komponenten Standardwerte festlegen, die mit dem Produkt ausgeliefert werden. Das Installationsteam kann diese Einstellungen dann basierend auf der Topologie der Installation überschreiben und Kunden können dann beliebige Attribute überschreiben.

Die Einstellungen sind hierarchisch angeordnet, wobei die Kundeneinstellungen mit der höchsten Priorität Vorrang vor den Einstellungen des Installationsprogramms oder Apigee haben:

1. Kunde
2. Installierer
3. Komponente

Aktuellen Wert eines Tokens ermitteln

Bevor Sie in einer .properties-Datei einen neuen Wert für ein Token festlegen, sollten Sie zuerst den aktuellen Wert mit dem folgenden Befehl ermitteln:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

Dabei ist component_name der Name der Komponente und token das zu prüfende Token.

Mit diesem Befehl wird die Hierarchie der .properties-Dateien der Komponente durchsucht, um den aktuellen Wert des Tokens zu ermitteln.

Im folgenden Beispiel wird der aktuelle Wert des Tokens conf_http_HTTPRequest.line.limit für den Router geprüft:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Die Ausgabe sollte in etwa so aussehen:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

Wenn der Wert des Tokens mit einem # beginnt, ist er auskommentiert und Sie müssen eine spezielle Syntax verwenden, um es zu ändern. Weitere Informationen finden Sie unter Tokens als Kommentar festlegen.

Wenn Sie nicht den gesamten Namen des Tokens kennen, verwenden Sie ein Tool wie grep, um nach dem Attributnamen oder dem Schlüsselwort zu suchen. Weitere Informationen finden Sie unter Token suchen.

Eigenschaftendateien

Es gibt bearbeitbare und nicht bearbeitbare Komponentenkonfigurationsdateien. In diesem Abschnitt werden diese Dateien beschrieben.

Konfigurationsdateien der bearbeitbaren Komponenten

In der folgenden Tabelle sind die Apigee-Komponenten und die Attributdateien aufgeführt, die Sie zum Konfigurieren dieser Komponenten bearbeiten können:

Wenn Sie eine Property in einer dieser Komponentenkonfigurationsdateien festlegen möchten, sie aber nicht vorhanden ist, können Sie sie am oben aufgeführten Speicherort erstellen.

Außerdem muss sichergestellt werden, dass die Eigenschaftendatei dem Benutzer "apigee" gehört:

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

Konfigurationsdateien für nicht bearbeitbare Komponenten

Neben den bearbeitbaren Komponentenkonfigurationsdateien gibt es auch Konfigurationsdateien, die Sie nicht bearbeiten können.

Zu den informativen (nicht bearbeitbaren) Dateien gehören folgende:

/opt/apigee/token

/opt/apigee/component_name/conf

Tokenwert festlegen

Sie können nur die .properties-Dateien im Verzeichnis /opt/apigee/customer/application ändern. Jede Komponente hat eine eigene .properties-Datei in diesem Verzeichnis. Beispiel: router.properties und management-server.properties. Eine vollständige Liste der Property-Dateien finden Sie unter Speicherort der .properties-Dateien.

So erstellen Sie eine .properties-Datei:

1. Erstellen Sie in einem Editor eine neue Textdatei. Der Dateiname muss mit der Liste in der Tabelle oben für Kundendateien übereinstimmen.
2. Ändern Sie den Eigentümer der Datei in „apigee:apigee“, wie im folgenden Beispiel gezeigt:

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Wenn Sie den Nutzer, der den Edge-Dienst ausführt, vom Nutzer „apigee“ geändert haben, können Sie mit chown die Inhaberschaft für den Nutzer ändern, der den Edge-Dienst ausführt.

Wenn Sie Edge upgraden, werden die .properties-Dateien im Verzeichnis /opt/apigee/customer/application gelesen. Bei der Aktualisierung werden also alle Attribute beibehalten, die Sie für die Komponente festgelegt haben.

So legen Sie den Wert eines Tokens fest:

1. Bearbeiten Sie die Datei .properties der Komponente.
2. Fügen Sie den Wert des Tokens hinzu oder ändern Sie es. Im folgenden Beispiel wird der Wert der Property conf_http_HTTPRequest.line.limit auf „10.000“ festgelegt:

   conf_http_HTTPRequest.line.limit=10k

   Wenn das Token mehrere Werte akzeptiert, trennen Sie die einzelnen Werte durch ein Komma, wie im folgenden Beispiel gezeigt:

   conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

   Wenn Sie einer solchen Liste einen neuen Wert hinzufügen möchten, hängen Sie den neuen Wert normalerweise an das Ende der Liste an.

3. Starten Sie die Komponente neu:

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   Dabei kann component_name für folgendes stehen:

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (PostgreSQL-Datenbank)
   • apigee-qpidd (Qpidd)
   • apigee-sso (Edge-SSO)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (Verwaltungsserver)
   • edge-management-ui (neue Edge-Benutzeroberfläche)
   • edge-message-processor (Nachrichtenprozessor)
   • edge-postgres-server (Postgres-Server)
   • edge-qpid-server (Qpid-Server)
   • edge-router (Edge-Router)
   • edge-ui (klassische Benutzeroberfläche)

   Starten Sie den Router nach der Bearbeitung von router.properties neu:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

4. (Optional) Prüfen Sie mit der Option configure -search, ob der Tokenwert auf den neuen Wert festgelegt ist. Beispiel:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

   Weitere Informationen zu configure -search findest du unter Aktuellen Wert eines Tokens ermitteln.

Token suchen

In der Regel werden die Tokens, die Sie festlegen müssen, in diesem Leitfaden aufgeführt. Wenn Sie jedoch den Wert eines vorhandenen Tokens überschreiben möchten, dessen vollständiger Name oder Standort Sie nicht sicher sind, können Sie mit grep das Verzeichnis source der Komponente durchsuchen.

Wenn Sie beispielsweise wissen, dass Sie in einer früheren Version von Edge das Attribut session.maxAge festgelegt haben und den Tokenwert wissen möchten, mit dem er festgelegt wurde, dann verwenden Sie grep für das Attribut im Verzeichnis /opt/apigee/edge-ui/source:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

Sie sollten ein Ergebnis in der folgenden Form sehen:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

Das folgende Beispiel zeigt den Wert des session.maxAge-Tokens der UI:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

Der String zwischen den Tags {T}{/T} ist der Name des Tokens, das Sie in der .properties-Datei der UI festlegen können.

Token festlegen, das derzeit kommentiert ist

Einige Tokens werden in den Edge-Konfigurationsdateien auskommentiert. Wenn Sie versuchen, ein Token festzulegen, das in einer Installations- oder Komponentenkonfigurationsdatei auskommentiert ist, wird Ihre Einstellung ignoriert.

Wenn Sie den Wert eines Tokens festlegen möchten, das in einer Edge-Konfigurationsdatei auskommentiert wird, verwenden Sie eine spezielle Syntax in der folgenden Form:

conf/filename+propertyName=propertyValue

Wenn Sie beispielsweise das Attribut HTTPClient.proxy.host im Message Processor festlegen möchten, muss zuerst grep für das Attribut festgelegt werden, um dessen Token zu ermitteln:

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

Mit dem Befehl grep werden Ergebnisse zurückgegeben, die den Tokennamen enthalten. Der Name des Attributs wird durch das Präfix # vergeben:

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

Bearbeiten Sie /opt/apigee/customer/application/message-processor.properties, um den Wert dieses Attributs festzulegen. Verwenden Sie jedoch eine spezielle Syntax, wie im folgenden Beispiel gezeigt:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

In diesem Fall müssen Sie dem Attributnamen das Präfix conf/http.properties+ voranstellen. Dies sind der Speicherort und der Name der Konfigurationsdatei, die das Attribut enthält, gefolgt von „+“.

Nachdem Sie den Message Processor neu gestartet haben, prüfen Sie die Datei /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

Am Ende der Datei sehen Sie den Eigenschaftensatz im folgenden Format:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com