So konfigurieren Sie Edge

Edge for Private Cloud v4.18.05

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

Apigee bezeichnet die Technik zum Bearbeiten von .properties-Dateien als Code mit Konfiguration. Im Wesentlichen ist Code mit Konfiguration ein Tool zum Suchen von Schlüsseln/Werten, das auf den Einstellungen in den .properties-Dateien basiert. In Code mit Konfiguration werden die Schlüssel als Tokens bezeichnet. Daher legen Sie zum Konfigurieren von Edge Tokens in .properties-Dateien fest.

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

Wenn Sie sich das als Hierarchie vorstellen, sind die Einstellungen so angeordnet, dass die Kundeneinstellungen die höchste Priorität haben, um alle Einstellungen des Installationsteams oder von Apigee zu überschreiben:

1. Kunde
2. Installierer
3. Apigee

PROPERTIES-Dateien verwenden

Als Kunde können Sie 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.

So erstellen Sie beispielsweise eine .properties-Datei:

1. Erstellen Sie die Datei in einem Editor als beliebiger Nutzer.
2. Verwenden Sie chown, um den Inhaber der Datei in „apigee:apigee“ zu ändern. Wenn Sie den Nutzer, der den Edge-Dienst ausführt, vom Nutzer „apigee“ geändert haben, ändern Sie den Inhaber der Datei in den Nutzer, der den Edge-Dienst ausführt.

Wenn Sie ein Attribut für eine Komponente festlegen möchten, bearbeiten Sie die entsprechende .properties-Datei, um ein Token festzulegen, und starten Sie dann die Komponente neu:

/opt/apigee/apigee-service/bin/apigee-service component restart

Nachdem Sie beispielsweise router.properties bearbeitet haben, starten Sie den Router neu:

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

Wenn Sie ein Upgrade von Edge durchführen, werden die .properties-Dateien im Verzeichnis /opt/apigee/customer/application gelesen. Das bedeutet, dass beim Upgrade alle Attribute beibehalten werden, die Sie für die Komponente festgelegt haben.

Speicherort von .properties-Dateien

Es gibt drei Verzeichnisse auf oberster Ebene für .properties-Dateien für Edge-Komponenten: Installation, Inhaber und Kunden. Die Standardstandorte sind in der folgenden Tabelle aufgeführt:

/opt/apigee/component_name/conf

/opt/apigee/token

/opt/apigee/customer

Aktuellen Wert eines Tokens ermitteln

Bevor Sie ein Token in der Datei .properties für die Komponente festlegen, können Sie 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 durchsucht, um den aktuellen Wert des Tokens zu ermitteln.

So prüfen Sie beispielsweise den aktuellen Wert des conf_http_HTTPRequest.line.limit-Tokens für den Router:

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

Die Ausgabe sollte im folgenden Format angezeigt werden:

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

Tokens in .properties-Dateien festlegen

So überschreiben Sie den Wert eines Tokens:

1. Bearbeiten Sie die Datei .properties für die Komponente, um den Tokenwert festzulegen. Wenn die Datei nicht vorhanden ist, erstellen Sie sie.
2. Starten Sie die Komponente neu.
3. Prüfen Sie den Tokenwert.

So legen Sie beispielsweise das Limit für die Anfragezeile für den Edge-Router fest:

1. Bearbeiten Sie die Datei /opt/apigee/customer/application/router.properties, um das Token conf_http_HTTPRequest.line.limit festzulegen:

   conf_http_HTTPRequest.line.limit=8k

2. Starten Sie den Edge-Router neu:

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

3. Prüfen Sie den Wert des Tokens:

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

Token mit mehreren Werten festlegen

Einige Tokens akzeptieren eine durch Kommas getrennte Liste von Werten. Das Token conf_security_rbac.restricted.resources verwendet beispielsweise eine Liste von URIs, die so eingeschränkt sind, dass nur der Systemadministrator sie aufrufen kann. So rufen Sie den Wert von conf_security_rbac.restricted.resources auf:

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

Die Ausgabe enthält Folgendes:

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

Wenn Sie ein Token festlegen möchten, das eine Liste von Werten akzeptiert, hängen Sie alle neuen Werte an den aktuellen Wert des Tokens in der Datei .properties an. Wenn Sie den URI /myuri/* zu conf_security_rbac.restricted.resources hinzufügen möchten, bearbeiten Sie die Datei /opt/apigee/customer/application/management-server.properties wie unten dargestellt:

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

Token suchen

In den meisten Fällen werden die erforderlichen Tokens in diesem Leitfaden genannt. Wenn Sie jedoch das Token ermitteln müssen, das zum Überschreiben eines Attributs verwendet wird, führen Sie einen grep im Ordner source der Komponente aus.

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, der zum Festlegen verwendet wurde, dann grep für das Attribut im Verzeichnis /opt/apigee/edge-ui/source:

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

Das Ergebnis sollte so aussehen:

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

Der String zwischen den {T}{/T}-Tags ist das Token, das Sie in der Datei .properties festgelegt haben.

Token festlegen, das derzeit auskommentiert ist

Einige Tokens sind in den Edge-Konfigurationsdateien auskommentiert. Wenn Sie versuchen, ein auskommentiertes Token festzulegen, wird die Einstellung ignoriert.

Wenn Sie ein auskommentiertes Token festlegen möchten, verwenden Sie eine spezielle Syntax im folgenden Format:

conf/file.extension+propertyName=propertyValue

Beispiel: Sie möchten das Attribut HTTPClient.proxy.host für den Message Processor festlegen. Anschließend rufen Sie grep für die Property auf, um das Token zu ermitteln:

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

Der Befehl grep gibt Ergebnisse in der Form zurück, die den Tokenwert enthält. Beachten Sie, dass der Attributname auskommentiert ist, wie durch das Präfix # im Attributnamen angegeben:

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 das Attribut so festzulegen:

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

Beachten Sie, dass dem Attributnamen conf/http.properties+, der Speicherort und der Name der Konfigurationsdatei, die das Attribut enthält, gefolgt von „+“ vorangestellt sind.

Prüfen Sie nach dem Neustart des Message Processors 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 das Attributset im folgenden Format:

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