Workspaces
Esta documentação possui as orientações sobre workspaces.
O que são?
São ambientes apartados ao ambiente de produção que "clonam" toda a estrutura da account master: catálogo, integrações logísticas, aplicativos instalados, etc. Ou seja, com a criação de workspaces é possível desenvolver vários temas ou funcionalidades da loja em diversos ambientes independentes um do outro e simultaneamente (exclusivamente para lojas em IO).
Além disso:
- Todo Workspace é criado, por padrão, com a mesma Edition da conta master (legado ou IO).
- O cliente consegue criar workspaces, mas a alteração da versão da Edition é possível apenas por usuários VTEX (Legado - CMS para IO - Store Edition ou vice-versa)
- Alterações nos Workspaces de desenvolvimento e produção não afetam a loja em produção.
- A criação de Workspaces é gratuita e ilimitada, porém existe apenas um Workspace Master, que é a interface acessada pelo usuário final.
- Existem 3 tipos de Workspaces: De desenvolvimento, de produção e o master.
Cada Workspace criado, terá seu próprio ambiente, que poderá ser acessado por uma URL padrão:
Interface:
https://[nomeDoWorkspace]–[account].myvtex.com/
Admin:
https://[nomeDoWorkspace]–[account].myvtex.com/admin
Como criar um Workspace de Desenvolvimento:
Esta é a documentação que contém as orientações para a criação de workspaces de desenvolvimento.
Quem deve fazer? Esta etapa pode ser feita pelo próprio cliente, ou pelo time da VTEX. Para isso é necessário ter instalado na máquina o VTEX CLI, como descrito neste artigo.
Como fazer? Após a instalação do VTEX CLI, através do terminal de comando (PowerShell, Git CMD ou Visual Studio Code, por exemplo), é necessário fazer login da account desejada através do comando:
VTEX login
Em seguinda rodar o comando:
VTEX use {nomedoworkspace}
Caso não exista esse Workspace, o terminal perguntará se deseja criar:
Basta digitar Y que o Workspace de desenvolvimento será criado:
Obs.: A alteração de versão da edição (do CMS Legado para o IO, por exemplo) só pode ser feita por usuários VTEX.
Workspaces de desenvolvimento são mais apropriados para construção do tema da loja, teste de códigos e outros apps, pois eles apontam de forma mais precisa algum bug que possa ocorrer ao fazer os testes. Já ambientes de produção, por outro lado, possuem otimizações que dificultam debugs.
Observações específicas de workspaces de desenvolvimento:
- Workspaces de desenvolvimento não podem ser colocados em produção!
- Ao desenvolver o tema da loja de forma local, somente é possível renderizar este tema em um workspace de desenvolvimento, isso porque o comando que faz esta renderização, (VTEX link) funciona apenas em workspaces de desenvolvimento!
- Antes de rodar o comando VTEX link é necessário ter instalado na loja o Intelligent Search e já feito a primeira configuração de integração do catálogo!
Como criar um Workspace de Produção:
Esta é a documentação que contém as orientações para a criação de workspaces de produção.
A criação do Workspace de produção é semelhante à criação de um Workspace de desenvolvimento, basta adicionar a descrição –production ao final do comando:
VTEX use {workspaceName} --production
Observações específicas de workspaces de produção:
- Workspaces de produção podem ser migrados para o workspace master, através do comando VTEX promote.
- Wospaces de produção não aceitam o comando VTEX link. Neste ambiente, somente é possível instalar Apps que já tenham sido publicados, através do comando VTEX install.
