Cloud-CLI

Mit dem CLI-Tool magento-cloud können Entwickler und Systemadministratoren Cloud-Projekte und -Umgebungen verwalten, Routinen durchführen und Automatisierungsaufgaben ausführen. Die CLI magento-cloud erweitert die Funktionen und Funktionen von Cloud Console. Nachdem Sie die magento-cloud-CLI auf Ihrer lokalen Workstation installiert haben, können Sie damit Ihre Adobe Commerce in den Integrationsumgebungen "Cloud Infrastructure Starter"und "Pro"verwalten.

Installieren der magento-cloud CLI:

  1. Wechseln Sie auf Ihrer lokalen Workstation zum Ordner, in dem Sie das Cloud-Projekt klonen möchten und in dem der Dateisysteminhaber über den Zugriff auf write verfügt.

  2. Installieren Sie die CLI magento-cloud .

    code language-bash
    curl -sS https://accounts.magento.cloud/cli/installer | php
    
  3. Fügen Sie magento-cloud CLI zum Bash-Profil hinzu.

    code language-bash
    export PATH=$PATH:$HOME/.magento-cloud/bin
    
  4. Laden Sie das aktualisierte Bash-Profil erneut.

    code language-bash
    . ~/.bash_profile
    
  5. Um die CLI zu starten, rufen Sie magento-cloud auf und geben Sie bei Aufforderung Ihre Anmeldedaten für das Cloud-Konto ein.

    code language-bash
    magento-cloud
    
    code language-terminal
    Welcome to Magento Cloud!
    Please log in using your Magento Cloud account.
    Your email address or username:
    
  6. Stellen Sie sicher, dass sich der Befehl magento-cloud in Ihrem Pfad befindet. Im folgenden Beispiel werden die verfügbaren Befehle aufgelistet.

    code language-bash
    magento-cloud list
    

Allgemeine Befehle

Adobe hat diese Befehle zum Verwalten von Cloud-Integrationsumgebungen entwickelt und empfiehlt, die magento-cloud-CLI aus einem Projektverzeichnis auszuführen, damit Sie den Parameter -p <project-ID> weglassen können.

Die folgende Liste häufig verwendeter magento-cloud CLI-Befehle enthält nur erforderliche Optionen. Sie können die Option --help mit jedem Befehl verwenden, um weitere Informationen anzuzeigen.

Befehl
Beschreibung
magento-cloud login
Melden Sie sich beim Projekt an.
magento-cloud list
Geben Sie die verfügbaren Befehle für das CLI-Tool an.
magento-cloud environment:list
Geben Sie die Umgebungen im aktuellen Projekt an.
magento-cloud environment:checkout
Sehen Sie sich eine vorhandene Umgebung an.
magento-cloud environment:merge -e
Zusammenführen von Änderungen in dieser Umgebung mit der übergeordneten Umgebung.
magento-cloud variables
Listenvariablen in dieser Umgebung.
magento-cloud ssh
Verwenden Sie SSH, um eine Verbindung zur Remote-Umgebung herzustellen.
magento-cloud url
Öffnen Sie die Adobe Commerce-Storefront in einem Browser.
magento-cloud web
Öffnen Sie die Cloud Console.

Umgebungsbefehle

Die Umgebung name unterscheidet sich nur dann von der Umgebung ID, wenn Sie Leerzeichen oder Großbuchstaben im Umgebungsnamen verwenden. Eine Umgebungs-ID besteht aus allen Kleinbuchstaben, Zahlen und zulässigen Symbolen. Großbuchstaben in einem Umgebungsnamen werden in der ID in Kleinbuchstaben umgewandelt; Leerzeichen in einem Umgebungsnamen werden in Bindestriche umgewandelt.

Der Umgebungsname kann keine Zeichen enthalten, die für Ihre Linux-Shell oder reguläre Ausdrücke reserviert sind. Unzulässige Zeichen sind geschweifte Klammern ({ }), Klammern, Sternchen (*), spitze Klammern (< >), Und-Zeichen (&), Prozentzeichen (%) und andere Zeichen.

Der Befehl magento-cloud environment:list zeigt Umgebungshierarchien an, git branch dagegen nicht. Wenn Sie verschachtelte Umgebungen haben, verwenden Sie Folgendes:

magento-cloud environment:list

Bereitstellung der Umgebung

Trigger einer Neuimplementierung ohne Push-Benachrichtigung. Überprüfen und bestätigen Sie die Umgebung für die erneute Bereitstellung. Verwenden Sie keine Neubereitstellung, wenn ein Build in einem ausstehenden Status vorliegt.

magento-cloud environment:redeploy

Beispielantwort:

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
Der Bereitstellungsprozess beginnt, wenn Sie eine Zusammenführung, Push-Benachrichtigung oder Synchronisation Ihrer Umgebung durchführen oder wenn Sie eine manuelle Neuimplementierung Trigger haben, während der sich die Commerce -Anwendung im Wartungsmodus befindet. Für eine Produktionsumgebung empfiehlt Adobe, diese Arbeit außerhalb der Spitzenzeiten abzuschließen, um Dienstunterbrechungen zu vermeiden.

Git-Befehle

Sie werden feststellen, dass einige dieser Befehle Git-Befehlen ähneln. Die Befehle magento-cloud stellen eine direkte Verbindung zum Git-basierten Cloud-Projekt mit zusätzlichen Funktionen her. Wenn Sie eine Verzweigung ohne Verwendung der CLI magento-cloud erstellen, wird diese nicht "aktiviert"und beim Pushen von Änderungen an die Remote-Umgebung nicht automatisch erstellt. Der CLI-Befehl magento-cloud beinhaltet die Aktivierung.

Verwenden Sie zum Erstellen einer Verzweigung den Befehl magento-cloud , damit die Verzweigung aktiviert wird.

magento-cloud environment:branch <new-name> <parent-branch>

Für den Zweigstatus:

  • Verwenden Sie den Befehl magento-cloud env , um eine Liste der Verzweigungen der Umgebung und deren Status anzuzeigen: aktiv oder inaktiv.
  • Verwenden Sie den Befehl magento-cloud environment:activate , um einen Umgebungszweig zu aktivieren.

Senden Sie eine leere Git-Bestätigung an den Trigger einer Bereitstellung. Beispiel:

git commit --allow-empty -m "redeploy" && git push <branch-name>

Einige Aktionen, wie das Hinzufügen eines Benutzers, führen nicht zur Bereitstellung.

Umgebungsverzweigung erstellen

Die folgenden Schritte zeigen die Verwendung der Befehle CLI und Git zur austauschbaren Verwaltung Ihrer lokalen Umgebung:

  1. Wechseln Sie auf Ihrer lokalen Workstation zum Projektverzeichnis.

  2. Wechseln Sie zum Besitzer des Dateisystems.

  3. Melden Sie sich bei Ihrem Projekt an.

    code language-bash
    magento-cloud login
    
  4. Geben Sie Ihre Projekte an.

    code language-bash
    magento-cloud project:list
    
  5. Auflisten von Umgebungen im Projekt. Jede Umgebung enthält eine aktive Git-Verzweigung, die Ihren Code, Ihre Datenbank, Umgebungsvariablen, Konfigurationen und Dienste enthält.

    code language-bash
    magento-cloud environment:list
    
    note note
    NOTE
    Es ist wichtig, den Befehl magento-cloud environment:list zu verwenden, da er Umgebungshierarchien anzeigt, während der Befehl git branch dies nicht tut.
  6. Rufen Sie die Ausgangsverzweigungen ab, um den neuesten Code zu erhalten.

    code language-bash
    git fetch origin
    
  7. Checken Sie einen bestimmten Zweig und eine bestimmte Umgebung aus oder wechseln Sie zu dieser.

    code language-bash
    magento-cloud environment:checkout <environment-ID>
    

    Git-Befehle checken nur die Git-Verzweigung aus. Der Befehl magento-cloud checkout checkt den Zweig aus und wechselt zur aktiven Umgebung.

    note tip
    TIP
    Sie können eine Umgebungsverzweigung mithilfe der Befehlssyntax magento-cloud environment:branch <environment-name> <parent-environment-ID> erstellen. Es kann einige zusätzliche Zeit in Anspruch nehmen, einen Umgebungs-Zweig zu erstellen und zu aktivieren.
  8. Verwenden Sie die Umgebungs-ID, um jeden aktualisierten Code zu Ihrem lokalen Speicherort abzurufen. Dies ist nicht erforderlich, wenn der Umgebungszweig neu ist.

    code language-bash
    git pull origin <environment-ID>
    
  9. (Optional) Erstellen Sie einen Schnappschuss der Umgebung als Sicherung.

    code language-bash
    magento-cloud snapshot:create -e <environment-ID>
    

CLI aktualisieren

Die Befehlszeilenschnittstelle "magento-cloud"sucht nach verfügbaren Updates, wenn Sie sich anmelden. Sie können jedoch mithilfe des Befehls self:update nach Aktualisierungen suchen. Wenn ein Update verfügbar ist, befolgen Sie die Anweisungen zum Aktualisieren der CLI.

Wenn Ihre magento-cloud -CLI aktuell ist, sehen Sie die folgende Antwort:

magento-cloud update
Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26