CLI da nuvem
A ferramenta da CLI do magento-cloud
permite que desenvolvedores e administradores de sistema gerenciem projetos e ambientes na nuvem, executem rotinas e executem tarefas de automação. A CLI do magento-cloud
estende os recursos e a funcionalidade do Cloud Console. Depois de instalar a CLI do magento-cloud
na estação de trabalho local, você poderá usá-la para gerenciar os ambientes de integração do Adobe Commerce na infraestrutura em nuvem Starter e Pro.
Para instalar a magento-cloud
CLI:
-
Na estação de trabalho local, altere para o diretório onde você pretende clonar o projeto na Nuvem e onde o proprietário do sistema de arquivos tem acesso de gravação.
-
Instale a CLI do
magento-cloud
.code language-bash curl -sS https://accounts.magento.cloud/cli/installer | php
-
Adicione a CLI do
magento-cloud
ao perfil bash.code language-bash export PATH=$PATH:$HOME/.magento-cloud/bin
-
Recarregue o perfil bash atualizado.
code language-bash . ~/.bash_profile
-
Para iniciar a CLI, chame
magento-cloud
e insira suas credenciais de conta da Nuvem quando solicitado.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:
-
Verifique se o comando
magento-cloud
está no caminho. O exemplo a seguir lista os comandos disponíveis.code language-bash magento-cloud list
Comandos comuns
O Adobe projetou esses comandos para gerenciar ambientes de integração na nuvem e recomenda que você execute a CLI do magento-cloud
de um diretório de projeto para poder omitir o parâmetro -p <project-ID>
.
A lista de comandos da CLI magento-cloud
comumente usados inclui apenas as opções necessárias. Você pode usar a opção --help
com qualquer comando para ver mais informações.
magento-cloud login
magento-cloud list
magento-cloud environment:list
magento-cloud environment:checkout
magento-cloud environment:merge -e
magento-cloud variables
magento-cloud ssh
magento-cloud url
magento-cloud web
Comandos de ambiente
O ambiente name é diferente do ambiente ID somente se você usar espaços ou letras maiúsculas no nome do ambiente. Uma ID de ambiente consiste em todas as letras minúsculas, números e símbolos permitidos. Letras maiúsculas em um nome de ambiente são convertidas em minúsculas na ID; espaços em um nome de ambiente são convertidos em traços.
Um nome de ambiente não pode incluir caracteres reservados para o shell do Linux ou para expressões regulares. Os caracteres proibidos incluem chaves ({ }
), parênteses, asterisco (*
), colchetes (< >
), E comercial (&
), porcentagem (%
) e outros caracteres.
O comando magento-cloud environment:list
exibe hierarquias de ambiente, enquanto git branch
não exibe. Se você tiver ambientes aninhados, use o seguinte:
magento-cloud environment:list
Reimplantação do ambiente
Acione uma reimplantação sem usar um push. Verifique e confirme o ambiente para reimplantação. Não use a reimplantação se houver uma build em um estado pendente.
magento-cloud environment:redeploy
Exemplo de resposta:
Are you sure you want to redeploy the environment <environment-name>? [Y/n]
Comandos do Git
Você pode notar que alguns desses comandos são semelhantes aos comandos do Git. Os comandos magento-cloud
se conectam diretamente ao projeto da Nuvem baseada em Git com recursos adicionais. Se você criar uma ramificação sem usar a CLI do magento-cloud
, ela não será "ativada" e não será criada automaticamente quando você enviar as alterações para o ambiente remoto. O comando da CLI magento-cloud
inclui ativação.
Para criar uma ramificação, use o comando magento-cloud
para que a ramificação seja ativada.
magento-cloud environment:branch <new-name> <parent-branch>
Para status da filial:
- Use o comando
magento-cloud env
para exibir uma lista das ramificações de ambiente e seus status: ativo ou inativo. - Use o comando
magento-cloud environment:activate
para ativar uma ramificação de ambiente.
Envie uma confirmação do Git vazia para acionar uma implantação. Por exemplo:
git commit --allow-empty -m "redeploy" && git push <branch-name>
Algumas ações, como adicionar um usuário, não resultam na implantação.
Criar uma ramificação de ambiente
As etapas a seguir demonstram o uso dos comandos CLI e Git alternadamente para gerenciar o ambiente local:
-
Na estação de trabalho local, altere para o diretório do projeto.
-
Alternar para o proprietário do sistema de arquivos.
-
Faça logon no projeto.
code language-bash magento-cloud login
-
Liste seus projetos.
code language-bash magento-cloud project:list
-
Listar ambientes no projeto. Todos os ambientes incluem uma ramificação Git ativa que contém seu código, banco de dados, variáveis de ambiente, configurações e serviços.
code language-bash magento-cloud environment:list
note note NOTE É importante usar o comando magento-cloud environment:list
porque ele exibe hierarquias de ambiente, enquanto o comandogit branch
não. -
Busque ramificações de origem para obter o código mais recente.
code language-bash git fetch origin
-
Fazer check-out ou alternar para uma ramificação e um ambiente específicos.
code language-bash magento-cloud environment:checkout <environment-ID>
Os comandos do Git só verificam a ramificação Git. O comando
magento-cloud checkout
verifica a ramificação e alterna para o ambiente ativo.note tip TIP Você pode criar uma ramificação de ambiente usando a sintaxe de comando magento-cloud environment:branch <environment-name> <parent-environment-ID>
. Pode levar algum tempo adicional para criar e ativar uma ramificação de ambiente. -
Use a ID de ambiente para enviar qualquer código atualizado para o local. Isso não será necessário se a ramificação do ambiente for nova.
code language-bash git pull origin <environment-ID>
-
(Opcional) Crie um instantâneo do ambiente como backup.
code language-bash magento-cloud snapshot:create -e <environment-ID>
Atualizar a CLI
A CLI do magento-cloud
verifica as atualizações disponíveis quando você faz logon, mas é possível verificar atualizações usando o comando self:update
. Se houver uma atualização disponível, siga as instruções para atualizar a CLI.
Se sua CLI do magento-cloud
estiver atualizada, você verá a seguinte resposta:
magento-cloud update
Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found