DocumentationCommerceGuide de Commerce sur les infrastructures cloud

Interface de ligne de commande du cloud

Last update: Thu Sep 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Administration
  • Développeur

L’outil d’interface de ligne de commande magento-cloud permet aux développeurs et aux administrateurs système de gérer des projets et des environnements cloud, d’exécuter des routines et d’exécuter des tâches d’automatisation localement. L’interface de ligne de commande magento-cloud étend les fonctionnalités de Cloud Console. Une fois que vous avez installé l’interface de ligne de commande magento-cloud sur votre poste de travail local, vous pouvez l’utiliser pour gérer votre Adobe Commerce dans les environnements d’intégration Starter et Pro de l’infrastructure cloud.

NOTE
Il s’agit d’un outil local qui ne peut pas être installé dans l’environnement cloud (en lecture seule) à l’aide de cette méthode. Vous ne pouvez installer que les modules sur l’environnement Cloud via le workflow de déploiement

Pour installer l’ magento-cloud CLI :

  1. Sur votre poste de travail local, remplacez le répertoire dans lequel vous avez l’intention de cloner le projet Cloud et où le propriétaire du système de fichiers a accès à écriture.

  2. Installez l’interface de ligne de commande magento-cloud.

    code language-bash 
    curl -sS https://accounts.magento.cloud/cli/installer | php

  3. Ajoutez l’interface de ligne de commande magento-cloud au profil bash.

    code language-bash 
    export PATH=$PATH:$HOME/.magento-cloud/bin

  4. Rechargez le profil bash mis à jour.

    code language-bash 
    . ~/.bash_profile

  5. Pour lancer l’interface de ligne de commande, appelez magento-cloud et saisissez les informations d’identification de votre compte Cloud lorsque vous y êtes invité.

    code language-bash 
    magento-cloud
    code language-none 
    Welcome to Magento Cloud!
Please log in using your Magento Cloud account.
Your email address or username:

  6. Vérifiez que la commande magento-cloud se trouve dans votre chemin d’accès. L’exemple suivant répertorie les commandes disponibles.

    code language-bash 
    magento-cloud list

Commandes courantes

Adobe a conçu ces commandes pour gérer les environnements d’intégration Cloud et vous recommande d’exécuter l’interface de ligne de commande magento-cloud à partir d’un répertoire de projet afin que vous puissiez omettre le paramètre -p <project-ID>.

La liste suivante des commandes de l’interface de ligne de commande magento-cloud couramment utilisées comprend uniquement les options requises. Vous pouvez utiliser l’option --help avec n’importe quelle commande pour afficher plus d’informations.

Commande
Description
magento-cloud login
Connectez-vous au projet.
magento-cloud list
Liste des commandes disponibles pour l’outil d’interface de ligne de commande.
magento-cloud environment:list
Liste des environnements du projet en cours.
magento-cloud environment:checkout
Extrayez un environnement existant.
magento-cloud environment:merge -e
Fusionner les modifications dans cet environnement avec son parent.
magento-cloud variables
Variables de liste dans cet environnement.
magento-cloud ssh
Utilisez SSH pour vous connecter à l’environnement distant.
magento-cloud url
Ouvrez le storefront Adobe Commerce dans un navigateur.
magento-cloud web
Ouvrez le Cloud Console.

Commandes d’environnement

L'environnement name diffère de l'environnement ID uniquement si vous utilisez des espaces ou des majuscules dans le nom de l'environnement. Un ID d’environnement se compose de toutes les lettres minuscules, de tous les nombres et de tous les symboles autorisés. Les majuscules d’un nom d’environnement sont converties en minuscules dans l’identifiant ; les espaces d’un nom d’environnement sont convertis en tirets.

Un nom d’environnement ne peut pas inclure des caractères réservés à votre shell Linux ou à des expressions régulières. Les caractères interdits sont les accolades ({ }), les parenthèses, l’astérisque (*), les chevrons (< >), l’esperluette (&), le pourcentage (%) et d’autres caractères.

La commande magento-cloud environment:list affiche des hiérarchies d’environnement, contrairement à git branch. Si vous disposez d’environnements imbriqués, utilisez les méthodes suivantes :

magento-cloud environment:list

Redéployer l’environnement

Déclenchez un redéploiement sans utiliser de notification push. Vérifiez et confirmez l’environnement à redéployer. N’utilisez pas le redéploiement en cas de version en attente.

magento-cloud environment:redeploy

Exemple de réponse :

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
Le processus de déploiement commence lorsque vous effectuez une fusion, une notification push ou une synchronisation de votre environnement, ou lorsque vous déclenchez un redéploiement manuel, pendant lequel l’application Commerce est en mode de maintenance. Pour un environnement de production, Adobe recommande d’effectuer ce travail aux heures creuses afin d’éviter les interruptions de service.

Commandes Git

Vous remarquerez peut-être que certaines de ces commandes sont similaires aux commandes Git. Les commandes magento-cloud se connectent directement au projet Cloud basé sur Git avec des fonctionnalités supplémentaires. Si vous créez une branche sans utiliser l’interface de ligne de commande magento-cloud, elle n’est pas "activée" et ne se crée pas automatiquement lorsque vous placez des modifications dans l’environnement distant. La commande d’interface de ligne de commande magento-cloud inclut l’activation.

Pour créer une branche, utilisez la commande magento-cloud afin que la branche soit activée.

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

Pour l’état de la branche :

  • Utilisez la commande magento-cloud env pour afficher la liste des branches de l'environnement et leur état : actif ou inactif.
  • Utilisez la commande magento-cloud environment:activate pour activer une branche d’environnement.

Envoyez une validation Git vide pour déclencher un déploiement. Par exemple :

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

Certaines actions, telles que l’ajout d’un utilisateur, n’entraînent pas de déploiement.

Création d’une branche d’environnement

Les étapes suivantes montrent comment gérer votre environnement local à l’aide des commandes d’interface de ligne de commande et Git :

  1. Sur votre poste de travail local, modifiez le répertoire de votre projet.

  2. Passez à l’ propriétaire du système de fichiers.

  3. Connectez-vous à votre projet.

    code language-bash 
    magento-cloud login

  4. Liste de vos projets.

    code language-bash 
    magento-cloud project:list

  5. Liste des environnements du projet. Chaque environnement comprend une branche Git active qui contient votre code, votre base de données, vos variables d’environnement, vos configurations et vos services.

    code language-bash 
    magento-cloud environment:list
    note note
    NOTE
    Il est important d’utiliser la commande magento-cloud environment:list, car elle affiche des hiérarchies d’environnement, contrairement à la commande git branch.

  6. Récupérez les branches d’origine pour obtenir le code le plus récent.

    code language-bash 
    git fetch origin

  7. Extrayez ou basculez vers une branche et un environnement spécifiques.

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

    Les commandes Git extraient uniquement la branche Git. La commande magento-cloud checkout extrait la branche et passe à l’environnement actif.

    note tip
    TIP
    Vous pouvez créer une branche d’environnement à l’aide de la syntaxe de commande magento-cloud environment:branch <environment-name> <parent-environment-ID>. La création et l’activation d’une branche d’environnement peuvent prendre du temps.

  8. Utilisez l’ID d’environnement pour extraire le code mis à jour dans votre environnement local. Cela n’est pas nécessaire si la branche d’environnement est nouvelle.

    code language-bash 
    git pull origin <environment-ID>

  9. (Facultatif) Créez un instantané de l’environnement en tant que sauvegarde.

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

Mise à jour de l’interface de ligne de commande

L’interface de ligne de commande magento-cloud recherche les mises à jour disponibles lorsque vous vous connectez, mais vous pouvez rechercher les mises à jour à l’aide de la commande self:update. Si une mise à jour est disponible, suivez les instructions pour mettre à jour l’interface de ligne de commande.

Si votre interface de ligne de commande magento-cloud est à jour, la réponse suivante s’affiche :

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