So konfigurieren Sie Edge

Edge for Private Cloud v4.18.05

Um Edge nach der Installation zu konfigurieren, 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. 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. Im Wesentlichen ist Code mit „config“ ein Tool zur Suche nach Schlüssel/Wert-Paaren, das auf den Einstellungen in den .properties-Dateien basiert. Im Code mit einer Konfiguration werden die Schlüssel als Tokens bezeichnet. Daher legen Sie zum Konfigurieren von Edge Tokens in .properties-Dateien fest.

Code mit Konfiguration ermöglicht Edge-Komponenten, Standardwerte festzulegen, die mit dem Produkt geliefert werden. Das Installationsteam kann diese Einstellungen je nach Installationstopologie überschreiben. Anschließend haben Kunden die Möglichkeit, alle gewünschten Attribute zu überschreiben.

Wenn Sie es sich als Hierarchie vorstellen, sind die Einstellungen so angeordnet, dass die Kundeneinstellungen die höchste Priorität haben, um 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 in diesem Verzeichnis eine eigene .properties-Datei. Beispiel: router.properties und management-server.properties.

So erstellen Sie beispielsweise eine .properties-Datei:

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

Um ein Attribut für eine Komponente festzulegen, 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

Starten Sie beispielsweise nach dem Bearbeiten von router.properties den Router neu:

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

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

Speicherort von .properties-Dateien

Es gibt drei Verzeichnisse der obersten Ebene für .properties-Dateien für Edge-Komponenten: Installation, Eigentümer und Kunden. Die Standardspeicherorte 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 zuerst mit dem folgenden Befehl den aktuellen Wert 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.

Dieser Befehl durchsucht die Hierarchie von .properties-Dateien, um den aktuellen Wert des Tokens zu ermitteln.

So prüfen Sie beispielsweise den aktuellen Wert des Tokens conf_http_HTTPRequest.line.limit 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 Anfragezeilen für den Edge Router fest:

1. Bearbeiten Sie die Datei /opt/apigee/customer/application/router.properties, um das conf_http_HTTPRequest.line.limit-Token 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 festlegen, das mehrere Werte annimmt

Einige Tokens verwenden eine durch Kommas getrennte Liste von Werten. Für das Token conf_security_rbac.restricted.resources ist beispielsweise eine Liste eingeschränkter URIs erforderlich, sodass nur der Systemadministrator sie aufrufen kann. So rufen Sie den Wert von conf_security_rbac.restricted.resources ab:

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

Zum Festlegen eines Tokens, das eine Liste von Werten annimmt, hängen Sie alle neuen Werte an den aktuellen Wert des Tokens in der Datei .properties an. Um den URI /myuri/* zu conf_security_rbac.restricted.resources hinzuzufügen, müssen Sie daher die Datei /opt/apigee/customer/application/management-server.properties so bearbeiten:

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 Tokens, die Sie festlegen müssen, in diesem Leitfaden identifiziert. Wenn Sie jedoch das Token ermitteln müssen, mit dem ein Attribut überschrieben wird, führen Sie im Ordner source der Komponente einen grep aus.

Wenn Sie beispielsweise wissen, dass Sie in einer vorherigen Version von Edge das Attribut session.maxAge festgelegt haben und wissen möchten, mit welchem Tokenwert es festgelegt wurde, dann 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 im folgenden Format sehen:

/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.

Um ein auskommentiertes Token festzulegen, verwenden Sie eine spezielle Syntax im folgenden Format:

conf/file.extension+propertyName=propertyValue

Sie möchten beispielsweise die Eigenschaft HTTPClient.proxy.host für den Message Processor festlegen. Anschließend grep für das Attribut, um sein 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. Der Attributname ist auskommentiert, 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=

Um das Attribut festzulegen, bearbeiten Sie /opt/apigee/customer/application/message-processor.properties und legen Sie das Attribut so fest:

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

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

Untersuchen Sie nach dem Neustart des Message Processor die Datei /opt/apigee/edge-message-processor/conf/http.properties:

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

Am Ende der Datei wird die festgelegte Eigenschaft in folgendem Format angezeigt:

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