So konfigurieren Sie Edge

Um Edge nach der Installation zu konfigurieren, verwenden Sie eine Kombination aus .properties-Dateien und Edge-Dienstprogramme. Um beispielsweise TLS/SSL in der Edge-Benutzeroberfläche zu konfigurieren, bearbeiten Sie .properties-Dateien, um die erforderlichen Attribute festzulegen. Änderungen an Für .properties-Dateien müssen Sie die betroffene Edge-Komponente neu starten.

Bei Apigee wird die Bearbeitung von .properties-Dateien als Code mit config (manchmal auch als CwC abgekürzt). Im Wesentlichen handelt es sich bei Code mit „config“ um eine Schlüssel/Wert-Suche. basierend auf den Einstellungen in .properties-Dateien. Im Code mit „config“ werden die Schlüssel als Tokens Daher legen Sie zum Konfigurieren von Edge Tokens in .properties fest. Dateien.

Code mit Konfiguration ermöglicht es Edge-Komponenten, Standardwerte festzulegen, die mit dem kann das Installationsteam diese Einstellungen auf Basis der Installationstopologie überschreiben, und Kunden können dann alle ausgewählten Attribute überschreiben.

Die Einstellungen sind hierarchisch angeordnet, wobei Einstellungen mit der höchsten Priorität die Einstellungen des Installateurteams oder Apigee:

1. Kunde
2. Installierer
3. Komponente

Aktuellen Wert eines Tokens ermitteln

Bevor Sie einen neuen Wert für ein Token in einer .properties-Datei festlegen, sollten Sie zuerst den Wert aktuell 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 Token. zu prüfen.

Dieser Befehl durchsucht die Hierarchie der .properties-Dateien der Komponente nach den aktuellen Wert des Tokens zu bestimmen.

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

/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 # beginnt, wurde es auskommentiert und Sie müssen eine spezielle Syntax, um sie zu ändern. Weitere Informationen finden Sie unter Legen Sie ein Token fest, das derzeit auskommentiert ist.

Wenn Sie nicht den vollständigen Namen des Tokens kennen, verwenden Sie ein Tool wie grep zum Suchen nach dem Eigenschaftsnamen oder dem Schlüsselwort suchen. Weitere Informationen finden Sie unter Token

Attributdateien

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

Bearbeitbare Konfigurationsdateien für Komponenten

In der folgenden Tabelle sind die Apigee-Komponenten und die Attributdateien aufgeführt, die Sie bearbeiten, um diese Komponenten zu konfigurieren:

Wenn Sie eine Eigenschaft in einer dieser Komponentenkonfigurationsdateien festlegen möchten, erstellt haben, können Sie sie am oben aufgeführten Speicherort erstellen.

Darüber hinaus müssen Sie sicherstellen, dass die Eigenschaftendatei dem „Apigee“ gehört. Nutzer:

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

Nicht bearbeitbare Komponentenkonfigurationsdateien

Zusätzlich zu den bearbeitbaren Komponentenkonfigurationsdateien gibt es auch Konfigurationsdateien die Sie nicht bearbeiten können.

Folgende Dateien können nicht bearbeitet werden:

/opt/apigee/token

/opt/apigee/component_name/conf

Tokenwert festlegen

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

So erstellen Sie eine .properties-Datei:

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

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

   Wenn Sie den Benutzer, der den Edge-Dienst ausführt, aus dem „apigee“ geändert haben Nutzer, verwenden chown, um die Eigentümerschaft auf den Nutzer zu übertragen, der den Edge ausführt .

Wenn Sie ein Upgrade für Edge ausführen, werden die .properties-Dateien im /opt/apigee/customer/application-Verzeichnis werden gelesen. Das bedeutet, dass das Upgrade behalten alle Eigenschaften bei, 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 ihn. Im folgenden Beispiel wird der Wert der conf_http_HTTPRequest.line.limit auf „10k“:

   conf_http_HTTPRequest.line.limit=10k

   Nimmt das Token mehrere Werte an, trennen Sie die einzelnen Werte durch ein Komma, wie im folgenden Beispiel gezeigt: Das Beispiel zeigt:

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

   Um einer Liste wie dieser einen neuen Wert hinzuzufügen, hängen Sie den neuen Wert in der Regel am Ende an. der Liste.

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)

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

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

4. (Optional) Prüfen Sie mithilfe der Methode Option configure -search. Beispiel:

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

   Weitere Informationen zu configure -search finden Sie unter Aktuellen Wert eines Tokens bestimmen

Token suchen

In den meisten Fällen sind die Tokens, die Sie festlegen müssen, in diesem Leitfaden angegeben. Wenn Sie jedoch Um den Wert eines vorhandenen Tokens zu überschreiben, dessen vollständiger Name oder Standort Sie nicht sicher sind, verwenden Sie grep, um das source-Verzeichnis der Komponente zu durchsuchen.

Wenn Sie zum Beispiel wissen, dass Sie in einer früheren Version von Edge den Parameter session.maxAge Attribut und möchten den Tokenwert wissen, mit dem es festgelegt wurde. dann grep für die Unterkunft in /opt/apigee/edge-ui/source Verzeichnis:

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

Das Ergebnis sollte im folgenden Format angezeigt werden:

/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 {T}{/T}-Tags ist der Name des Tokens, das Sie festlegen können. in der Datei .properties der Benutzeroberfläche.

Token festlegen, das derzeit auskommentiert ist

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

Verwenden Sie zum Festlegen des Werts eines Tokens, das in einer Edge-Konfigurationsdatei auskommentiert ist, eine spezielle Syntax:

conf/filename+propertyName=propertyValue

Um beispielsweise das Attribut HTTPClient.proxy.host für die Nachricht festzulegen, Prozessor, zuerst grep für die Eigenschaft, um ihr Token zu ermitteln:

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

Der Befehl grep gibt Ergebnisse zurück, die den Tokennamen enthalten. Hinweis wie der Attributname auskommentiert wird, wie durch das Präfix # 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 den Wert dieser Eigenschaft festzulegen, bearbeiten Sie /opt/apigee/customer/application/message-processor.properties, aber verwende eine spezielle Syntax, wie das folgende Beispiel zeigt:

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

In diesem Fall müssen Sie dem Attributnamen conf/http.properties+ voranstellen. Dieses ist der Speicherort und der Name der Konfigurationsdatei, die die Eigenschaft enthält, gefolgt von "+".

Prüfen Sie die Datei nach dem Neustart des Message Processor /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

Konfigurieren Sie den Weiterleitungsproxy für Anfragen aus dem Bereich „Anfragen senden“ der Trace-UI

In diesem Abschnitt wird erläutert, wie Sie den Weiterleitungsproxy für Anfragen vom Bereich „Send Requests“ (Anfragen senden) der Trace-UI mit optionalen Proxyanmeldedaten. So konfigurieren Sie den Weiterleitungs-Proxy:

1. Bearbeiten Sie die /opt/apigee/customer/application/ui.properties und vergewissern Sie sich, dass die Datei Eigentum von apigee:apigee.
2. Fügen Sie die folgenden Überschreibungen hinzu (ändern Sie die Werte für Ihre spezifische Proxy-Konfiguration):

   conf_application_http.proxyhost=proxy.example.com
   conf_application_http.proxyport=8080
   conf_application_http.proxyuser=apigee
   conf_application_http.proxypassword=Apigee123!

3. Speichern Sie die klassische UI und starten Sie sie neu.

Benutzerdefiniertes Logformat in Apigee Router/Nginx hinzufügen

In einigen Fällen mussten Sie entweder das Standard-Logformat von Apigee-Router/Nginx ändern oder Variablen hinzufügen. So aktualisieren Sie das Standard-Logformat von Apigee-Router/Nginx Konfiguration:

1. Falls noch nicht vorhanden, erstellen Sie eine router.properties-Datei mit dem folgenden Pfad:

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

2. Fügen Sie der Datei router.properties den folgenden Inhalt hinzu zum Erstellen einer neuen log_format-Konfiguration mit dem Namen router_new:

   conf_load_balancing_load.balancing.driver.nginx.global.http.parameters.template.extra=log_format router_new 'time_iso8601\\\\thostname\\\\tremote_addr:remote_port\\\\t'\\\\n\\n 'upstream_addr\\\\trequest_time\\\\t-\\\\t-\\\\t'\\\\n\\n 'status\\\\tupstream_status\\\\trequest_length\\\\t'\\\\n\\n 'body_bytes_sent\\\\t'\\\\n\\n 'request\\\\tupstream_http_x_apigee_message_id\\\\t'\\\\n\\n 'http_user_agent\\\\thost\\thostname-pid-connection-connection_requests\\\\tmy_nginx_var_xff\\t'\\\\n\\n 'upstream_http_x_apigee_fault_flag\\\\tupstream_http_x_apigee_fault_source\\\\tupstream_http_x_apigee_fault_code\\\\t'\\\\n\\n 'upstream_http_x_apigee_fault_policy\\tupstream_http_x_apigee_fault_flow\\tupstream_http_x_apigee_fault_revision\\t'\\\\n\\n 'upstream_http_x_apigee_dp_color\\\\tmy_x_apigee_target_latency\\\\t'\\\\n\\n 'upstream_http_x_apigee_proxy\\\\tupstream_http_x_apigee_proxy_basepath\\\\t'\\\\n\\n 'self_region\\\\tself_pod\\\\tself_color\\\\tssl_protocol\\\\tssl_client_verify\\\\tssl_session_id\\\\tssl_session_reused\\\\tupstream_pod\\\\tupstream_region';\\\\n\\n\n
   conf_load_balancing_load.balancing.driver.nginx.access.log={conf_load_balancing_load.balancing.driver.nginx.log.dir}/{org}~{env}.{port}_access_log router_new

   Aktualisieren Sie die Variablen in den obigen Befehlen nach Bedarf. Sie finden die Standard- Konfigurationswerte für log_format in der Datei unten:

   /opt/apigee/edge-router/conf/load_balancing.properties

   Eine Liste der Nginx-Variablen finden Sie unter http://nginx.org/en/docs/varindex.html.

3. Starten Sie den Router neu, um die neue Konfiguration anzuwenden:

   apigee-service edge-router restart

4. Prüfen Sie, ob die neue log_format-Konfiguration (router_new) wurde der Datei hinzugefügt /opt/nginx/conf.d/0-default.conf:

       
   cat /opt/nginx/conf.d/0-default.conf | grep router_new -A 10

5. Senden Sie einige API-Anfragen an einen API-Proxy und überprüfen Sie das neue Protokollformat in der Datei.

   /opt/apigee/var/log/edge-router/nginx/${org}~${env}.${port}_access_log file