Como usar o template Upstash GeoLocation através da Azion

Preview

Upstash GeoLocation é uma automação desenvolvida para implantar um banco de dados diretamente no edge enquanto permite a configuração de mensagens personalizadas que serão entregues de acordo com a localização geográfica do usuário.

Essas mensagens são entregues por meio de uma interface estática, baseada em HTML e gerada pelo template após a implantação.


Antes de usar este template, você precisa:

  1. Criar uma conta no Upstash.
  2. Criar um banco de dados global para obter a melhor latência de edge disponível no console do Upstash.
  3. Gerar seu token pessoal do GitHub.

Você também deve ativar:

Edge Functions
Application Accelerator
  1. Acesse o Azion Console.
  2. Selecione Account menu > Billing & Subscriptions.
  3. Clique na aba Subscriptions.
  4. Active o switch de cada módulo.

Para obter o template, acesse o Azion Console e selecione a opção Start with a template na página inicial.

Isso abrirá uma nova página onde você pode selecionar o card do Upstash GeoLocation.

Na página do template, clique na aba Settings para abrir o formulário de configuração e fornecer as informações para configurar sua aplicação.

Os campos identificados com asterisco são obrigatórios.

  • Application Name *: o nome da sua aplicação. Ele é usado para identificar e gerenciar sua aplicação na plataforma da Azion.
    • Digite um nome único e fácil de lembrar. Se o nome já tiver sido usado, a plataforma retornará uma mensagem de erro.
  • Upstash Redis Rest URL *: a URL para acessar seu banco de dados Upstash usando REST.
    • Acesse o console do Upstash e copie o UPSTASH_REDIS_REST_URL na página do banco de dados.
  • Upstash Redis Rest Token *: o token para autorizar o acesso ao seu banco de dados Upstash usando REST.
    • Acesse o console do Upstash e copie o UPSTASH_REDIS_REST_TOKEN na página do banco de dados.
  • GitHub Personal Token *: seu personal token do GitHub.

Depois de preencher todas as informações, clique no botão Next, localizado no canto inferior direito. Isso iniciará o processo de deployment.

Durante a implantação, você poderá acompanhar o processo através de uma janela mostrando os logs. Quando estiver concluída, uma nova página será exibida, confirmando que a edge application para o seu projeto foi criada com sucesso.

Esta página mostra as seguintes seções:

  • A seção Access your Edge Application, que inclui o link para visitar e explorar sua aplicação.
  • O Build Summary contém o nome e a função da aplicação.
  • Na aba Deployment details, você pode acessar os logs relacionados com o deployment do template.
  • O⁠ What do you want to do next? fornece recomendações sobre opções avançadas para aprimorar sua edge application: Customize Domain, Manage Edge Application, View Edge Application Metrics, View Edge Application Logs e o botão Back to Home.

O Upstash GeoLocation cria uma nova edge application na Azion e seu domínio. Também cria uma edge function para fornecer os argumentos para o template, incluindo os argumentos para a geolocalização, um novo repositório em sua conta no GitHub com base em um template público e uma interface estática para exibir as mensagens.

Nesta função, a biblioteca upstash/redis é integrada, conectando-se ao seu banco de dados global no Upstash e recuperando a mensagem com base na localização do usuário. Esta localização é retirada dos metadados ["geoip_country_code"].

O template também incorpora em seu banco de dados mensagens baseadas na localização, que são recuperadas da integração com o Upstash, semelhante a este exemplo:

Terminal window
Welcome to Upstash CLI
set BR "Olá, tudo bem!"
OK
set GB "Ey up?"
OK
set US "Yo, what’s up?"
OK
set IN "Namaste"
OK

Você pode personalizar essas mensagens em seu banco de dados do Upstash para atender às suas necessidades.

Para saber como editar e personalizar as configurações de seu projeto, vá para a seção Gerenciar seu projeto na Azion.


Considerando que essa configuração inicial pode não ser ideal para sua aplicação, todas as configurações podem ser personalizadas sempre que você precisar usando o Azion Console. Depois que o template for implantado, você também terá controle total sobre a personalização de sua conta e banco de dados do Upstash.

Para gerenciar e editar as configurações da sua aplicação, siga estas etapas:

  1. Acesse o Azion Console.
  2. No canto superior esquerdo, selecione Products menu > Edge Application.
  • Você será redirecionado para a página de Edge Application. Ela lista todas as edge applications que você criou.
  1. Encontre a edge application relacionada ao template e selecione-a.
  • A lista é organizada em ordem alfabética. Você também pode usar a barra de busca localizada no canto superior esquerdo da lista; atualmente, ela é filtrada apenas pelo Application Name, ou nome da edge application.

Depois de selecionar a aplicação em que você trabalhará, você será direcionado para uma página que contém todas as configurações que você pode configurar.

Uma vez que o template é implantado, você pode editar e atualizar seus args e código na edge function, bem como implementar um fluxo de trabalho de continuous deployment, ou implantação contínua. No entanto, você precisará primeiro declarar seus secrets no repositório do GitHub do seu projeto para completar um segundo build com as alterações.

Quando o segundo build for concluído, você poderá gerenciar seu projeto com um fluxo de trabalho de implantação contínua e editar os argumentos conforme desejado.

Para fazer isso, abra seu repositório do Upstash GeoLocation no GitHub. Em seguida, vá para Settings > Secrets and variables > Action para adicionar suas variáveis, seguindo estas instruções:

  1. Adicione o Azion personal token aos secrets:
Terminal window
AZION_PERSONAL_TOKEN=<value>
  1. Adicione os ambientes para uso no action workflow no arquivo main.yml, dentro da pasta .github/workflows do seu repositório:
.github/workflows/main.yml
- name: edge-...
id: azion_edge
...
with:
....
azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }}
....
  1. Adicione as credenciais de acesso ao banco de dados aos secrets, sendo:
  • Upstash Redis Rest URL *: a URL para acessar seu banco de dados Upstash usando REST.
    • Acesse o console do Upstash e copie o UPSTASH_REDIS_REST_URL na página do banco de dados.
  • Upstash Redis Rest Token *: o token para autorizar o acesso ao seu banco de dados Upstash usando REST.
    • Acesse o console do Upstash e copie o UPSTASH_REDIS_REST_TOKEN na página do banco de dados.
Terminal window
UPSTASH_REDIS_REST_URL=<value>
UPSTASH_REDIS_REST_TOKEN=<value>;
  1. Adicione os ambientes para uso no action workflow no arquivo main.yml, dentro da pasta .github/workflows do seu repositório:
.github/workflows/main.yml
- name: Create args file
run: |
...
"UPSTASH_REDIS_REST_URL": "${{ secrets.UPSTASH_REDIS_REST_URL }}",
"UPSTASH_REDIS_REST_TOKEN": "${{ secrets.UPSTASH_REDIS_REST_TOKEN }}",
...
  1. Abra um pull request para incluir as alterações na main branch e iniciar a implantação automática.

Agora, seu projeto está pronto para trabalhar com um fluxo de trabalho de implantação contínua, atualizando instantaneamente quaisquer alterações no aplicativo ou no repositório.

A edge application criada tem um domínio Azion atribuído para torná-la acessível através do navegador. O domínio tem o seguinte formato: xxxxxxxxxx.map.azionedge.net. No entanto, você pode adicionar um domínio personalizado para que os usuários acessem sua aplicação por meio dele.

Leia a documentação de domínios

Contribuidores