Cloud CLI

Il magento-cloud Lo strumento CLI consente agli sviluppatori e agli amministratori di sistema di gestire progetti e ambienti Cloud, eseguire routine ed eseguire attività di automazione. Il magento-cloud CLI estende le funzioni e le funzionalità del Cloud Console. Dopo aver installato magento-cloud CLI sulla workstation locale, è possibile utilizzarla per gestire gli ambienti di integrazione Adobe Commerce sull'infrastruttura cloud Starter e Pro.

Per installare magento-cloud CLI:

  1. Sulla workstation locale, passa alla directory in cui intendi clonare il progetto Cloud e dove proprietario del file system ha scrivere accesso.

  2. Installare magento-cloud CLI

    code language-bash
    curl -sS https://accounts.magento.cloud/cli/installer | php
    
  3. Aggiungi magento-cloud CLI 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 immetti le credenziali del tuo account Cloud quando richiesto.

    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. Verificare la magento-cloud 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 il magento-cloud CLI da una directory di progetto per poter omettere il -p <project-ID> parametro.

Il seguente elenco di magento-cloud I comandi CLI includono solo le opzioni richieste. È possibile utilizzare --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 nome è diverso dall’ambiente ID solo se nel nome dell’ambiente utilizzi spazi o lettere maiuscole. 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.

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

Il magento-cloud environment:list visualizza le gerarchie di ambiente, mentre git branch non lo fa. 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. 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 Commerce l'applicazione è in modalità di manutenzione. Per un ambiente di produzione, Adobe consiglia di completare questo lavoro nelle ore di minore utilizzo per evitare interruzioni del servizio.

Comandi Git

È possibile notare che alcuni di questi comandi sono simili ai comandi Git. Il magento-cloud I comandi si connettono direttamente al progetto Cloud basato su Git con funzioni aggiuntive. Se si crea un ramo senza utilizzare magento-cloud CLI, non è "attivato" e non viene generato automaticamente quando si inviano le modifiche all’ambiente remoto. Il magento-cloud Il comando CLI include l'attivazione.

Per creare un ramo, utilizza magento-cloud affinché il ramo venga attivato.

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

Per lo stato della filiale:

  • Utilizza il magento-cloud env per visualizzare un elenco dei rami dell’ambiente e il loro stato: attivo o inattivo.
  • Utilizza il magento-cloud environment:activate per attivare un ramo di 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 a 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
    NOTE
    È importante utilizzare il magento-cloud environment:list perché visualizza le gerarchie di ambiente, mentre il comando git branch il comando non.
  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 magento-cloud checkout Il comando estrae il ramo e passa all'ambiente attivo.

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

    code language-bash
    git pull origin <environment-ID>
    
  9. (Facoltativo a) Creare un istantanea dell’ambiente come backup.

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

Aggiornare CLI

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

Se il magento-cloud CLI è aggiornato e 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
05f2f56e-ac5d-4931-8cdb-764e60e16f26