Conectar-se a um Gateway gerido para Spring em Azure Container Apps (versão prévia)

O Gateway for Spring oferece uma forma eficiente e poderosa de encaminhar, gerir e tratar pedidos de API como parte de uma arquitetura de microserviços. Ele serve como um API Gateway que roteia solicitações externas para diferentes serviços, adicionando vários recursos, como filtragem, balanceamento de carga e muito mais. Neste artigo, você aprenderá a criar um gateway que direciona solicitações para seus aplicativos de contêiner.

Neste tutorial, irá aprender a:

Pré-requisitos

• Uma conta no Azure com uma subscrição ativa. Se ainda não tiver um, pode criar um gratuitamente.
• CLI do Azure.

Considerações

Ao correr no Gateway for Spring no Azure Container Apps, esteja atento aos seguintes detalhes:

Configurar

Antes de começar a trabalhar com o Gateway for Spring, primeiro você precisa criar os recursos necessários.

Execute os comandos a seguir para criar seu grupo de recursos e o ambiente de Aplicativos de Contêiner.

1. Crie variáveis para dar suporte à configuração do aplicativo. Esses valores são fornecidos para você para os fins desta lição. Usamos o endpoint actuator do aplicativo de exemplo do Admin para Spring nesta lição.

   export LOCATION=eastus
   export RESOURCE_GROUP=my-spring-cloud-resource-group
   export ENVIRONMENT=my-spring-cloud-environment
   export JAVA_COMPONENT_NAME=mygateway
   export APP_NAME=myapp
   export IMAGE="mcr.microsoft.com/javacomponents/samples/sample-admin-for-spring-client:latest"
   

   Variável	Descrição
   LOCATION	O local da região Azure onde cria a sua aplicação de contentores e o componente Java.
   ENVIRONMENT	O nome do ambiente Azure Container Apps para a sua aplicação de demonstração.
   RESOURCE_GROUP	O nome do grupo de recursos do Azure para a sua aplicação de demonstração.
   JAVA_COMPONENT_NAME	O nome do componente Java criado para a tua aplicação container. Neste caso, cria um componente Gateway para Spring Java.
   IMAGE	A imagem de contêiner usada em seu aplicativo de contêiner.

2. Inicie sessão no Azure com a CLI do Azure.

   az login
   

3. Crie um grupo de recursos.

   az group create --name $RESOURCE_GROUP --location $LOCATION
   

4. Crie seu ambiente de aplicativos de contêiner.

   az containerapp env create \
       --name $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --location $LOCATION
   

   Esse ambiente é usado para hospedar o componente Gateway for Spring e seu aplicativo de contêiner.

Use o componente Gateway para Spring Java

Agora que você tem um ambiente de Apps de Contêiner, pode criar seu aplicativo de contêiner utilizando um gateway para os componentes Spring Java, a fim de rotear solicitações para os mesmos.

1. Crie o componente Gateway para Spring Java.

   az containerapp env java-component gateway-for-spring create \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \
   

2. Crie o aplicativo de contêiner que tenha o nome de domínio totalmente qualificado (FQDN).

   az containerapp create \
       --name $APP_NAME \
       --resource-group $RESOURCE_GROUP \
       --environment $ENVIRONMENT \
       --image $IMAGE \
       --ingress external \
       --target-port 8080 \
       --query properties.configuration.ingress.fqdn
   

   Este comando retorna a URL do seu aplicativo de contêiner que consome dados de configuração. Copie o URL para um editor de texto para que você possa usá-lo na próxima etapa.

Atualizar as rotas do gateway para encaminhar solicitações

1. Crie um arquivo YAML com o seguinte conteúdo. Substitua <MYAPP_URL> pelo FQDN do aplicativo contêiner da etapa anterior.

   springCloudGatewayRoutes:
   - id: "route1"
     uri: "<MYAPP_URL>"
     predicates:
       - "Path=/myapp/{path}"
     filters:
       - "SetPath=/actuator/{path}"
   

2. Execute o seguinte comando para atualizar o componente Gateway for Spring com sua configuração de rota.

   az containerapp env java-component gateway-for-spring update \
       --environment $ENVIRONMENT \
       --resource-group $RESOURCE_GROUP \
       --name $JAVA_COMPONENT_NAME \ 
       --route-yaml <PTAH_TO_ROUTE_YAML_FILE> \
       --query properties.ingress.fqdn
   

   Este comando atualiza a rota do gateway e devolve o URL do seu gateway que utiliza dados de configuração.

   O comando retorna a URL do gateway. Visitar este URL com o caminho /myapp/health deve encaminhar a solicitação para o endpoint actuator/health do seu aplicativo, retornando {"status":"UP","groups":["liveness","readiness"]}.

Limpar recursos

Os recursos criados neste tutorial têm um impacto na sua fatura do Azure. Se você não vai usar esses serviços a longo prazo, execute o seguinte comando para remover tudo o que foi criado neste tutorial.

az group delete --resource-group $RESOURCE_GROUP

Formato de arquivo de rota

O componente Gateway for Spring oferece suporte à definição de rotas por meio de propriedades com ID, URI, predicados e filtros. Para obter mais informações, consulte a documentação do Spring Cloud Gateway. A seguir está um exemplo de arquivo YAML que demonstra como configurar essas propriedades.

  springCloudGatewayRoutes:
  - id: "route1"
    uri: "https://otherjavacomponent.myenvironment.test.net"
    predicates:
      - "Path=/v1/{path}"
      - "After=2024-01-01T00:00:00.000-00:00[America/Denver]"
    filters:
      - "SetPath=/{path}"
  - id: "route2"
    uri: "https://otherjavacomponent.myenvironment.test.net"
    predicates:
      - "Path=/v2/{path}"
      - "After=2024-01-01T00:00:00.000-00:00[America/Denver]"
    filters:
      - "SetPath=/{path}"

Lista de configurações permitidas para o seu Gateway for Spring(#configurable-properties)

A tabela a seguir descreve as propriedades do componente de gateway que você pode configurar para seu aplicativo. Para obter mais informações, consulte Propriedades comuns do aplicativo Spring Cloud Gateway.

Configurações comuns

A lista a seguir descreve configurações comuns:

• Configurações relacionadas ao registo:
  • logging.level.*
  • logging.group.*
  • Quaisquer outras configurações em logging.* namespace devem ser proibidas. Por exemplo, escrever arquivos de log usando logging.file deve ser proibido.