How to use one port to route HTTP/1.1 and gRPC requests

[guoheng1999]

this is my apisix config

apisix:    # universal configurations
  node_listen:    # APISIX listening port
    - 9080
    - enable_http2: true
      port: 9081
  enable_heartbeat: true
  enable_admin: true
  enable_admin_cors: true
  enable_debug: false

  enable_dev_mode: false                       # Sets nginx worker_processes to 1 if set to true
  enable_reuseport: true                       # Enable nginx SO_REUSEPORT switch if set to true.
  enable_ipv6: true # Enable nginx IPv6 resolver
  enable_server_tokens: true # Whether the APISIX version number should be shown in Server header
  proxy_cache:                         # Proxy Caching configuration
    cache_ttl: 10s                     # The default caching time if the upstream does not specify the cache time
    zones:                             # The parameters of a cache
    - name: disk_cache_one             # The name of the cache, administrator can be specify
                                       # which cache to use by name in the admin api
      memory_size: 50m                 # The size of shared memory, it's used to store the cache index
      disk_size: 1G                    # The size of disk, it's used to store the cache data
      disk_path: "/tmp/disk_cache_one" # The path to store the cache data
      cache_levels: "1:2"              # The hierarchy levels of a cache

  router:
    http: radixtree_uri  # radixtree_uri: match route by uri(base on radixtree)
                                # radixtree_host_uri: match route by host + uri(base on radixtree)
                                # radixtree_uri_with_parameter: match route by uri with parameters
    ssl: 'radixtree_sni'        # radixtree_sni: match route by SNI(base on radixtree)
  dns_resolver_valid: 30
  resolver_timeout: 5
  ssl:
    enable: false
    listen:
      - port: 9443
        enable_http2: true
    ssl_protocols: "TLSv1.2 TLSv1.3"
    
nginx_config:    # config for render the template to genarate nginx.conf
  error_log: "/dev/stderr"
  error_log_level: "warn"    # warn,error
  worker_processes: "auto"
  enable_cpu_affinity: true
  worker_rlimit_nofile: 20480  # the number of files a worker process can open, should be larger than worker_connections
  event:
    worker_connections: 10620
  http:
    enable_access_log: true
    access_log: "/dev/stdout"
    access_log_format: '$remote_addr - $remote_user [$time_local] $http_host \"$request\" $status $body_bytes_sent $request_time \"$http_referer\" \"$http_user_agent\" $upstream_addr $upstream_status $upstream_response_time \"$upstream_scheme://$upstream_host$upstream_uri\"'
    access_log_format_escape: default
    keepalive_timeout: 60s         # timeout during which a keep-alive client connection will stay open on the server side.
    client_header_timeout: 60s     # timeout for reading client request header, then 408 (Request Time-out) error is returned to the client
    client_body_timeout: 60s       # timeout for reading client request body, then 408 (Request Time-out) error is returned to the client
    send_timeout: 10s              # timeout for transmitting a response to the client.then the connection is closed
    underscores_in_headers: "on"   # default enables the use of underscores in client request header fields
    real_ip_header: "X-Real-IP"    # http://nginx.org/en/docs/http/ngx_http_realip_module.html#real_ip_header
    real_ip_from:                  # http://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from
      - 127.0.0.1
      - 'unix:'
    custom_lua_shared_dict:        # add custom shared cache to nginx.conf
      sales_agent: 1m
discovery:
  consul:
    dump:
      expire: 2592000
      load_on_init: true
      path: logs/consul.dump
    fetch_interval: 3
    keepalive: true
    servers:
    - http://consul-consul-server.sales-agent.svc.cluster.local:8500
    timeout:
      connect: 2000
      read: 2000
      wait: 60
    weight: 1
plugins:    # plugin list
  - api-breaker
  - authz-keycloak
  - basic-auth
  - batch-requests
  - consumer-restriction
  - cors
  - echo
  - fault-injection
  - file-logger
  - grpc-transcode
  - grpc-web
  - hmac-auth
  - http-logger
  - ip-restriction
  - ua-restriction
  - jwt-auth
  - kafka-logger
  - key-auth
  - limit-conn
  - limit-count
  - limit-req
  - node-status
  - openid-connect
  - authz-casbin
  - prometheus
  - proxy-cache
  - proxy-mirror
  - proxy-rewrite
  - redirect
  - referer-restriction
  - request-id
  - request-validation
  - response-rewrite
  - serverless-post-function
  - serverless-pre-function
  - sls-logger
  - syslog
  - tcp-logger
  - udp-logger
  - uri-blocker
  - wolf-rbac
  - zipkin
  - traffic-split
  - gzip
  - real-ip
  - ext-plugin-pre-req
  - ext-plugin-post-req
  - server-info
  - yyb-generate-sign
  - zlkt-generate-sign
stream_plugins:
  - mqtt-proxy
  - ip-restriction
  - limit-conn
plugin_attr:
  prometheus:
    metrics:
      bandwidth:
        extra_labels:
          upstream_addr: $upstream_addr
      http_latency:
        extra_labels:
          upstream_addr: $upstream_addr
      http_status:
        extra_labels:
          upstream_addr: $upstream_addr
          upstream_status: $upstream_status

deployment:
  role: data_plane
  role_data_plane:
    config_provider: control_plane
    control_plane:
      host:
        - "https://apisix-contorl-control-plane.sales-agent.svc.cluster.local:9280"
      prefix: /apisix
      timeout: 30
      tls:
        verify: falseapisix@apisix-data-node-7756fb9d9b-rk9vp:/usr/local/apisix$

[dosubot[bot]]

Hey @guoheng1999! I'm here to help you with any questions or issues you have. I can assist with bug fixes, answer your questions, and guide you on becoming a contributor. Let me know how I can assist you!

To route both HTTP/1.1 and gRPC requests on the same port in APISIX, you can use the following approach:

1. Enable HTTP/2: Ensure that HTTP/2 is enabled on the port you want to use for both HTTP/1.1 and gRPC. This is necessary because gRPC requires HTTP/2. In your configuration, you have:

   node_listen:
     - 9080
     - enable_http2: true
       port: 9081

   This configuration enables HTTP/2 on port 9081. If you want to use a single port for both protocols, ensure that enable_http2: true is set for that port.

2. Use the grpc-transcode Plugin: To handle gRPC requests, you need to enable the grpc-transcode plugin. This plugin allows APISIX to proxy HTTP requests to a gRPC backend. You have already included this plugin in your configuration:

   plugins:
     - grpc-transcode

3. Configure Routes: Set up routes to handle both HTTP/1.1 and gRPC requests. For gRPC, you need to specify the .proto file content and configure the service and method. Here's an example of how to configure a route for gRPC:

   curl http://127.0.0.1:9080/apisix/admin/proto/1 -H 'X-API-KEY: your-api-key' -X PUT -d '  
   {  
       "content" : "syntax = \"proto3\";  
       package helloworld;  
       service Greeter {  
           rpc SayHello (HelloRequest) returns (HelloReply) {}  
       }  
       message HelloRequest {  
           string name = 1;  
       }  
       message HelloReply {  
           string message = 1;  
       }"  
   }'

   Then, configure the route:

   curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: your-api-key' -X PUT -d '  
   {  
       "methods": ["GET"],  
       "uri": "/grpctest",  
       "plugins": {  
           "grpc-transcode": {  
            "proto_id": "1",  
            "service": "helloworld.Greeter",  
            "method": "SayHello"  
           }  
       },  
       "upstream": {  
           "scheme": "grpc",  
           "type": "roundrobin",  
           "nodes": {  
               "127.0.0.1:50051": 1  
           }  
       }  
   }'

By following these steps, you can configure APISIX to route both HTTP/1.1 and gRPC requests on the same port. Make sure your backend services are correctly set up to handle these requests.

To continue talking to Dosu, mention @dosu.

[guoheng1999]

Can it be achieved without using grpc-transcode?

[dosubot[bot]]

Yes, it is possible to route both HTTP/1.1 and gRPC requests on the same port in APISIX without using the grpc-transcode plugin. APISIX 3.0 includes native gRPC support, which allows you to directly handle gRPC requests without additional plugins. This is achieved through the core.grpc module, which enables direct communication with gRPC services ^[1][2][3].

To achieve this, ensure that HTTP/2 is enabled on the port you want to use for both HTTP/1.1 and gRPC, as gRPC requires HTTP/2. In your configuration, you have:

node_listen:
  - 9080
  - enable_http2: true
    port: 9081

This setup enables HTTP/2 on port 9081, allowing it to handle both HTTP/1.1 and gRPC requests. You can configure routes for gRPC requests by specifying the upstream service as a gRPC service without needing the grpc-transcode plugin.

To continue talking to Dosu, mention @dosu.

[guoheng1999]

But when I set it up this way, all REST requests routed through this port keep failing, telling me that there is a problem with the protocol.

[guoheng1999]

GET http://127.0.0.1:9081/api/v1/vars/
Error: Parse Error: Expected HTTP/
Request Headers
User-Agent: PostmanRuntime/7.29.0
Accept: */*
Postman-Token: f61b34ab-7451-4efe-9693-f30fe7ee8b6d
Host: 127.0.0.1:9081
Accept-Encoding: gzip, deflate, br
Connection: keep-alive