DocumentaciónCommerceGuía de Commerce en la infraestructura en la nube

CLI de nube

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

Creado para:

  • Administrador
  • Desarrollador

La herramienta CLI magento-cloud permite a los desarrolladores y administradores de sistemas administrar proyectos y entornos en la nube, realizar rutinas y ejecutar tareas de automatización de manera local. La CLI magento-cloud amplía las características y la funcionalidad de Cloud Console. Después de instalar la CLI de magento-cloud en la estación de trabajo local, puede utilizarla para administrar los entornos de integración de Adobe Commerce en la nube Starter y Pro.

NOTE
Se trata de una herramienta local y no se puede instalar en el entorno de la nube (que es de solo lectura) mediante este método. Solo puede instalar módulos en el entorno de la nube a través de flujo de trabajo de implementación

Para instalar la CLI de magento-cloud:

  1. En su estación de trabajo local, cambie al directorio donde quiere clonar el proyecto de Cloud y donde el propietario del sistema de archivos tiene acceso de escritura.

  2. Instale la CLI magento-cloud.

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

  3. Agregar CLI magento-cloud al perfil bash.

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

  4. Vuelva a cargar el perfil de bash actualizado.

    code language-bash 
    . ~/.bash_profile

  5. Para iniciar la CLI, llame a magento-cloud e indique las credenciales de su cuenta de Cloud cuando se le solicite.

    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. Compruebe que el comando magento-cloud se encuentra en la ruta de acceso. En el ejemplo siguiente se enumeran los comandos disponibles.

    code language-bash 
    magento-cloud list

Comandos comunes

El Adobe diseñó estos comandos para administrar los entornos de integración en la nube y recomienda que ejecute la CLI magento-cloud desde un directorio de proyecto para poder omitir el parámetro -p <project-ID>.

La siguiente lista de magento-cloud comandos CLI usados con frecuencia incluye solamente las opciones requeridas. Puede utilizar la opción --help con cualquier comando para ver más información.

Comando
Descripción
magento-cloud login
Inicie sesión en el proyecto.
magento-cloud list
Enumerar los comandos disponibles para la herramienta CLI.
magento-cloud environment:list
Enumerar los entornos del proyecto actual.
magento-cloud environment:checkout
Consulte un entorno existente.
magento-cloud environment:merge -e
Combinar cambios en este entorno con su elemento principal.
magento-cloud variables
Variables de lista en este entorno.
magento-cloud ssh
Utilice SSH para conectarse al entorno remoto.
magento-cloud url
Abra la tienda de Adobe Commerce en un explorador.
magento-cloud web
Abra Cloud Console.

Comandos de entorno

El entorno name es diferente del entorno ID solo si el nombre del entorno contiene espacios o mayúsculas. Un ID de entorno consta de todas las letras minúsculas, números y símbolos permitidos. Las letras mayúsculas en un nombre de entorno se convierten a minúsculas en el ID.; los espacios en un nombre de entorno se convierten en guiones.

Un nombre de entorno no puede incluir caracteres reservados para su shell de Linux o para expresiones regulares. Los caracteres prohibidos incluyen llaves ({ }), paréntesis, asteriscos (*), corchetes angulares (< >), signo & (&), porcentaje (%) y otros caracteres.

El comando magento-cloud environment:list muestra jerarquías de entorno, mientras que git branch no lo hace. Si tiene entornos anidados, utilice lo siguiente:

magento-cloud environment:list

Volver a implementar el entorno

Déclencheur una reimplementación sin utilizar una notificación push. Compruebe y confirme el entorno que desea volver a implementar. No utilice volver a implementar si hay una compilación en estado pendiente.

magento-cloud environment:redeploy

Respuesta de ejemplo:

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
El proceso de implementación comienza cuando se realiza una combinación, inserción o sincronización del entorno, o cuando se déclencheur una reimplementación manual, durante la cual la aplicación Commerce se encuentra en modo de mantenimiento. Para un entorno de producción, Adobe recomienda completar este trabajo durante las horas de menor actividad para evitar interrupciones en el servicio.

Comandos Git

Puede observar que algunos de estos comandos son similares a los comandos Git. Los comandos de magento-cloud se conectan directamente al proyecto de nube basado en Git con características adicionales. Si crea una rama sin usar la CLI magento-cloud, no se "activa" y no se genera automáticamente al insertar cambios en el entorno remoto. El comando CLI magento-cloud incluye la activación.

Para crear una rama, use el comando magento-cloud para que se active la rama.

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

Para el estado de sucursal:

  • Utilice el comando magento-cloud env para ver una lista de las ramas del entorno y su estado: activo o inactivo.
  • Utilice el comando magento-cloud environment:activate para activar una rama de entorno.

Inserte un compromiso Git vacío para almacenar en déclencheur una implementación. Por ejemplo:

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

Algunas acciones, como agregar un usuario, no resultan en una implementación.

Crear una rama de entorno

Los siguientes pasos muestran el uso de los comandos CLI y Git de forma intercambiable para administrar el entorno local:

  1. En la estación de trabajo local, cambie al directorio del proyecto.

  2. Cambiar al propietario del sistema de archivos.

  3. Inicie sesión en el proyecto.

    code language-bash 
    magento-cloud login

  4. Enumere sus proyectos.

    code language-bash 
    magento-cloud project:list

  5. Enumerar entornos en el proyecto. Cada entorno incluye una rama de Git activa que contiene el código, la base de datos, las variables de entorno, las configuraciones y los servicios.

    code language-bash 
    magento-cloud environment:list
    note note
    NOTE
    Es importante usar el comando magento-cloud environment:list porque muestra jerarquías de entorno, mientras que el comando git branch no lo hace.

  6. Recupere las ramas de origen para obtener el código más reciente.

    code language-bash 
    git fetch origin

  7. Cierre la compra o cambie a una rama y un entorno específicos.

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

    Los comandos Git solo comprueban la rama Git. El comando magento-cloud checkout extrae la rama y cambia al entorno activo.

    note tip
    TIP
    Puede crear una rama de entorno utilizando la sintaxis de comando magento-cloud environment:branch <environment-name> <parent-environment-ID>. Puede llevar algún tiempo adicional crear y activar una rama de entorno.

  8. Utilice el ID de entorno para extraer cualquier código actualizado de su local de. Esto no es necesario si la rama de entorno es nueva.

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

  9. (Opcional) Cree una instantánea del entorno como copia de seguridad.

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

Actualizar la CLI

La CLI magento-cloud comprueba las actualizaciones disponibles cuando inicia sesión, pero puede buscar actualizaciones mediante el comando self:update. Si hay una actualización disponible, siga las instrucciones para actualizar la CLI.

Si la CLI de magento-cloud está actualizada, verá la siguiente respuesta:

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