Pushen und Bereitstellung von Bündeln

Um Ihre Commerce App auf Managed Runtime auszuführen, müssen Sie zuerst ein Codebündel pushen und in einer Zielumgebung bereitstellen.

In dieser Anleitung erfahren Sie, wie das geht:

  • Richten Sie Ihren API-Schlüssel ein.
  • Verwenden Sie ein Befehlszeilen-Skript, um ein Bündel in Managed Runtime zu pushen.
  • Stellen Sie mit der Webanwendung Runtime Admin ein Bündel in der Production-Umgebung bereit.

Vor der Anwendung müssen Sie Managed Runtime für Ihre Organisation aktivieren. Wenn Managed Runtime noch nicht aktiviert wurde, wenden Sie sich an Ihr Salesforce Kundenbetreuerteam. Bevor Sie Codebündel in Managed Runtime pushen und bereitstellen können, müssen Sie Zugriff auf die Webanwendung Runtime Admin anfordern. Bitten Sie Ihren Commerce Cloud-Administrator, Ihrem Konto mithilfe des Account Managers eine der folgenden Rollen hinzuzufügen: Managed Runtime User oder Managed Runtime Admin.

Wenn sich in Ihrem Startverzeichnis bereits eine .mobify-Datei befindet, können Sie diesen Abschnitt überspringen.

Vor dem Pushen eines Bündels müssen Sie Ihren Computer autorisieren.

Suchen Sie dafür als Erstes nach Ihrem persönlichen API-Schlüssel:

  1. Melden Sie sich in Runtime Admin an.
  2. Klicken Sie auf das Symbol für das Benutzerprofil (oben rechts) und dann auf Account Settings (Kontoeinstellungen).
  3. Scrollen Sie nach unten zum Abschnitt API Key (API-Schlüssel) und suchen Sie Personal API Key (Persönlicher API-Schlüssel).
    • Wenn Sie noch keinen API-Schlüssel erstellt haben, klicken Sie auf den Link Generate (Generieren).
    • Wenn Sie bereits über einen API-Schlüssel verfügen, klicken Sie auf den Link Reset (Zurücksetzen). Klicken Sie nach der Bestätigungsaufforderung auf Reset my API Key (Meinen API-Schlüssel zurücksetzen).
  4. Kopieren Sie den Befehl, um Ihren API-Schlüssel zu verwenden.

Aus Sicherheitsgründen wird der API-Schlüssel bei Ihrem nächsten Besuch der Kontoeinstellungsseite nicht vollständig angezeigt. Um erneut auf den kompletten API-Schlüssel zuzugreifen, müssen Sie ihn wieder zurücksetzen.

Rufen Sie von der Befehlszeile aus Ihr PWA Kit-Projektverzeichnis auf und führen Sie den kopierten Befehl aus.

Führen Sie den Befehl ebenfalls auf allen anderen Computern aus, die Sie für das Pushen von Bündeln verwenden möchten.

Das Pushen eines Bündels erfordert die Ausführung eines Skripts, das Ihren Code in ein Webpack-Bündel verpackt und in den Runtime Manager hochlädt.

Verifizierung der Produktkonfiguration

Verifizieren Sie vor dem Pushen Ihres ersten Bündels, dass die Datei package.json in Ihrem PWA Kit-Projektverzeichnis ordnungsgemäß konfiguriert ist:

  1. Melden Sie sich in Runtime Admin an.
  2. Klicken Sie auf den Namen Ihres Projekts.
  3. Klicken Sie im linken Navigationsbereich auf Project Settings (Projekteinstellungen).
  4. Kopieren Sie die Project ID (Projekt-ID). Beispiel: my-project.
  5. Fügen Sie sie in das Feld name in der Datei package.json. ein.

Konfigurieren von Proxys für die Umgebung

Um sicherzustellen, dass Ihr Bündel bei der Bereitstellung ordnungsgemäß funktioniert, müssen Sie Ihre Proxys in Ihrer Umgebung in Runtime Admin einstellen.

Ausführen des Push-Skripts

Um ein Bündel zu pushen, nutzen Sie die Befehlszeile und führen Sie von Ihrem Projektverzeichnis aus den folgenden Befehl aus:

Führen Sie npm run push -- --help aus, um eine Liste mit weiteren Optionen anzuzeigen, die Sie dem Push-Skript hinzufügen können.

Nach dem erfolgreichen Pushen eines Bündels wird im Terminal die Meldung Beginning upload… gefolgt von der Meldung Bundle Uploaded! angezeigt.

Sollten bei dem Vorgang Probleme aufgetreten sein, kann nach der Meldung Beginning upload… je nach dem HTTP-Antwortstatuscodes eine von drei Fehlermeldungen angezeigt werden.

So führen Sie nach jeder dieser Fehlermeldungen die Fehlerbehebung durch:

HTTP 404-Fehler

Ein HTTP 404-Fehler wird im Terminal zurückgegeben, wenn ein Projekt mit dem in package.json angegebenen Namen nicht existiert oder Sie zum Ändern des Projekts nicht befugt sind.

So beheben Sie diesen Fehler:

  1. Wiederholen Sie die Schritte zum Pushen eines Bündels und achten Sie darauf, dass die Einstellungen für die E-Mail-Adresse und den API-Schlüssel, die Sie an das Push-Skript übergeben, den Einstellungen in Runtime Admin entsprechen.
  2. Verifizieren Sie, dass Ihr Projekt auf der Startseite von Runtime Admin unter Projects (Projekte) aufgeführt ist.
    • Sollte Ihr Projekt dort nicht aufgeführt sein, wenden Sie sich an den Support, um sicherzustellen, dass das Projekt erstellt wurde und dass Sie die Zugriffsberechtigung als Teammitglied erhalten haben.
  3. Öffnen Sie das Projekt in Runtime Admin.
  4. Klicken Sie im linken Navigationsbereich auf Project Settings (Projekteinstellungen).
  5. Kopieren Sie die Project ID (Projekt-ID). Beispiel: my-project.
  6. Öffnen Sie die Datei package.json in Ihrem Projektverzeichnis.
  7. Verifizieren Sie, dass die Werte für name und projectSlug der von Ihnen kopierten Projekt-ID entsprechen.

HTTP 401-Fehler

Ein HTTP 401-Fehler wird im Terminal zurückgegeben, wenn Sie keine Berechtigung zum Pushen von Bündeln besitzen. Um diesen Fehler zu beheben, bitten Sie Ihren Administrator von Commerce Cloud Account Manager, Ihnen die für das Pushen von Bündeln benötigte Berechtigung zu gewähren.

HTTP 413-Fehler

Ein HTTP 413-Fehler wird im Terminal zurückgegeben, wenn Ihr Bündel zu groß ist. Die maximale Größe für Bündel beträgt 150 MB. Um diesen Fehler zu beheben, überprüfen Sie die Größe Ihres Bündels anhand des Build-Ordners in Ihrem Projekt. Sollte die Größe Ihres Projekts sich der maximalen Größe annähern oder diese bereits überschritten haben, können Sie die Größe wie folgt reduzieren:

  • Entfernen Sie nicht verwendete Assets.
  • Entfernen Sie unnötige Assets.
  • Reduzieren Sie die Größe der Bilder.

Versuchen Sie nach der Reduzierung Ihrer Projektdatei erneut, das Bündel zu pushen.

Nach dem erfolgreichen Pushen eines Bündels können Sie es in einer Zielumgebung bereitstellen.

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. Standardmäßig verfügt jedes Projekt über eine einzige Umgebung namens production. Mit Runtime Admin oder der Managed Runtime API können Sie weitere Umgebungen erstellen.

So stellen Sie ein Bündel bereit:

  1. Melden Sie sich in Runtime Admin an.
  2. Klicken Sie auf den Namen Ihres Projekts.
  3. Klicken Sie unter Environments (Umgebungen) auf den Namen der bereitzustellenden Umgebung (Beispiel: Production).
  4. Klicken Sie unter Bundles (Bündel) neben dem Bündel auf die Schaltfläche Deploy (Bereitstellen).
  5. Klicken Sie auf Confirm Deploy (Bereitstellung bestätigen).
  6. 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. Weitere Bereitstellungen dauern nur etwa eine Minute, außer es sind Änderungen am CDN erforderlich. Eine CDN-Änderung nimmt etwa 15 Minuten in Anspruch. Sie ist erforderlich, wenn die Bereitstellung Änderungen bei Request Processor oder Proxy-Konfiguration enthält.