Edge for Private Cloud Version 4.16.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.
Bei Apigee wird das Bearbeiten von .properties-Dateien als Code mit config bezeichnet. Im Wesentlichen ist Code mit „config“ ein Schlüssel/Wert-Paar-Lookup-Tool, das auf den Einstellungen in den .properties-Dateien basiert. Im Code mit der 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:
- Kunde
- Installierer
- Apigee
.properties-Dateien verwenden
Als Kunde können Sie nur die .properties-Dateien im Verzeichnis /<inst_root>/apigee/customer/application ändern. Jede Komponente hat in diesem Verzeichnis eine eigene .properties-Datei. Beispiel: router.properties und management-server.properties.
- Erstellen Sie die Datei als beliebiger Nutzer in einem Editor.
- Wählen Sie den Eigentümer der Datei in apigee:apigee aus. Wenn Sie den Benutzer, der den Edge-Dienst über den 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:
> /<inst_root>/apigee/apigee-service/bin/apigee-service component restart
Starten Sie beispielsweise nach dem Bearbeiten von router.properties den Router neu:
> /<inst_root>/apigee/apigee-service/bin/apigee-service edge-router restart
Wenn Sie Edge aktualisieren, werden die .properties-Dateien im Verzeichnis /<inst_root>/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: Installationsinhaber und Kunden. Die Standardspeicherorte sind in der folgenden Tabelle aufgeführt:
Warnung: Edge-Kunden können die .properties-Dateien nur unter /<inst_root>/apigee/customer ändern. Sie können die Dateien zwar in den Komponenten- und Installationsverzeichnissen ansehen, ändern Sie aber keine Dateien.
|
Inhaber |
Standard-Token-Stammverzeichnis |
|---|---|
|
Komponente |
<inst_root>/apigee/<prefix>-<component>/conf wobei /<Präfix>-<Komponente> die Komponente identifiziert, z. B. Edge-Router oder Apigee-Cassandra. |
|
Installation |
<inst_root>/apigee/token |
|
Kunde |
<inst_root>/apigee/customer |
Aktuellen Wert eines Tokens ermitteln
Bevor Sie ein Token in der .properties-Datei für die Komponente festlegen, können Sie zuerst seinen aktuellen Wert mit dem folgenden Befehl ermitteln:
> /<inst_dir>/apigee/apigee-service/bin/apigee-service comp configure -search token
Dabei ist comp der Name der Komponente und token das zu prüfende Token.
Dieser Befehl durchsucht die Hierarchie der .properties-Dateien, um den aktuellen Wert des Tokens zu ermitteln.
So prüfen Sie beispielsweise den aktuellen Wert des Tokens conf_router_HTTP.request.line.limit für den Router:
> /<inst_dir>/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_router_HTTP.request.line.limit
Die Ausgabe sollte im folgenden Format angezeigt werden:
Found key conf_router_HTTP.request.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:
- Bearbeiten Sie die Datei .properties für die Komponente, um den Tokenwert festzulegen. Wenn die Datei nicht vorhanden ist, erstellen Sie sie.
- Starten Sie die Komponente neu.
- Prüfen Sie den Tokenwert.
So legen Sie beispielsweise das Limit für Anfragezeilen für den Edge Router fest:
- Bearbeiten Sie die Datei /<inst_root>/apigee/customer/application/router.properties, um das Token conf_router_HTTP.request.line.limit festzulegen:
conf_router_HTTP.request.line.limit=8k - Starten Sie den Edge Router neu:
> /<inst_root>/apigee/apigee-service/bin/apigee-service Edge-Router-Neustart - Prüfen Sie den Wert des Tokens:
> /<inst_dir>/apigee/apigee-service/bin/apigee-service Edge-Router-Konfiguration -search conf_router_HTTP.request.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 wird beispielsweise eine Liste eingeschränkter URIs benötigt, sodass nur der Systemadministrator sie aufrufen kann. So rufen Sie den Wert von conf_security_rbac.restricted.resources ab:
> cd /<inst_root>/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
Um ein Token festzulegen, das eine Liste von Werten annimmt, hängen Sie alle neuen Werte an den aktuellen Wert des Tokens in der Datei .properties an. Bearbeiten Sie daher die Datei /<inst_root>/apigee/customer/application/management-server.properties wie unten gezeigt, um den URI /myuri/* zu conf_security_rbac.restricted.resources hinzuzufügen:
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 eine Eigenschaft überschrieben wurde, führen Sie im Ordner source der Komponente einen grep-Befehl aus.
Wenn Sie beispielsweise wissen, dass Sie in einer vorherigen Version von Edge die Eigenschaft session.maxAge festgelegt haben und den Tokenwert wissen möchten, mit dem sie festgelegt wurde, dann grep für die Eigenschaft im Verzeichnis /<inst_root>/apigee/edge-ui/source:
> grep -ri "session.maxAge" /<inst_root>/apigee/edge-ui/source
Sie sollten ein Ergebnis im folgenden Format sehen:
/<inst_root>/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 führen Sie den Befehl grep für das Attribut aus, 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 am 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 zum Festlegen des Attributs /opt/apigee/customer/application/message-processor.properties so, dass das Attribut folgendermaßen festgelegt wird:
conf/http.properties+HTTPClient.proxy.host=myhost.name.com
Beachten Sie, wie dem Property-Namen conf/http.properties+ vorangestellt ist, dem Speicherort und dem Namen der Konfigurationsdatei, die das Attribut enthält, gefolgt von „+“.
Überprüfen 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=yhost.name.com