Cloud CLI

L’interfaccia CLI di magento-cloud è uno strumento da riga di comando che consente agli sviluppatori e agli amministratori di sistema di gestire i progetti e gli ambienti Adobe Commerce su infrastrutture cloud dalla workstation locale.

Questo strumento estende le funzionalità di Cloud Console fornendo funzionalità di automazione aggiuntive e accesso diretto alle funzionalità di gestione dei progetti. Dopo aver installato lo strumento localmente, è possibile utilizzarlo per gestire gli ambienti di integrazione Starter e Pro.

NOTE
Questo strumento locale è supportato solo nei sistemi operativi basati su Unix. Windows non è supportato. Non può essere installato nell’ambiente Cloud (di sola lettura) utilizzando il metodo descritto in questa pagina. Puoi installare i moduli nell'ambiente Cloud solo tramite uno dei seguenti flussi di lavoro di distribuzione.

Per installare magento-cloud CLI:

  1. Nella workstation locale, passa alla directory in cui intendi clonare il progetto Cloud e in cui il proprietario del file system dispone dell’accesso scrittura.

  2. Installare l’interfaccia della riga di comando magento-cloud.

    code language-bash
    curl -sS https://accounts.magento.cloud/cli/installer | php
    
  3. Aggiungere l’interfaccia della riga di comando magento-cloud al profilo Bash.

    code language-bash
    export PATH=$PATH:$HOME/.magento-cloud/bin
    
  4. Ricarica il profilo di base aggiornato.

    code language-bash
    . ~/.bash_profile
    
  5. Per avviare CLI, chiamare magento-cloud e immettere le credenziali dell’account Cloud quando richiesto.

    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. Verificare che il comando magento-cloud sia presente nel percorso. Nell’esempio seguente vengono elencati i comandi disponibili.

    code language-bash
    magento-cloud list
    

Comandi comuni

Adobe ha progettato questi comandi per gestire gli ambienti di integrazione Cloud e consiglia di eseguire l’interfaccia CLI magento-cloud da una directory di progetto in modo da poter omettere il parametro -p <project-ID>.

Il seguente elenco di comandi CLI magento-cloud comunemente utilizzati include solo le opzioni richieste. È possibile utilizzare l’opzione --help con qualsiasi comando per visualizzare ulteriori informazioni.

Comando
Descrizione
magento-cloud login
Accedi al progetto.
magento-cloud list
Elencare i comandi disponibili per lo strumento CLI.
magento-cloud environment:list
Elencare gli ambienti nel progetto corrente.
magento-cloud environment:checkout
Estrai un ambiente esistente.
magento-cloud environment:merge -e
Unisci le modifiche in questo ambiente con il relativo elemento padre.
magento-cloud variables
Variabili elenco in questo ambiente.
magento-cloud ssh
Utilizzare SSH per connettersi all’ambiente remoto.
magento-cloud url
Apri la vetrina Adobe Commerce in un browser.
magento-cloud web
Apri Cloud Console.

Comandi di ambiente

L’ambiente name è diverso dall’ambiente ID solo se si utilizzano spazi o lettere maiuscole nel nome dell’ambiente. Un ID ambiente è costituito da tutte le lettere minuscole, i numeri e i simboli consentiti. Le lettere maiuscole nel nome di un ambiente vengono convertite in minuscole nell’ID; gli spazi nel nome di un ambiente vengono convertiti in trattini.

Il nome di ambiente non può includere caratteri riservati per la shell Linux o per le espressioni regolari. I caratteri non consentiti includono parentesi graffe ({ }), parentesi, asterisco (*), parentesi angolari (< >), e commerciale (&), percentuale (%) e altri caratteri.

Il comando magento-cloud environment:list visualizza le gerarchie dell’ambiente, mentre git branch no. Se disponi di ambienti nidificati, utilizza quanto segue:

magento-cloud environment:list

Ridistribuire l’ambiente

Attiva una ridistribuzione senza utilizzare un push. Verifica e conferma l’ambiente da ridistribuire.

CAUTION
Non utilizzare la ridistribuzione se è presente una build in uno stato in sospeso.
magento-cloud environment:redeploy

Risposta di esempio:

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
Il processo di distribuzione inizia quando si esegue un'unione, un push o una sincronizzazione dell'ambiente oppure quando si attiva una ridistribuzione manuale, durante la quale l'applicazione Commerce è in modalità manutenzione. Per un ambiente di produzione, Adobe consiglia di completare questo lavoro nelle ore non di punta per evitare interruzioni del servizio.

Comandi Git

Alcuni di questi comandi sono simili ai comandi Git. I comandi magento-cloud si connettono direttamente al progetto Cloud basato su Git con funzionalità aggiuntive. Se si crea un ramo senza utilizzare l’interfaccia CLI di magento-cloud, questo non viene “attivato” e non viene generato automaticamente quando si inviano le modifiche all’ambiente remoto. Il comando CLI magento-cloud include l’attivazione.

Per creare un ramo, utilizzare il comando magento-cloud in modo che il ramo venga attivato.

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

Per lo stato della filiale:

  • Utilizza il comando magento-cloud env per visualizzare un elenco dei rami dell’ambiente e il loro stato: attivo o inattivo.
  • Utilizzare il comando magento-cloud environment:activate per attivare un ramo dell’ambiente.

Effettua il push di un commit Git vuoto per attivare una distribuzione. Ad esempio:

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

Alcune azioni, come l’aggiunta di un utente, non comportano la distribuzione.

Creare un ramo dell’ambiente

I passaggi seguenti illustrano l’utilizzo dei comandi CLI e Git in modo intercambiabile per gestire l’ambiente locale:

  1. Sulla workstation locale, passa alla directory del progetto.

  2. Passa al proprietario del file system.

  3. Accedi al progetto.

    code language-bash
    magento-cloud login
    
  4. Elencare i progetti.

    code language-bash
    magento-cloud project:list
    
  5. Elencare gli ambienti nel progetto. Ogni ambiente include un ramo Git attivo che contiene il codice, il database, le variabili di ambiente, le configurazioni e i servizi.

    code language-bash
    magento-cloud environment:list
    
    note
    NOTE
    È importante utilizzare il comando magento-cloud environment:list perché visualizza gerarchie di ambiente, mentre il comando git branch no.
  6. Recupera i rami di origine per ottenere il codice più recente.

    code language-bash
    git fetch origin
    
  7. Estrai o passa a un ramo e a un ambiente specifici.

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

    I comandi Git estraggono solo il ramo Git. Il comando magento-cloud checkout estrae il ramo e passa all’ambiente attivo.

    note tip
    TIP
    È possibile creare un ramo dell'ambiente utilizzando la sintassi del comando magento-cloud environment:branch <environment-name> <parent-environment-ID>. La creazione e l’attivazione di un ramo dell’ambiente potrebbe richiedere un po’ di tempo.
  8. Utilizza l’ID dell’ambiente per richiamare nell’ambiente locale il codice aggiornato. Questo passaggio non è necessario se il ramo dell’ambiente è nuovo.

    code language-bash
    git pull origin <environment-ID>
    
  9. (Facoltativo) Crea uno snapshot dell’ambiente come backup.

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

Aggiornare CLI

L’interfaccia della riga di comando magento-cloud verifica la disponibilità di aggiornamenti al momento dell’accesso, ma è possibile verificare la disponibilità di aggiornamenti utilizzando il comando self:update. Se è disponibile un aggiornamento, seguire le istruzioni per aggiornare CLI.

Se la CLI di magento-cloud è aggiornata, viene visualizzata la seguente risposta:

magento-cloud update
Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found
recommendation-more-help
commerce-on-cloud-help-cloud-guide