Alibaba Cloud Service Mesh:Transcode HTTP/JSON requests to gRPC with ASMGrpcJsonTranscoder

Como funciona

O ingress gateway gerencia toda a transcodificação. Além da anotação no arquivo .proto, nenhuma alteração no nível da aplicação é necessária.

Pré-requisitos

Antes de começar, certifique-se de ter:

• Uma instância do ASM da Enterprise Edition ou Ultimate Edition. Consulte Criar uma instância do ASM

• Um cluster adicionado à instância do ASM

• Um serviço de exemplo gRPC implantado no cluster. Consulte Usar um ingress gateway para acessar um serviço gRPC em uma instância do ASM

• Protocol Buffers (protoc) instalado localmente

Adicione anotações HTTP e gere um descritor proto

Para mapear um endpoint HTTP a um método gRPC, adicione uma anotação google.api.http no arquivo .proto e compile-o em um arquivo .proto-descriptor que o filtro Envoy lê em tempo de execução.

option(google.api.http) = {
    get: "/sayHello/{name}"
};

// Copyright 2015 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";

package helloworld;
import "google/api/annotations.proto";

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {
    option(google.api.http) = {
        get: "/sayHello/{name}"
    };
  }

  rpc SayHelloStreamReply (HelloRequest) returns (stream HelloReply) {}

  rpc SayHelloBidiStream (stream HelloRequest) returns (stream HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings.
message HelloReply {
  string message = 1;
}

Crie o recurso ASMGrpcJsonTranscoder

A CRD ASMGrpcJsonTranscoder instrui o plano de controle do ASM a configurar a transcodificação gRPC-JSON no ingress gateway.

1. Salve o YAML a seguir como grpcjsontranscoder-helloworld.yaml:

      apiVersion: istio.alibabacloud.com/v1beta1
      kind: ASMGrpcJsonTranscoder
      metadata:
        name: grpcjsontranscoder-helloworld
        namespace: istio-system
      spec:
        isGateway: true                    # Apply the transcoder to the ingress gateway
        portNumber: 8080                   # Port for HTTP/JSON requests
        workloadSelector:
          labels:
            istio: ingressgateway          # Target the default ingress gateway
        printOptions:
          addWhitespace: true              # Pretty-print JSON responses
          alwaysPrintEnumsAsInts: false     # Print enum names instead of integer values
          alwaysPrintPrimitiveFields: false # Omit fields with default values from responses
          preserveProtoFieldNames: false    # Use camelCase field names (protobuf default)
        priority: 0
        services:
          - helloworld.Greeter             # Fully qualified gRPC service name (<package>.<service>)

2. Revise os campos principais:

   Campo	Descrição	Padrão
   isGateway	Defina como true para aplicar o transcodificador no ingress gateway em vez de nos proxies sidecar.	false
   portNumber	Porta no ingress gateway que aceita requisições HTTP/JSON.	--
   workloadSelector.labels	Seletor de rótulo que identifica qual carga de trabalho do gateway recebe o filtro Envoy.	--
   services	Lista de nomes de serviço gRPC totalmente qualificados (<package>.<service>) para transcodificar.	--
   printOptions.addWhitespace	Formata respostas JSON com indentação para melhor legibilidade.	false
   printOptions.alwaysPrintEnumsAsInts	Exibe valores de enumeração como inteiros em vez de nomes.	false
   printOptions.alwaysPrintPrimitiveFields	Inclui campos com valores padrão (por exemplo, um int32 definido como 0) na resposta JSON. Quando false, esses campos são omitidos.	false
   printOptions.preserveProtoFieldNames	Usa os nomes originais dos campos proto na saída JSON em vez de converter para camelCase.	false

   Para a referência completa de campos, consulte Descrições dos campos do ASMGrpcJsonTranscoder.

3. Aplique o recurso:

      kubectl apply -f grpcjsontranscoder-helloworld.yaml

Verifique a transcodificação

Após aplicar o recurso ASMGrpcJsonTranscoder, o ingress gateway passa a aceitar requisições HTTP/JSON e a transcodificá-las para gRPC.

1. Obtenha o endereço IP do ingress gateway:

      kubectl -n istio-system get svc istio-ingressgateway \
          -o jsonpath='{.status.loadBalancer.ingress[0].ip}'

2. Envie uma requisição de teste para a porta 8080:

      curl http://<ingress-gateway-ip>:8080/sayHello/Mark

   Substitua <ingress-gateway-ip> pelo endereço IP obtido na etapa 1.

3. Verifique a resposta. Uma resposta bem-sucedida tem o seguinte formato:

      {
       "message": "Hello, Mark! I'm from grpc-helloworld-py-v1-79b5dc9654-cg4dq!"
      }

   Uma resposta JSON do serviço gRPC de backend confirma que a transcodificação de HTTP para gRPC está funcionando.

Próximos passos

• Descrições dos campos do ASMGrpcJsonTranscoder: referência completa dos campos da CRD.

• Usar um ingress gateway para acessar um serviço gRPC em uma instância do ASM: configure o acesso direto via gRPC sem transcodificação HTTP.