suppport v2 api

yokawasa · yokawasa · commit 0d02bfe6b8ef · 2020-08-14T08:33:17.000+09:00
diff --git a/timeouts-retries/README.md b/timeouts-retries/README.md
@@ -1,14 +1,16 @@
 # Timeouts and Retries
 
+Envoy allows retries to be configured both in the [route configuration](https://www.envoyproxy.io/docs/envoy/v1.5.0/api-v2/rds.proto#envoy-api-msg-routeaction-retrypolicy) as well as for specific requests via [request headers](https://www.envoyproxy.io/docs/envoy/v1.5.0/configuration/http_filters/router_filter#config-http-filters-router-headers). The demo here shows how to configure request timeouts and retries using the envoy route configuration.
+
 ## Demo Overview
 
 ![](../assets/demo-timeouts-retries.png)
 
-Front-proxy configurations are the same as the ones in [HTTP Routing: Simple Match Routing](../httproute-simple-match). Differences from [HTTP Routing: Simple Match Routing](../httproute-simple-match) are the following 2 additional behaviors:
+Front proxy configurations in this demo are the same as the ones in [HTTP Routing: Simple Match Routing](../httproute-simple-match) except the following two additional behaviors:
 - `Timeouts` (5 seconds) for the request to `service_blue`
 - `Retries` that Envoy will attempt to do if `service_red` responds with any 5xx response code
 
-For Service Containers, `delay` fault injection and `abort` fault injection are configured in `service_blue` and `service_red` respectively (which are the same configuration as the ones in [Fault Injection Demo](../fault-injection))
+For Service Containers in the demo, `delay` fault injection and `abort` fault injection are configured in `service_blue` and `service_red` respectively (which are the same configuration as the ones in [Fault Injection Demo](../fault-injection))
 
 Key definition - `virtual_hosts` in [front-envoy.yaml](front-envoy.yaml)
 ```yaml
@@ -31,12 +33,15 @@ Key definition - `virtual_hosts` in [front-envoy.yaml](front-envoy.yaml)
         route:
             cluster: service_red
             retry_policy:
-            retry_on: "5xx"
-            num_retries: 3
-            per_try_timeout: 5s
+              retry_on: "5xx"
+              num_retries: 3
+              per_try_timeout: 5s
 ```
-> - `timeout`:  (Duration) Specifies the timeout for the route. If not specified, the default is 15s. For more detail, see `timeout` section in [RouteAction](https://www.envoyproxy.io/docs/envoy/v1.5.0/api-v2/rds.proto#routeaction)
-> - `retry_policy` indicates the retry policy for all routes in this virtual host. For more detail on retry_policy, see [route.RetryPolicy](https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route.proto.html#envoy-api-msg-route-retrypolicy)
+> - `timeout`: (Duration) Specifies the timeout for the route. If not specified, the default is 15s. For more detail, see`timeout`section in [RouteAction](https://www.envoyproxy.io/docs/envoy/v1.5.0/api-v2/rds.proto#routeaction)
+> - `retry_policy` indicates the retry policy for all routes in this virtual host. For more detail on retry_policy, see [route.RetryPolicy](https://www.envoyproxy.io/docs/envoy/v1.5.0/api-v2/rds.proto#envoy-api-msg-routeaction-retrypolicy)
+>   - `retry_on`: it's retry condition by which the Envoy can retry on different types of conditions depending on application requirements. For example, network failure, all 5xx response codes, idempotent 4xx response codes, etc.
+>   - `num_retires`: Maximum number of retries. Envoy will continue to retry any number of times. An exponential backoff algorithm is used between each retry.
+
 
 ## Getting Started
 ```sh
@@ -50,24 +55,24 @@ cd envoy-proxy-demos/timeouts-retries
 ### Build and Run containers
 
 ```sh
-$ docker-compose up --build -d
+docker-compose up --build -d
 
 # check all services are up
-$ docker-compose ps --service
+docker-compose ps --service
 
 front-envoy
 service_blue
 service_green
 service_red
 
 # List containers
-$ docker-compose ps
+docker-compose ps
 
               Name                            Command               State                            Ports
 -----------------------------------------------------------------------------------------------------------------------------------
-timeouts-retries_front-envoy_1     /usr/bin/dumb-init -- /bin ...   Up      10000/tcp, 0.0.0.0:8000->80/tcp, 0.0.0.0:8001->8001/tcp
-timeouts-retries_service_blue_1    /bin/sh -c /usr/local/bin/ ...   Up      10000/tcp, 80/tcp
-timeouts-retries_service_green_1   /bin/sh -c /usr/local/bin/ ...   Up      10000/tcp, 80/tcp
+timeouts-retries_front-envoy_1     /docker-entrypoint.sh /bin ...   Up      10000/tcp, 0.0.0.0:8000->8000/tcp, 0.0.0.0:8001->8001/tcp
+timeouts-retries_service_blue_1    /bin/sh -c /usr/local/bin/ ...   Up      10000/tcp, 80/tcp                                        
+timeouts-retries_service_green_1   /bin/sh -c /usr/local/bin/ ...   Up      10000/tcp, 80/tcp                                        
 timeouts-retries_service_red_1     /bin/sh -c /usr/local/bin/ ...   Up      10000/tcp, 80/tcp
 ```
 
@@ -76,7 +81,7 @@ timeouts-retries_service_red_1     /bin/sh -c /usr/local/bin/ ...   Up      1000
 Access serivce_blue and check if 50% of requests to service_blue are timeout error (over 5 seconds timeout error with 504 status code). The following helper command allow you to send requests repeatedly (For example, send 10 requests to http://localhost:8000/service/blue).
 
 ```sh
-$ ../helpers/send-requests.sh http://localhost:8000/service/blue 10
+../helpers/send-requests.sh http://localhost:8000/service/blue 10
 
 Sending GET request: http://localhost:8000/service/blue
 504
@@ -93,13 +98,13 @@ Sending GET request: http://localhost:8000/service/blue
 Access serivce_blue and check if green background page is displayed. It is expected that nothting special will occur
 
 ```sh
-$ curl -s http://localhost:8000/service/green
+curl -s http://localhost:8000/service/green
 ```
 
 Access serivce_red and check if most of requests to service_red are ok (200 status code), but seldomly you'll get abort error (503 status code). To explain what happens behind the senene, 50% of requests to  `service_red` will be aborted with 503 error code due to the fault injection config in service_red, however the request will be recovered by the front proxy's retry mechanism, which is why most of the requests to service_red tuned out to be ok (200 status code). The following helper command allow you to send requests repeatedly (For example, send 10 requests to http://localhost:8000/service/blue)
 
 ```sh
-$ ../helpers/send-requests.sh http://localhost:8000/service/red 10
+../helpers/send-requests.sh http://localhost:8000/service/red 10
 
 Sending GET request: http://localhost:8000/service/red
 200
@@ -108,26 +113,53 @@ Sending GET request: http://localhost:8000/service/red
 Sending GET request: http://localhost:8000/service/red
 200
 Sending GET request: http://localhost:8000/service/red
-200
+503
 Sending GET request: http://localhost:8000/service/red
 200
 Sending GET request: http://localhost:8000/service/red
 200
 Sending GET request: http://localhost:8000/service/red
 200
 Sending GET request: http://localhost:8000/service/red
-503
+200
 Sending GET request: http://localhost:8000/service/red
 200
 Sending GET request: http://localhost:8000/service/red
 200
 ```
 
+The example run above shows 503 status code one time out of 10 requests, however as explained above this isn't what actually occured. Let's see what it was like with `docker-compose logs`:
+
+```
+docker-compose logs -f
+
+service_red_1    | [2020-08-13T22:58:42.619Z] "GET /service/red HTTP/2" 200 - 0 148 1 1 "-" "curl/7.54.0" "c381450e-b8f9-4b06-9b08-adab5bbb5b87" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:43.645Z] "GET /service/red HTTP/2" 200 - 0 148 2 1 "-" "curl/7.54.0" "fd67460c-a332-4510-8b78-fc870a8db246" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:44.671Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "0e89d112-3e53-4c23-8360-83d8debc8b14" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:44.688Z] "GET /service/red HTTP/2" 200 - 0 148 2 2 "-" "curl/7.54.0" "0e89d112-3e53-4c23-8360-83d8debc8b14" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:45.714Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "536e2d42-92fb-4146-833d-8501ed859d04" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:45.729Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "536e2d42-92fb-4146-833d-8501ed859d04" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:45.755Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "536e2d42-92fb-4146-833d-8501ed859d04" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:45.755Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "536e2d42-92fb-4146-833d-8501ed859d04" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:45.779Z] "GET /service/red HTTP/2" 200 - 0 148 2 1 "-" "curl/7.54.0" "536e2d42-92fb-4146-833d-8501ed859d04" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:46.805Z] "GET /service/red HTTP/2" 200 - 0 148 3 2 "-" "curl/7.54.0" "c84a1945-f342-43a2-bb72-27a3dcc25ab6" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:47.826Z] "GET /service/red HTTP/2" 200 - 0 148 2 1 "-" "curl/7.54.0" "7700a887-d419-4f9f-965d-107504007a6c" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:48.853Z] "GET /service/red HTTP/2" 200 - 0 148 1 1 "-" "curl/7.54.0" "9f3a2717-83da-495f-8115-159a02854446" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:49.881Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "664deb97-c446-464c-82c0-ad5f4ed2c8d1" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:49.893Z] "GET /service/red HTTP/2" 503 FI 0 18 0 - "-" "curl/7.54.0" "664deb97-c446-464c-82c0-ad5f4ed2c8d1" "localhost:8000" "-"
+service_red_1    | [2020-08-13T22:58:49.936Z] "GET /service/red HTTP/2" 200 - 0 148 2 1 "-" "curl/7.54.0" "664deb97-c446-464c-82c0-ad5f4ed2c8d1" "localhost:8000" "127.0.0.1:8080"
+service_red_1    | [2020-08-13T22:58:50.965Z] "GET /service/red HTTP/2" 200 - 0 148 1 1 "-" "curl/7.54.0" "f4d7012b-7eb3-44a3-9a16-c8d345049707" "localhost:8000" "127.0.0.1:8080"
+...
+```
+
+ It shows `service_red` was be aborted with 503 error code, and that requests from the front proxy was retried and was recovered if it was within `3` retries, the value of `num_retries`.
+
+
 ## Stop & Cleanup
 
 ```sh
-$ docker-compose down --remove-orphans --rmi all
+docker-compose down --remove-orphans --rmi all
 ```
 
 ---
-[Top](../README.md)
+[Top](../README.md)
diff --git a/timeouts-retries/docker-compose.yml b/timeouts-retries/docker-compose.yml
@@ -1,4 +1,4 @@
-version: '2'
+version: '3.7'
 services:
 
   front-envoy:
@@ -13,12 +13,12 @@ services:
       # Create and use a Docker network named “envoymesh” for this container
       - envoymesh
     expose:
-      # Expose ports 80 (for general traffic) and 8001 (for the admin server)
-      - "80"
+      # Expose ports 8000 (for general traffic) and 8001 (for the admin server)
+      - "8000"
       - "8001"
     ports:
-      # Map the host port 8000 to container port 80, and the host port 8001 to container port 8001
-      - "8000:80"
+      # Map the host port 8000 to container port 8000, and the host port 8001 to container port 8001
+      - "8000:8000"
       - "8001:8001"
 
   service_blue:
diff --git a/timeouts-retries/front-envoy.yaml b/timeouts-retries/front-envoy.yaml
@@ -3,11 +3,12 @@ static_resources:
   - address:
       socket_address:
         address: 0.0.0.0
-        port_value: 80
+        port_value: 8000
     filter_chains:
     - filters:
-      - name: envoy.http_connection_manager
-        config:
+      - name: envoy.filters.network.http_connection_manager
+        typed_config:
+          "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
           codec_type: auto
           stat_prefix: ingress_http
           route_config:
@@ -35,39 +36,63 @@ static_resources:
                     num_retries: 3
                     per_try_timeout: 5s
           http_filters:
-          - name: envoy.router
-            config: {}
+          - name: envoy.filters.http.router
+            typed_config: {}
   clusters:
   - name: service_blue
     connect_timeout: 0.25s
     type: strict_dns
     lb_policy: round_robin
     http2_protocol_options: {}
-    hosts:
-    - socket_address:
-        address: service_blue
-        port_value: 80
+    load_assignment:
+      cluster_name: service_blue
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: service_blue
+                port_value: 80
   - name: service_green
     connect_timeout: 0.25s
     type: strict_dns
     lb_policy: round_robin
     http2_protocol_options: {}
-    hosts:
-    - socket_address:
-        address: service_green
-        port_value: 80
+    load_assignment:
+      cluster_name: service_green
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: service_green
+                port_value: 80
   - name: service_red
     connect_timeout: 0.25s
     type: strict_dns
     lb_policy: round_robin
     http2_protocol_options: {}
-    hosts:
-    - socket_address:
-        address: service_red
-        port_value: 80
+    load_assignment:
+      cluster_name: service_red
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: service_red
+                port_value: 80
 admin:
   access_log_path: "/dev/null"
   address:
     socket_address:
       address: 0.0.0.0
       port_value: 8001
+layered_runtime:
+  layers:
+    - name: static_layer_0
+      static_layer:
+        envoy:
+          resource_limits:
+            listener:
+              example_listener_name:
+                connection_limit: 10000
diff --git a/timeouts-retries/service-envoy-fault-injection-abort.yaml b/timeouts-retries/service-envoy-fault-injection-abort.yaml
@@ -6,10 +6,16 @@ static_resources:
         port_value: 80
     filter_chains:
     - filters:
-      - name: envoy.http_connection_manager
-        config:
+      - name: envoy.filters.network.http_connection_manager
+        typed_config:
+          "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
           codec_type: auto
           stat_prefix: ingress_http
+          access_log:
+            name: envoy.access_loggers.file
+            typed_config:
+              "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
+              path: /dev/stdout
           route_config:
             name: local_route
             virtual_hosts:
@@ -22,27 +28,36 @@ static_resources:
                 route:
                   cluster: local_service
           http_filters:
-          - name: envoy.fault
-            config:
+          - name: envoy.filters.http.fault
+            typed_config:
+              "@type": type.googleapis.com/envoy.config.filter.http.fault.v2.HTTPFault
               abort:
                 http_status: 503
                 percentage:
                   numerator: 50
                   denominator: HUNDRED
-          - name: envoy.router
-            config: {}
+          - name: envoy.filters.http.router
+            typed_config: {}
   clusters:
   - name: local_service
     connect_timeout: 0.25s
     type: strict_dns
     lb_policy: round_robin
-    hosts:
-    - socket_address:
-        address: 127.0.0.1
-        port_value: 8080
+    load_assignment:
+      cluster_name: local_service
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8080
 admin:
-  access_log_path: "/dev/null"
+  access_log_path: /dev/stdout
   address:
     socket_address:
       address: 0.0.0.0
       port_value: 8081
+#runtime:
+#  symlink_root: /srv/runtime/current
+#  subdirectory: envoy
diff --git a/timeouts-retries/service-envoy-fault-injection-delay.yaml b/timeouts-retries/service-envoy-fault-injection-delay.yaml
