Attribute der klassischen Benutzeroberfläche zur neuen Edge-Benutzeroberfläche migrieren

In Apigee Edge for Private Cloud 4.54.00 wird die klassische Benutzeroberfläche (die Komponente edge-ui) entfernt und ist nicht mehr verfügbar. Die neue Edge-Benutzeroberfläche (die edge-management-ui-Komponente) ist die einzige Benutzeroberfläche für Edge for Private Cloud.

Sie können edge-ui in Edge for Private Cloud 4.54.00 nicht verwenden. Wenn Sie die klassische Benutzeroberfläche durch Festlegen von Attributen in /opt/apigee/customer/application/ui.properties angepasst haben, wird diese Datei von der neuen Edge-Benutzeroberfläche nicht gelesen. Nachdem Sie auf Version 4.54.00 aktualisiert haben, müssen Sie die entsprechenden Attribute in /opt/apigee/customer/application/management-ui.properties festlegen.

Auf dieser Seite sind die für ui.properties dokumentierten Attribute der klassischen Benutzeroberfläche, die entsprechenden Attribute für die neue Edge-Benutzeroberfläche und die Attribute der klassischen Benutzeroberfläche aufgeführt, die in der neuen Edge-Benutzeroberfläche nicht unterstützt werden.

Die neue Edge-Benutzeroberfläche verwendet denselben Code mit Konfigurationsmechanismus (CwC) wie andere Edge-Komponenten. Weitere Informationen finden Sie unter Edge konfigurieren.

Klassische UI- und neue Edge-UI-Konfigurationen vergleichen

Die neue Edge-Benutzeroberfläche ersetzt die Classic-Benutzeroberfläche, die Eigenschaftendatei, den Dienstnamen, den Standardport und das TLS-Zertifikatsformat. In der folgenden Tabelle finden Sie Informationen dazu, wie Sie Ihre Automatisierungsskripts, Firewallregeln und TLS-Dateien aktualisieren, bevor Sie Ihre Properties migrieren:

Attribute für die neue Edge-Benutzeroberfläche festlegen

Legen Sie die Konfigurationsattribute der neuen Edge-Benutzeroberfläche in /opt/apigee/customer/application/management-ui.properties fest und starten Sie den Dienst edge-management-ui neu, damit die Änderungen wirksam werden.

So legen Sie eine Property für die neue Edge-Benutzeroberfläche fest:

1. Öffnen Sie die Datei management-ui.properties in einem Editor. Wenn die Datei nicht vorhanden ist, erstellen Sie sie:

   vi /opt/apigee/customer/application/management-ui.properties
   

2. Legen Sie das Attribut fest. Beispiel:

   conf_uebe_disableGeoMap=true

3. Speichern Sie die Änderungen.
4. Achten Sie darauf, dass die Datei dem Nutzer apigee gehört:

   chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
   

5. Starten Sie die New Edge-Benutzeroberfläche neu:

   /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
   

Beachten Sie die folgenden Formatierungsregeln, wenn Sie Attribute für die neue Edge-Benutzeroberfläche festlegen:

• Bei Attributnamen wird zwischen Groß- und Kleinschreibung unterschieden. Beispiel: conf_uebe_disableGeoMap ist gültig, conf_uebe_disablegeomap jedoch nicht.
• Schließen Sie Stringwerte in doppelte Anführungszeichen ein, z. B. conf_uebe_branding_companyNameShort="My Company".
• Setzen Sie boolesche Werte (true oder false) oder numerische Werte nicht in Anführungszeichen. Wenn ein boolescher oder numerischer Wert in Anführungszeichen gesetzt ist, wird die neue Edge-Benutzeroberfläche nicht gestartet.

Mit der Option -search können Sie den aktuellen Wert eines Attributs prüfen. Beispiel:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

Eigenschaften der klassischen Benutzeroberfläche der neuen Edge-Benutzeroberfläche zuordnen

In den folgenden Tabellen wird jedes unterstützte Attribut der Classic UI in ui.properties dem entsprechenden Attribut der New Edge UI in management-ui.properties zugeordnet. In der Spalte Standard wird der Standardwert in der neuen Edge-Benutzeroberfläche angezeigt.

Eigenschaften von Funktionen konfigurieren

Ordnen Sie die Funktions-Flags der klassischen Benutzeroberfläche den entsprechenden conf_uebe_*-Eigenschaften in management-ui.properties zu:

Sitzungs- und TLS-Attribute konfigurieren

Ordnen Sie die Zeitüberschreitung für Sitzungen und die TLS-Eigenschaften der klassischen Benutzeroberfläche den entsprechenden Eigenschaften der neuen Edge-Benutzeroberfläche in management-ui.properties zu:

E‑Mail-Attribute und ‑Vorlagen konfigurieren

Ordnen Sie die Eigenschaften für Absender, Betreff, Branding, Host-URL und Linkablauf der klassischen Benutzeroberfläche der neuen Edge-Benutzeroberfläche zu:

Die neue Edge-Benutzeroberfläche verwendet integrierte E-Mail-Vorlagen. So verwenden Sie die Vorlagen, die Sie für die klassische Benutzeroberfläche angepasst haben:

1. Erstellen Sie das Verzeichnis /opt/apigee/edge-management-ui/email-templates.
2. Kopieren Sie die angepassten Dateien password-reset.html, user-added-existing.html und user-added-new.html aus dem Sicherungsverzeichnis, das Sie vor dem Update erstellt haben (z. B. /opt/apigee/customer/backup/), nach /opt/apigee/edge-management-ui/email-templates. Die Vorlagendateinamen und Platzhalter sind mit denen in der klassischen Benutzeroberfläche identisch.
3. Achten Sie darauf, dass das Verzeichnis und die Dateien dem Nutzer apigee gehören.
4. Starten Sie die neue Edge-Benutzeroberfläche neu.

Weitere Informationen finden Sie unter Edge-E-Mail-Vorlagen anpassen.

Eigenschaften für automatisch generierte Passwörter konfigurieren

So ordnen Sie automatisch generierte Passwortattribute der klassischen Benutzeroberfläche der neuen Edge-Benutzeroberfläche zu:

Verbindung zum Management Server und Eigenschaften des gemeinsamen Secrets konfigurieren

Ordnen Sie die Eigenschaften für Verbindung, Anmeldedaten und Anwendungsschlüssel des Management Servers der klassischen UI der neuen Edge-UI zu:

Eigenschaften der klassischen Benutzeroberfläche entfernen, für die keine Maßnahmen erforderlich sind

Die folgenden Eigenschaften der klassischen Benutzeroberfläche haben kein Äquivalent in der neuen Edge-Benutzeroberfläche, da das Verhalten immer aktiviert ist. Nehmen Sie diese Attribute nicht in management-ui.properties auf und entfernen Sie sie aus allen automatisierten Konfigurationsskripts:

Nicht unterstützte Classic UI-Properties entfernen

Die folgenden Eigenschaften der klassischen Benutzeroberfläche werden nicht unterstützt und haben kein Äquivalent in der neuen Edge-Benutzeroberfläche. Nehmen Sie diese Attribute nicht in management-ui.properties auf und entfernen Sie sie aus allen automatisierten Konfigurationsskripts:

Migrationsbeispiel ansehen

Im folgenden Beispiel wird eine ui.properties-Datei der klassischen Benutzeroberfläche mit der entsprechenden management-ui.properties-Datei für die neue Edge-Benutzeroberfläche verglichen.

Klassische Benutzeroberfläche, /opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Neue Edge-Benutzeroberfläche, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

Beachten Sie, dass der boolesche Wert true nicht in Anführungszeichen gesetzt ist und dass das Sitzungszeitlimit 1d durch 24 ersetzt wird.

Nachdem Sie die Datei gespeichert haben, starten Sie die neue Edge-Benutzeroberfläche neu:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

Zusammenfassende Checkliste

Verwenden Sie die folgende Checkliste, um die Migration zur neuen Edge-Benutzeroberfläche in Apigee Edge for Private Cloud 4.54.00 abzuschließen:

1. Sichern Sie /opt/apigee/customer/application/ui.properties und alle benutzerdefinierten E-Mail-Vorlagen aus /opt/apigee/edge-ui/email-templates, bevor Sie das Upgrade durchführen.
2. Fügen Sie /opt/apigee/customer/application/management-ui.properties zugeordnete Properties hinzu, ohne boolesche oder numerische Werte in Anführungszeichen zu setzen, und lassen Sie nicht unterstützte Properties der klassischen Benutzeroberfläche weg.
3. Kopieren Sie benutzerdefinierte E‑Mail-Vorlagen aus Ihrem Sicherungsverzeichnis nach /opt/apigee/edge-management-ui/email-templates.
4. Sysadmin-Anmeldedaten mit ./bin/management-ui --encrypt neu verschlüsseln, wenn Sie conf_uebe_mgmtCredential festlegen.
5. Legen Sie die Eigentümerschaft der Datei auf apigee:apigee fest und starten Sie edge-management-ui neu.