Administração do Managed Runtime

O Manager Runtime facilita o gerenciamento de organizações, projetos, ambientes e pacotes associados à sua loja virtual do PWA Kit. Este guia descreve a lista crescente de tarefas de administração que são possíveis na ferramenta Runtime Admin na Web. (Todas as tarefas de administração descritas nesse guia, e muitas outras, também podem ser feitas usando o Managed Runtime API.)

Os projetos ajudam você a gerenciar diversos ambientes em uma organização. Todo projeto do PWA Kit precisa ter um projeto correspondente no Managed Runtime para implantação e hospedagem do código da loja virtual na infraestrutura de número pública da Salesforce.

Para criar um projeto em Runtime Admin:

1. Faça logon no Runtime Admin.
2. Clique em New Project (Novo projeto).
3. Insira um nome para o projeto.
4. Clique em Create Project (Criar projeto).

As instruções para o resto das tarefas de administração nesse guia assumem que você está começando da página Overview (Visão geral) de um projeto em Runtime Admin.

Para encontrar um projeto existente e abrir a página Overview (Visão geral) dele:

1. Faça logon no Runtime Admin.
2. Selecione uma organização do menu de organizações (parte superior esquerda), se necessário).
3. Clique no nome do pipeline. (Para ver o projeto, você deve ter uma das funções do projeto descritas anteriormente.)

Para alternar entre projetos de maneira rápida, use o menu do projeto localizado na parte superior da página.

Na página Ver e editar configurações do projeto, você pode fazer o seguinte:

• Buscar o ID do projeto para garantir que corresponda à configuração do PWA Kit.
• Editar o ID do projeto.
• Ver e editar o nome e o URL do projeto.
• Excluir o projeto.
• Gerenciar notificações de implantação. (Veja a próxima seção.)

Para acessar a página Project Settings (Configurações do projeto):

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em Project Settings na navegação à esquerda.

Para editar as configurações, clique em Edit (Editar), faça as edições e clique em Update (Atualizar). Para descartar suas edições, clique em Cancel (Cancelar).

Para excluir um projeto, clique em Delete (Excluir), insira o nome do projeto para confirmar e depois clique em Yes, Delete (Sim, excluir). Para manter o projeto, clique em No, Keep (Não, manter).

Você pode escolher ser notificado por e-mail sempre que qualquer um desses eventos de implantação ocorrer:

• Iniciar implantação
• Implantação bem-sucedida
• Implantação fracassada

Para adicionar uma notificação:

1. Vá para a Overview (Visão geral) de um projeto.
2. Clique em Project Settings (Configurações do projeto), no menu de navegação à esquerda.
3. Clique em Add Notification (Adicionar notificação).
4. Selecione um ou mais ambientes dos quais deseja receber notificações.
5. Selecione um ou mais eventos de implantação.
6. Insira os endereços de e-mail de todos os destinatários da notificação.
7. Clique em Add Notification (Adicionar notificação).

Para editar uma notificação:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em Project Settings (Configurações do projeto), no menu de navegação à esquerda.
3. Clique no botão ... ao lado da notificação.
4. Clique em Edit (Editar).
5. Altere qualquer uma das configurações de notificação.
6. Clique em Update Notification (Atualizar notificação).

Para remover uma notificação:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em Project Settings (Configurações do projeto), no menu de navegação à esquerda.
3. Clique no botão ... ao lado da notificação.
4. Clique em Remove.
5. Clique em Yes, Remove (Sim, remover).

Os ambientes são usados para separar sua loja (virtual) de produção de outras lojas (virtuais) que são implantadas para outros fins, como desenvolvimento ou teste. Para saber mais sobre os ambientes e outros conceitos relacionados, veja Visão geral do Managed Runtime.

Para criar um ambiente no Runtime Admin:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em New Environment (Novo ambiente).
3. Insira um nome para o ambiente.
4. Selecione uma região para implantar a infraestrutura de nuvem pública da Salesforce.
5. Se o ambiente for de produção, marque-o como tal. Se você tiver alcançado o limite de ambientes de produção, entre em contato com o Suporte.
6. Clique em Create Environment (Criar ambiente).

Para qualquer site que usa PWA Kit e Managed Runtime, só é possível designar um pacote por vez como implantado para cada ambiente.

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique no nome do ambiente que deseja implantar. Por exemplo: Production.
3. Na cabeçalho Bundles (Pacotes), clique no botão Deploy (Implantar) ao lado do pacote que deseja implantar.
4. Clique em Confirm Deploy (Confirmar implantação).
5. Espere até que a implantação seja concluída.

Quando a implantação for concluída, o pacote aparecerá sob o cabeçalho Deployed Bundle (Pacote implantado). (O processo para implantar um ambiente pela primeira vez pode demorar uma hora para ser concluído.)

É na página Environment Setting (Configurações do ambiente) que é possível fazer muitas das tarefas de administração, incluindo:

• Renomear um ambiente ou um ID de ambiente.
• Modificar a região de implantação.
• Permitir que os endereços IP específicos acessem o ambiente.
• Configurar proxies para o ambiente. Consulte Proxying Requests (Solicitações de proxy) para mais informações.
• Marque o ambiente como de produção.
• Excluir um ambiente

Para acessar a página Environment Settings:

1. Vá para a página Overview (Visão geral) de um projeto
2. Clique no nome do ambiente cujas configurações deseja editar.
3. Clique em Environment Settings (Configurações do ambiente), no menu de navegação à esquerda.

Para fazer edições, clique no botão Edit (Editar) ao lado de configurações General (Geral) ou Advanced (Avançado). Depois de fazer as edições, clique em Update (Atualizar) para salvar as mudanças ou em Cancel (Cancelar) para descartá-las.

Com as variáveis de ambiente, você pode adicionar variáveis no processo do aplicativo executado em um ambiente sem precisar fazer mudanças no código. Elas são armazenadas com segurança, o que as torna ideais para os seguintes casos de uso:

• Chaves de API para integrações de terceiros
• Sinalizadores de funcionalidade para a lógica do aplicativo
• Configuração diferente entre ambientes

As variáveis de ambiente podem ser gerenciadas usando a Managed Runtime API e acessadas no Node.js usando process.env.

Para configurar, atualizar e desativar as variáveis de ambiente, use projects_target_env_var_partial_update:

Escolha nomes para as variáveis de ambiente que façam sentido para o seu aplicativo. Os valores das variáveis de ambiente podem ser booleanos, inteiros ou strings. Para definir valores complexos, codifique JSON em uma string.

Para desativar uma variável de ambiente existente, defina seu valor como null.

Modificar variáveis de ambiente resulta em uma reimplantação do pacote atual do ambiente.

Para definir todas as variáveis de um ambiente, use projects_target_env_var_list:

O uso de variáveis de ambiente está sujeito às seguintes limitações:

• Cada ambiente tem um limite de 100 variáveis de ambiente.
• O tamanho máximo dos valores das variáveis de ambiente definidas é 32 KB.
• Os nomes das variáveis de ambiente precisam ter até 512 caracteres e não podem começar com prefixos reservados: AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY.
• Os nomes das variáveis de ambiente não podem usar nenhum nome reservado: BUNDLE_ID, DEPLOY_ID, DEPLOY_TARGET, EXTERNAL_DOMAIN_NAME, HANDLER, LAMBDA_RUNTIME_DIR, LAMBDA_TASK_ROOT, NODE_ENV, REDIRECT_BUCKET, REDIRECT_KEY, REDIRECT_UPDATE, REMOTE, X_AMZN_TRACE_ID.

Um redirecionamento permite que você encaminhe uma solicitação do URL solicitado para um URL distinto. Os redirecionamentos podem ajudar a evitar inconvenientes na experiência do usuário causadas por mudanças na loja (virtual). Por exemplo, considere uma página de campanha sazonal para a primavera. Quando a campanha sazonal termina e é substituída por uma campanha de verão, você pode fazer um redirecionamento do URL de primavera ao URL de verão.

O redirecionamento é um recurso avançado que pode ter consequências significativas na segurança da sua loja (virtual), inclusive quanto ao redirecionamento para URLs ou ativos maliciosos. Tenha cuidado ao atribuir funções de usuário que deem acesso ao recurso de redirecionamento.

Para criar um redirecionamento:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique no nome do ambiente onde você quer criar o redirecionamento.
3. Clique em URL Redirects (Redirecionamentos de URL), no menu de navegação à esquerda.
4. Clique em Create Redirect (Criar redirecionamentos).
5. No campo Redirecionar de (Redirecionar de), insira um caminho de URL relativo. Por exemplo, para redirecionar visitantes do URL www.example.com/winter, insira /winter.
6. No campo Redirect To (Redirecionar para), insira um caminho de URL relativo.
7. Se necessário, habilite o encaminhamento dos parâmetros de consulta e do caminho do curinga. (Em breve veremos mais informações sobre o encaminhamento de configurações.)
8. Do menu suspenso Redirect Type (Tipo de redirecionamento), selecione um tipo de redirecionamento com base no código de estado HTTP. (Em breve veremos mais informações sobre códigos de estado.)
9. Clique em Create Redirect (Criar redirecionamentos).

Vejamos agora as opções para criar um redirecionamento em mais detalhes.

O valor que você inserir no campo Redirecionar de deve sempre ser um caminho relativo. O campo Redirect To (Redirecionar para) pode ser tanto um caminho relativo quanto um URL completo. Por exemplo, imagine que você quer redirecionar visitantes de www.example.com/spring para www.example.com/summer. O campo Redirecionar de (Redirecionar de) deve ser /spring. O campo Redirect To (Redirecionar para) pode ser tanto /summer quanto www.example.com/summer.

Você pode adicionar um asterisco (*) no final do URL Redirecionar de (Redirecionar de) para indicar um curinga. Um curinga corresponde a qualquer (0 ou mais) caractere no URL. Por exemplo, um redirecionamento de /a/* corresponderia a /a/, /a/b e /a/b/c.

Um asterisco só pode ser uado no final do URL Redirecionar de (Redirecionar de).

Os redirecionamentos-padrão são processados primeiro pelo Managed Runtime, seguidos pelos redirecionamentos com curingas.

A maioria dos redirecionamentos usa o código de estado Permanent 301, mas você também pode selecionar Temporary 302. Se você não tiver certeza de qual código de estado HTTP usar, consulte este documento que explica os códigos de estado, da MOZ.com.

Algumas solicitações contém parâmetros de string de consulta que você pode querer incluir nas solicitações de redirecionamento. Poe exemplo, o caminho relativo /spring-landing-page pode ser adicionado a uma string de consulta para acompanhamento analítico, como /spring-landing-page?gclid=123.

Para habilitar o encaminhamento do parâmetro de consulta, vá até a seção Forward (Encaminhar) do formulário e selecione Query Parameters (Parâmetros de consulta). Caso contrário, os parâmetros da string de consulta do URL de origem não são incluídos no URL de redirecionamento.

O que acontece quando tanto o URL Redirect From (Redirecionar de) e o URL Redirect To (Redirecionar para) têm strings de consulta e o encaminhamento está habilitado? Neste caso, o URL de redirecionamento inclui uma combinação de ambas string de consulta. Os parâmetros de consulta do URL Redirect To (Redirecionar para) são adicionados à string de consulta na solicitação. Por exemplo, imagine que seu aplicativo recebe uma solicitação para o caminho relativo /spring?year=2019. Se você escolhe redirecionar /spring para /summer?year=2020, o URL de redirecionamento é /summer?year=2019&year=2020 quando o encaminhamento está habilitado.

Você pode incluir automaticamente qualquer caminho depois da parte do curinga do URL Redirect From (Redirecionar de) no URL Redirect To (Redirecionar para). Por exemplo, se /a/* corresponder a /a/b/c no URL Redirect From (Redirecionar de) e o URL Redirect To (Redirecionar para) for /z/, o URL de redirecionamento será /z/b/c.

Para habilitar o encaminhamento do caminho do curinga, vá até a seção Encaminhar do formulário e selecione Wildcard Path (Caminho do curinga).

Você pode copiar todos os redirecionamentos de um ambiente para outro usando o recurso de redirecionamentos de clones.

Para redirecionar clones:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique no nome do ambiente que contém os redirecionamentos que você quer clonar.
3. Clique em URL Redirects (Redirecionamentos de URL), no menu de navegação à esquerda.
4. Clique em Clone Redirects (Clonar redirecionamentos). O formulário Clone Redirects aparece. O ambiente atual aparece em From Environment (Do ambiente) (a origem).
5. Em To Environment (Para o ambiente), selecione o ambiente no qual deseja clonar os redirecionamentos (o destino).
6. Clique em Clone n Redirects (Clonar n redirecionamentos). (No qual “n” é o número de redirecionamentos a serem clonados.)

Para editar as configurações de um redirecionamento existente:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique no nome do ambiente que contém o redirecionamento que você quer editar.
3. Clique em URL Redirects (Redirecionamentos de URL), no menu de navegação à esquerda.
4. Clique no botão (...) ao lado do redirecionamento.
5. Clique em Edit (Editar).
6. Atualize as configurações.
7. Clique em Update Redirect (Atualizar redirecionamento).

Para excluir um redirecionamento:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique no nome do ambiente que contém o redirecionamento que você quer excluir.
3. Clique em URL Redirects (Redirecionamentos de URL), no menu de navegação à esquerda.
4. Clique no botão (...) ao lado do redirecionamento.
5. Clique em Delete (Excluir).
6. Clique em Yes, Delete Redirect (Sim, excluir redirecionamento).

Se um redirecionamento não estiver funcionando como esperado, tente uma estas etapas de solução de problemas:

• Limpe o cache do navegador porque os redirecionamentos ficam guardados em cache.
• Certifique-se de estar vendo as configurações para o ambiente correto.
• Edite o redirecionamento e verifique se os valores corretos foram inseridos nos campos Redirect From (Redirecionar de) e Redirect To (Redirecionar para).

Os redirecionamentos apresentam as seguintes limitações técnicas:

• Cada ambiente pode ter um máximo de 10.000 redirecionamentos.
• Cada ambiente tem seu próprio conjunto de redirecionamentos. É sua reponsabilidade mantê-los sincronizados usando clonagem.
• O recurso de redirecionamento é compatível com redirecionamentos simples de um caminho para outro. Para redirecionamentos complexos com condicionais, use o suporte a redirecionamentos do Express.js em ssr.js.
• Os redirecionamentos criados com a ferramenta Runtime Admin ou com a API do Managed Runtime não são executados em ambientes de desenvolvimento local.
• Não é possível acionar os redirecionamentos por transições de página no aplicativo do PWA Kit, pois eles só podem ser acionados por uma solicitação HTTP.

Confira a seguir como gerenciar seus usuários.

Para adicionar um usuário a um projeto:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em Users & Permissions (Usuários e permissões) no menu de navegação à esquerda.
3. Clique em New User (Novo usuário).
4. Insira o endereço de e-mail do usuário. (Certifique-se de que o usuário faça parte de sua organização e tenha uma das seguintes funções no Account Manager: Managed Runtime User ou Managed Runtime Admin.)
5. Selecione uma função.
6. Clique em Add User (Adicionar usuário).

Para alterar a função de um usuário:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em Users & Permissions (Usuários e permissões) no menu de navegação à esquerda.
3. Clique no botão ... ao lado do nome do usuário.
4. Clique em Edit (Editar).
5. Selecione uma função.
6. Clique no menu pop-up que aparece.
7. Selecione um novo papel.
8. Clique em Salvar.

Acesse a lista com as ações associadas a cada função na Visão geral do Managed Runtime.

Para remover um usuário de um projeto:

1. Vá para a página Overview (Visão geral) de um projeto.
2. Clique em Users & Permissions (Usuários e permissões) no menu de navegação à esquerda.
3. Clique no botão ... ao lado do nome do usuário.
4. Clique em Remove (Remover).
5. Clique em Yes, Remove User (Sim, remover usuário).