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. Um beispielsweise TLS/SSL in der Edge-Benutzeroberfläche zu konfigurieren, bearbeiten Sie .properties-Dateien, um die erforderlichen Eigenschaften festzulegen. Änderungen an .properties-Dateien erfordern einen Neustart der betroffenen Edge-Komponente.

Bei Apigee wird das Bearbeiten von .properties-Dateien als Code mit Konfiguration bezeichnet. Im Grunde ist „code with config“ ein Tool zum Abrufen von Schlüssel/Wert-Paaren, das auf den Einstellungen in den .properties-Dateien basiert. Im Code mit Konfiguration werden die Schlüssel als Tokens bezeichnet. Zum Konfigurieren von Edge legen Sie daher Tokens in .properties-Dateien fest.

Mit Code mit Konfigurationsdatei 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 die von ihnen ausgewählten Eigenschaften überschreiben.

Wenn Sie sich die Einstellungen als Hierarchie vorstellen, sind sie so angeordnet, dass die Kundeneinstellungen die höchste Priorität haben und alle Einstellungen des Installationsteams oder von Apigee ü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 in einem Editor als beliebiger Nutzer.
2. Verwenden Sie chown, um den Eigentümer der Datei in „apigee:apigee“ zu ändern. Wenn Sie den Nutzer, der den Edge-Dienst ausführt, vom Nutzer „apigee“ geändert haben, weisen Sie die Datei dem Nutzer zu, der den Edge-Dienst ausführt.

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

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

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

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

Beim Upgrade von Edge 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 der .properties-Dateien

Es gibt drei Verzeichnisse auf oberster Ebene für .properties-Dateien für Edge-Komponenten: „installation“, „owner“ und „customers“. 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 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 in der Hierarchie der .properties-Dateien nach dem aktuellen Wert des Tokens gesucht.

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 der 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 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 mit mehreren Werten festlegen

Für einige Tokens ist eine durch Kommas getrennte Liste von Werten erforderlich. Das conf_security_rbac.restricted.resources-Token nimmt beispielsweise eine Liste von URIs an, die so eingeschränkt ist, 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 annimmt, hängen Sie neue Werte an den aktuellen Wert des Tokens in der Datei .properties an. Wenn Sie also conf_security_rbac.restricted.resources den URI /myuri/* 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 Tokens, die Sie festlegen müssen, in dieser Anleitung aufgeführt. Wenn Sie jedoch das Token ermitteln möchten, mit dem eine Property überschrieben wurde, führen Sie einen grep im Ordner source der Komponente aus.

Wenn Sie beispielsweise wissen, dass Sie in einer früheren Version von Edge die Property session.maxAge festgelegt haben, und den Tokenwert dafür ermitteln möchten, geben Sie grep für die Property im Verzeichnis /opt/apigee/edge-ui/source ein:

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

Es sollte eine Antwort im Formular angezeigt werden:

/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 du in der Datei .properties festgelegt hast.

Token festlegen, das derzeit kommentiert 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:

conf/file.extension+propertyName=propertyValue

Angenommen, Sie möchten die Property HTTPClient.proxy.host auf dem Nachrichtenprozessor festlegen. Rufen Sie dann grep für die Property ab, um das Token zu ermitteln:

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

Der Befehl grep gibt Ergebnisse im Formular zurück, das den Tokenwert enthält. Der Property-Name ist auskommentiert, was am Präfix # zu erkennen ist:

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 die Property so festzulegen:

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

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

Nachdem Sie den Nachrichten-Prozessor 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 die festgelegte Eigenschaft in folgendem Format:

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