Managed Runtime Administration

Mit Managed Runtime ist die Verwaltung der mit Ihrer PWA Kit-Storefront verknüpften Organisationen, Projekte, Umgebungen und Bündeln ganz leicht. Diese Anleitung beschreibt die ständig größer werdende Liste mit Administrationsaufgaben, die in dem webbasierten Tool Runtime Admin möglich sind. (Alle der in dieser Anleitung beschriebenen Aktionen können wie auch viele zusätzliche Aktionen ebenfalls mit der Managed Runtime API durchgeführt werden.)

Projekte helfen Ihnen bei der Verwaltung mehrerer Umgebungen innerhalb einer Organisation. Jedes PWA Kit-Projekt benötigt ein entsprechendes Projekt in Managed Runtime für die Bereitstellung und das Hosting des Storefront-Codes in der öffentlichen Cloud-Infrastruktur von Salesforce.

So erstellen Sie ein Projekt in Runtime Admin:

1. Melden Sie sich in Runtime Admin an.
2. Klicken Sie auf New Project (Neues Projekt).
3. Geben Sie einen Namen für das Projekt ein.
4. Klicken Sie auf Create Project (Projekt erstellen).

Diese Anweisungen für die restlichen Administrationsaufgaben in dieser Anleitung gehen davon aus, dass Sie die Übersichtsseite eines Projekts in Runtime Admin als Ausgangpunkt verwenden.

So finden Sie ein vorhandenes Projekt und öffnen seine Übersichtsseite:

1. Melden Sie sich in Runtime Admin an.
2. Wählen Sie gegebenenfalls eine Organisation aus dem Organisationsmenü (oben links).
3. Klicken Sie auf den Namen des Projekts. (Um das Projekt sehen zu können, muss Ihnen eine der zuvor beschriebenen Projektrollen zugewiesen sein.)

Über das Projektmenü oben auf der Seite können Sie schnell zwischen verschiedenen Projekten wechseln.

Auf der Seite Projekteinstellungen können Sie die folgenden Aktionen durchführen:

• Die Projekt-ID suchen und sicherstellen, dass sie mit einer PWA Kit-Konfiguration übereinstimmt.
• Die Projekt-ID bearbeiten.
• Namen und URL des Projekts anzeigen und bearbeiten.
• Das Projekt löschen.
• Bereitstellungsbenachrichtigungen verwalten (siehe nächster Abschnitt).

So greifen Sie auf die Seite "Project Settings" (Projekteinstellungen) zu:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsmenü auf "Project Settings" (Projekteinstellungen).

Klicken Sie zur Bearbeitung der Einstellungen auf Edit (Bearbeiten); nehmen Sie die Änderungen vor und klicken Sie anschließend auf Update (Aktualisieren). Wenn Sie die Änderungen verwerfen möchten, klicken Sie auf Canel (Abbrechen).

Klicken Sie auf Delete (Löschen), um ein Projekt zu löschen. Geben Sie zur Bestätigung den Projektnamen ein und klicken Sie auf Yes, Delete (Ja, löschen). Um das Projekt nicht zu löschen, klicken Sie auf No, Keep (Nein, behalten).

Sie können wählen, sich per E-Mail von den folgenden Bereitstellungsereignissen informieren zu lassen:

• Bereitstellungsstart
• Erfolgreiche Bereitstellung
• Fehlgeschlagene Bereitstellung

So fügen Sie eine Benachrichtigung hinzu:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsbereich auf Project Settings (Projekteinstellungen).
3. Klicken Sie auf Add Notification (Benachrichtigung hinzufügen).
4. Wählen Sie eine oder mehr Umgebungen aus, für die die Benachrichtigung ausgegeben werden soll.
5. Wählen Sie ein oder mehr Bereitstellungsereignisse aus.
6. Geben Sie die E-Mail-Adressen aller Empfänger der Benachrichtigung ein.
7. Klicken Sie auf Add Notification (Benachrichtigung hinzufügen).

So bearbeiten Sie eine Benachrichtigung:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsbereich auf Project Settings (Projekteinstellungen).
3. Klicken Sie auf die Schaltfläche ... neben der Benachrichtigung.
4. Klicken Sie auf Edit (Bearbeiten).
5. Ändern Sie die Benachrichtigungseinstellungen wie gewünscht.
6. Klicken Sie auf Update Notification (Benachrichtigung aktualisieren).

So entfernen Sie eine Benachrichtigung:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsbereich auf Project Settings (Projekteinstellungen).
3. Klicken Sie auf die Schaltfläche ... neben der Benachrichtigung.
4. Klicken Sie auf Remove (Entfernen).
5. Klicken Sie auf Yes, Remove (Ja, entfernen).

Mithilfe von Umgebungen können Sie Ihre Production-Storefront von anderen Storefronts getrennt betreiben, die anderen Zwecken wie beispielsweise der Entwicklung oder dem Testen dienen. Näheres zu Umgebungen und verwandten Konzepten finden Sie in der Übersicht über Managed Runtime.

So erstellen Sie in Runtime Admin eine Umgebung:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf New Environment (Neue Umgebung).
3. Geben Sie einen Namen für die Umgebung ein.
4. Wählen Sie eine Region für die Bereitstellung in der öffentlichen Cloud-Infrastruktur von Salesforce.
5. Wenn die Umgebung eine Produktionsumgebung ist, kennzeichnen Sie sie als Produktionsumgebung. Wenn Sie die maximale Anzahl an Produktionsumgebungen erreicht haben, wenden Sie sich an den Support.
6. Klicken Sie auf Create Environment (Umgebung erstellen).

Für jede Website, die das PWA Kit und Managed Runtime verwendet, können Sie für jede Umgebung nur jeweils ein Bündel als bereitgestellt kennzeichnen.

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf den Namen der Umgebung, in der Sie die Daten bereitstellen möchten. Beispiel: Production.
3. Klicken Sie unter dem Titel Bundles (Bündel) neben dem Bündel, das Sie bereitstellen möchten, auf die Schaltfläche Deploy (Bereitstellen).
4. Klicken Sie auf Confirm Deploy (Bereitstellung bestätigen).
5. Warten Sie, bis die Bereitstellung abgeschlossen ist.

Nach erfolgreicher Bereitstellung wird das Bündel unter Deployed Bundle (Bereitgestelltes Bündel) aufgeführt. (Bei der ersten Bereitstellung in einer neuen Umgebung kann dieser Prozess bis zu eine Stunde in Anspruch nehmen.)

Auf der Seite "Umgebungseinstellungen" können Sie viele Administrationsaufgaben wie die folgenden zentral durchführen:

• Eine Umgebung oder Umgebungs-ID umbenennen.
• Die Bereitstellungsregion ändern.
• Bestimmten IP-Adressen Zugriff auf die Umgebung gewähren.
• Proxys für die Umgebung konfigurieren. Näheres hierzu finden Sie in Proxy-Anfragen.
• Kennzeichnen Sie eine Umgebung als Produktionsumgebung.
• Eine Umgebung löschen.

So greifen Sie auf die Seite "Umgebungseinstellungen" zu:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf den Namen der Umgebung, deren Einstellungen Sie bearbeiten möchten.
3. Klicken Sie im linken Navigationsmenü auf Umgebungseinstellungen.

Klicken Sie auf die Schaltfläche Edit (Bearbeiten) entweder neben den allgemeinen (General) oder den erweiterten (Advanced) Einstellungen. Klicken Sie nach Vornahme der Änderungen auf Update (Aktualisieren), um Ihre Änderungen zu speichern, oder auf Cancel (Abbrechen), um sie zu verwerfen.

Umgebungsvariablen ermöglichen Ihnen, Variablen zu einem in einer Umgebung laufenden Anwendungsprozess hinzuzufügen, ohne Codeänderungen vornehmen zu müssen. Umgebungsvariablen werden sicher gespeichert, was sie ideal für Anwendungsbeispiele wie Folgendes macht:

• API-Schlüssel für Drittanbieter-Integrationen
• Funktionalitätsmarker für Anwendungslogik
• Konfiguration, die zwischen Umgebungen unterschiedlich ist

Umgebungsvariablen können unter Verwendung der Managed Runtime API verwaltet werden. Mithilfe von process.env können Sie in Node.js auf diese Variablen zugreifen.

Verwenden Sie projects_target_env_var_partial_update, um Umgebungsvariablen zu setzen, zu aktualisieren und zu löschen:

Wählen Sie Namen für die Umgebungsvariablen, die im Rahmen Ihrer App aussagekräftig sind. Die Werte von Umgebungsvariablen können boolesch, ganzzahlig oder eine Zeichenfolge sein. Kodieren Sie JSON in eine Zeichenfolge, um komplexe Werte festzulegen.

Um eine vorhandene Umgebungsvariable zu löschen, setzen Sie ihren Wert auf null.

Nach einer Änderung von Umgebungsvariablen wird das aktuellen Bündel für die Umgebung erneut bereitgestellt.

Verwenden Sie projects_target_env_var_list, um alle für eine Umgebung festgelegten Umgebungsvariablen abzurufen:

Die Verwendung von Umgebungsvariablen unterliegt den folgenden Einschränkungen:

• Jede Umgebung kann maximal 100 Umgebungsvariablen enthalten.
• Die maximale Größe der für eine Umgebung festgelegten Werte von Umgebungsvariablen beträgt 32 KB.
• Die Namen von Umgebungsvariablen dürfen höchsten 512 Zeichen lang sein und dürfen nicht mit den reservierten Präfixen AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY beginnen.
• Die Namen von Umgebungsvariablen dürfen keine der reservierten Namen verwenden: BUNDLE_ID, DEPLOY_ID, DEPLOY_TARGET, EXTERNAL_DOMAIN_NAME, HANDLER, LAMBDA_RUNTIME_DIR, LAMBDA_TASK_ROOT, NODE_ENV, REDIRECT_BUCKET, REDIRECT_KEY, REDIRECT_UPDATE, REMOTE, X_AMZN_TRACE_ID.

Mit einer Umleitung können Sie eine Anfrage von der angeforderten URL an eine andere URL weiterleiten. Umleitungen können dazu beitragen, Unterbrechungen des Benutzererlebnisses zu vermeiden, die durch Änderungen an Ihrer Storefront entstehen. Ein Beispiel dafür wäre eine Seite für eine Frühjahrskampagne. Wenn die Frühjahrskampagne zu Ende ist und durch eine Sommerkampagne ersetzt wird, können Sie eine Umleitung von der Frühjahrs-URL zur Sommer-URL erstellen.

Umleitungen sind eine leistungsstarke Funktionalität, die wesentliche Auswirkungen auf die Sicherheit Ihrer Storefront haben kann - wie beispielsweise eine Umleitung an böswillige URLs oder Assets. Seien Sie daher vorsichtig, wenn Sie Ihren Benutzern Rollen mit Zugriff auf die Redirect-Funktion zuweisen.

So erstellen Sie eine Umleitung:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf den Namen der Umgebung, in der Sie die Umleitung erstellen möchten.
3. Klicken Sie im linken Navigationsbereich auf URL Redirects (URL-Umleitungen).
4. Klicken Sie auf Create Redirect (Umleitung erstellen).
5. Geben Sie im Feld Redirect From (Umleiten von) einen relativen URL-Pfad ein. Beispiel: Um Besucher von der URL www.example.com/winter umzuleiten, geben Sie /winter ein.
6. Geben Sie in das Feld Redirect To (Umleiten zu) einen relativen URL-Pfad ein.
7. Aktivieren Sie gegebenenfalls die Weiterleitung von Abfrageparametern und den Platzhalterpfad. (Weitere Informationen zu den Weiterleitungseinstellungen finden Sie weiter unten.)
8. Wählen Sie basierend auf dem HTTP-Statuscode im Drop-down-Menü Redirect Type (Umleitungstyp) einen Umleitungstyp aus. (Weitere Informationen zu Statuscodes finden Sie weiter unten.)
9. Klicken Sie auf Create Redirect (Umleitung erstellen).

Sehen wir uns die Optionen für die Erstellung einer Umleitung etwas genauer an.

Der Wert, den Sie im Feld Redirect From (Umleiten von) eingeben, muss immer ein relativer Pfad sein. Das Feld Redirect To (Umleiten zu) kann entweder einen relativen Pfad oder eine vollständige URL enthalten. Beispiel: Sie wollen Besucher von www.example.com/spring zu www.example.com/summer umleiten. Das Feld Redirect From (Umleiten von) muss /spring enthalten. Das Redirect To (Umleiten zu) kann entweder /summer oder www.example.com/summer enthalten.

Mit einem Sternchen (*) am Ende der Redirect From-URL setzen Sie einen Platzhalter. Ein Platzhalter entspricht einer beliebigen Anzahl von Zeichen (0 oder mehr) in der URL. Beispiel: Eine Umleitung von /a/* entspricht /a/, /a/b und /a/b/c.

Ein Platzhalterzeichen kann nur am Ende der Redirect From-URL gesetzt werden.

Standardumleitungen werden von Managed Runtime zuerst bearbeitet, gefolgt von Umleitungen mit Platzhaltern.

Die meisten Umleitungen verwenden den Statuscode "Permanent 301", aber Sie können auch "Temporary 302" auswählen. Wenn Sie sich nicht sicher sind, welchen HTTP-Statuscode Sie verwenden sollten, ziehen Sie diese Erklärung von Statuscodes auf MOZ.com zurate.

Einige Anfragen enthalten Parameter für Abfrage-Strings, die Sie auch in der umgeleiteten Anfrage verwenden möchten. Beispiel: Der relative Pfad /spring-landing-page kann zum Zweck der analytischen Verfolgung mit einer Abfrage-String wie z. B. /spring-landing-page?gclid=123 erweitert werden.

Um die Weiterleitung von Abfrageparametern zu aktivieren, gehen Sie im Formular zum Abschnitt Forward (Weiterleiten) und wählen Sie Query Parameters (Abfrageparameter) aus. Ohne diesen Schritt sind Abfrage-String-Parameter der Quell-URL nicht in der Umleitungs-URL enthalten.

Was passiert, wenn sowohl die Redirect From-URL als auch die Redirect To-URL Abfrage-Strings enthalten und die Weiterleitung aktiviert ist? In diesem Fall enthält die Umleitungs-URL eine Kombination der beiden Abfrage-Strings. Die Abfrageparameter von der Redirect To-URL werden der Abfrage-String in der Anfrage angehängt. Beispiel: Ihre Anwendung erhält eine Anfrage für den relativen Pfad /spring?year=2019. Wenn /spring zu /summer?year=2020 umgeleitet werden soll und die Weiterleitung aktiviert ist, lautet die Umleitungs-URL /summer?year=2019&year=2020.

Sie können alle dem Platzhalterzeichen entsprechenden Pfadsegmente der Redirect From-URL automatisch an die Redirect To-URL anhängen. Beispiel: Wenn /a/* in der Redirect From-URL /a/b/c entspricht und die Redirect To-URL /z/ ist, lautet die Umleitungs-URL /z/b/c.

Um die Weiterleitung von Platzhalterpfaden zu aktivieren, gehen Sie im Formular zum Abschnitt Forward (Weiterleiten) und wählen Sie Wildcard Path (Platzhalterpfad) aus.

Mithilfe der Funktionalität "Umleitungen klonen" können Sie alle Umleitungen von einer Umgebung in eine andere kopieren.

So klonen Sie Umleitungen:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf den Namen der Umgebung, die die zu klonenden Umleitungen enthält.
3. Klicken Sie im linken Navigationsbereich auf URL Redirects (URL-Umleitungen).
4. Klicken Sie auf Clone Redirects (Umleitungen klonen). Das Formular Clone Redirects (Umleitungen klonen) wird angezeigt. Die aktuelle Umgebung ist unter From Environment (Von Umgebung) (der Quelle) aufgeführt.
5. Wähle Sie unter To Environment (Zu Umgebung) die Umgebung, in die Sie die Umleitungen klonen möchten (das Ziel).
6. Klicken Sie auf Clone n Redirects (n Umleitungen klonen). (n entspricht dabei der Anzahl der zu klonenden Umleitungen.)

So bearbeiten Sie die Einstellungen einer vorhandenen Umleitung:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf den Namen der Umgebung, die die zu bearbeitende Umleitung enthält.
3. Klicken Sie im linken Navigationsbereich auf URL Redirects (URL-Umleitungen).
4. Klicken Sie neben der Umleitung auf die Schaltfläche "...".
5. Klicken Sie auf Edit (Bearbeiten).
6. Aktualisieren Sie die Einstellungen.
7. Klicken Sie auf Update Redirect (Umleitung aktualisieren).

So löschen Sie eine Umleitung:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie auf den Namen der Umgebung, die die zu löschende Umleitung enthält.
3. Klicken Sie im linken Navigationsbereich auf URL Redirects (URL-Umleitungen).
4. Klicken Sie neben der Umleitung auf die Schaltfläche "...".
5. Klicken Sie auf Delete (Löschen).
6. Klicken Sie auf Yes, Delete Redirect (Ja, Umleitung löschen).

Wenn eine Umleitung nicht wie erwartet funktioniert, können diese Schritte bei der Fehlerbehebung helfen:

• Löschen Sie den Browser-Cache, da Umleitungen im Browser-Cache zwischengespeichert werden.
• Stellen Sie sicher, dass Sie sich die Einstellungen für die korrekte Umgebung anzeigen lassen.
• Bearbeiten Sie die Umleitung und bestätigen Sie, dass in den Feldern Redirect From (Umleitung von) und Redirect To (Umleitung zu) die korrekten Werte eingegeben wurden.

Bei Umleitungen bestehen die folgenden technischen Einschränkungen:

• Jede Umgebung kann maximal 10.000 Umleitungen enthalten.
• Jede Umgebung hat ihren eigenen Satz an Umleitungen. Sie sind dafür verantwortlich, die Umleitungen der verschiedenen Umgebungen durch Klonen zu synchronisieren.
• Die Umleitungsfunktion unterstützt einfache Umleitungen von einem Pfad zu einem anderen. Verwenden Sie für komplexe Umleitungen mit Bedingungen den Umleitungs-Support von Express.js in ssr.js.
• Mit dem Runtime Admin Tool oder der Managed Runtime API erstellte Umleitungen werden nicht in einer lokalen Entwicklungsumgebung ausgeführt.
• Umleitungen werden nicht durch Seitenübergänge in der PWA Kit-Anwendung ausgelöst; dies geschieht ausschließlich per HTTP-Anfrage.

Hier erfahren Sie, wie Sie Ihre Benutzer verwalten können.

So fügen Sie einem Projekt einen Benutzer hinzu:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsbereich auf Users & Permissions (Benutzer und Zugriffsrechte).
3. Klicken Sie auf New User (Neuer Benutzer).
4. Geben Sie die E-Mail-Adresse des Benutzers ein. (Achten Sie darauf, dass der Benutzer Teil Ihrer Organisation ist und ihm im Account Manager eine der folgenden Rollen zugewiesen ist: Managed Runtime User oder Managed Runtime Admin.)
5. Wählen Sie eine Rolle aus.
6. Klicken Sie auf Add User (Benutzer hinzufügen).

So ändern Sie die Rolle eines Benutzers:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsbereich auf Users & Permissions (Benutzer und Zugriffsrechte).
3. Klicken Sie auf die Schaltfläche ... neben dem Namen des Benutzers.
4. Klicken Sie auf Edit (Bearbeiten).
5. Wählen Sie eine Rolle aus.
6. Klicken Sie auf das daraufhin angezeigte Pop-up-Menü.
7. Wählen Sie eine neue Rolle aus.
8. Klicken Sie auf Save (Speichern).

Eine Liste der Benutzerfähigkeiten, die den einzelnen Rollen zugeordnet sind, finden Sie in der Übersicht über Managed Runtime.

So entfernen Sie einen Benutzer aus einem Projekt:

1. Rufen Sie die Übersichtsseite eines Projekts auf.
2. Klicken Sie im linken Navigationsbereich auf Users & Permissions (Benutzer und Zugriffsrechte).
3. Klicken Sie auf die Schaltfläche ... neben dem Namen des Benutzers.
4. Klicken Sie auf Remove (Entfernen).
5. Klicken Sie auf Yes, Remove User (Ja, Benutzer entfernen).