This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new d019da018 feat: stream subsystem support consul service discovery
(#8696)
d019da018 is described below
commit d019da018ca8c06bf80e363a0512a30808da1b8e
Author: Ashing Zheng <[email protected]>
AuthorDate: Mon Feb 6 10:00:53 2023 +0800
feat: stream subsystem support consul service discovery (#8696)
Fixes https://github.com/apache/apisix/issues/7779
---
docs/en/latest/discovery/consul.md | 21 +++
t/discovery/stream/consul.t | 278 +++++++++++++++++++++++++++++++++++++
2 files changed, 299 insertions(+)
diff --git a/docs/en/latest/discovery/consul.md
b/docs/en/latest/discovery/consul.md
index 17e13b001..2db7af144 100644
--- a/docs/en/latest/discovery/consul.md
+++ b/docs/en/latest/discovery/consul.md
@@ -148,6 +148,8 @@ To avoid confusion, use the full consul key url path as
service name in practice
### Upstream setting
+#### L7
+
Here is an example of routing a request with a URL of "/*" to a service which
named "service_a" and use consul discovery client in the registry :
```shell
@@ -188,6 +190,25 @@ The format response as below:
You could find more usage in the `apisix/t/discovery/consul.t` file.
+#### L4
+
+Consul service discovery also supports use in L4, the configuration method is
similar to L7.
+
+```shell
+$ curl http://127.0.0.1:9180/apisix/admin/stream_routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
+{
+ "remote_addr": "127.0.0.1",
+ "upstream": {
+ "scheme": "tcp",
+ "service_name": "service_a",
+ "type": "roundrobin",
+ "discovery_type": "consul"
+ }
+}'
+```
+
+You could find more usage in the `apisix/t/discovery/stream/consul.t` file.
+
## Debugging API
It also offers control api for debugging.
diff --git a/t/discovery/stream/consul.t b/t/discovery/stream/consul.t
new file mode 100644
index 000000000..b50fae184
--- /dev/null
+++ b/t/discovery/stream/consul.t
@@ -0,0 +1,278 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+use t::APISIX 'no_plan';
+
+repeat_each(1);
+log_level('info');
+no_root_location();
+no_shuffle();
+
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ my $http_config = $block->http_config // <<_EOC_;
+
+ server {
+ listen 20999;
+
+ location / {
+ content_by_lua_block {
+ ngx.say("missing consul services")
+ }
+ }
+ }
+
+ server {
+ listen 30511;
+
+ location /hello {
+ content_by_lua_block {
+ ngx.say("server 1")
+ }
+ }
+ }
+ server {
+ listen 30512;
+
+ location /hello {
+ content_by_lua_block {
+ ngx.say("server 2")
+ }
+ }
+ }
+ server {
+ listen 30513;
+
+ location /hello {
+ content_by_lua_block {
+ ngx.say("server 3")
+ }
+ }
+ }
+ server {
+ listen 30514;
+
+ location /hello {
+ content_by_lua_block {
+ ngx.say("server 4")
+ }
+ }
+ }
+_EOC_
+
+ $block->set_value("http_config", $http_config);
+
+ if (!$block->stream_request) {
+ $block->set_value("stream_request", "GET /hello HTTP/1.1\r\nHost:
127.0.0.1:1985\r\nConnection: close\r\n\r\n");
+ }
+});
+
+our $yaml_config = <<_EOC_;
+apisix:
+ node_listen: 1984
+ enable_control: true
+ control:
+ ip: 127.0.0.1
+ port: 9090
+deployment:
+ role: data_plane
+ role_data_plane:
+ config_provider: yaml
+discovery:
+ consul:
+ servers:
+ - "http://127.0.0.1:8500";
+ - "http://127.0.0.1:8600";
+ skip_services:
+ - "service_c"
+ timeout:
+ connect: 1000
+ read: 1000
+ wait: 60
+ weight: 1
+ fetch_interval: 1
+ keepalive: true
+ default_service:
+ host: "127.0.0.1"
+ port: 20999
+ metadata:
+ fail_timeout: 1
+ weight: 1
+ max_fails: 1
+_EOC_
+
+
+run_tests();
+
+__DATA__
+
+=== TEST 1: prepare consul catalog register nodes
+--- config
+location /consul1 {
+ rewrite ^/consul1/(.*) /v1/agent/service/$1 break;
+ proxy_pass http://127.0.0.1:8500;
+}
+
+location /consul2 {
+ rewrite ^/consul2/(.*) /v1/agent/service/$1 break;
+ proxy_pass http://127.0.0.1:8600;
+}
+--- pipelined_requests eval
+[
+ "PUT /consul1/deregister/service_a1",
+ "PUT /consul1/deregister/service_b1",
+ "PUT /consul1/deregister/service_a2",
+ "PUT /consul1/deregister/service_b2",
+ "PUT /consul2/deregister/service_a1",
+ "PUT /consul2/deregister/service_b1",
+ "PUT /consul2/deregister/service_a2",
+ "PUT /consul2/deregister/service_b2",
+ "PUT /consul1/register\n" .
"{\"ID\":\"service_a1\",\"Name\":\"service_a\",\"Tags\":[\"primary\",\"v1\"],\"Address\":\"127.0.0.1\",\"Port\":30511,\"Meta\":{\"service_a_version\":\"4.0\"},\"EnableTagOverride\":false,\"Weights\":{\"Passing\":10,\"Warning\":1}}",
+ "PUT /consul1/register\n" .
"{\"ID\":\"service_a2\",\"Name\":\"service_a\",\"Tags\":[\"primary\",\"v1\"],\"Address\":\"127.0.0.1\",\"Port\":30512,\"Meta\":{\"service_a_version\":\"4.0\"},\"EnableTagOverride\":false,\"Weights\":{\"Passing\":10,\"Warning\":1}}",
+ "PUT /consul1/register\n" .
"{\"ID\":\"service_b1\",\"Name\":\"service_b\",\"Tags\":[\"primary\",\"v1\"],\"Address\":\"127.0.0.1\",\"Port\":30513,\"Meta\":{\"service_b_version\":\"4.1\"},\"EnableTagOverride\":false,\"Weights\":{\"Passing\":10,\"Warning\":1}}",
+ "PUT /consul1/register\n" .
"{\"ID\":\"service_b2\",\"Name\":\"service_b\",\"Tags\":[\"primary\",\"v1\"],\"Address\":\"127.0.0.1\",\"Port\":30514,\"Meta\":{\"service_b_version\":\"4.1\"},\"EnableTagOverride\":false,\"Weights\":{\"Passing\":10,\"Warning\":1}}",
+]
+--- error_code eval
+[200, 200, 200, 200, 200, 200, 200, 200, 200, 200, 200, 200]
+
+
+
+=== TEST 2: test consul server 1
+--- yaml_config eval: $::yaml_config
+--- apisix_yaml
+stream_routes:
+ - server_addr: 127.0.0.1
+ server_port: 1985
+ id: 1
+ upstream:
+ service_name: service_a
+ discovery_type: consul
+ type: roundrobin
+#END
+--- stream_response eval
+qr/server [1-2]/
+--- no_error_log
+[error]
+
+
+
+=== TEST 3: test consul server 2
+--- yaml_config eval: $::yaml_config
+--- apisix_yaml
+stream_routes:
+ - server_addr: 127.0.0.1
+ server_port: 1985
+ id: 1
+ upstream:
+ service_name: service_b
+ discovery_type: consul
+ type: roundrobin
+#END
+--- stream_response eval
+qr/server [3-4]/
+--- no_error_log
+[error]
+
+
+
+=== TEST 4: test mini consul config
+--- yaml_config
+apisix:
+ node_listen: 1984
+deployment:
+ role: data_plane
+ role_data_plane:
+ config_provider: yaml
+discovery:
+ consul:
+ servers:
+ - "http://127.0.0.1:8500";
+ - "http://127.0.0.1:6500";
+#END
+--- apisix_yaml
+stream_routes:
+ - server_addr: 127.0.0.1
+ server_port: 1985
+ id: 1
+ upstream:
+ service_name: service_a
+ discovery_type: consul
+ type: roundrobin
+#END
+--- stream_response eval
+qr/server [1-2]/
+--- ignore_error_log
+
+
+
+=== TEST 5: test invalid service name
+sometimes the consul key maybe deleted by mistake
+--- yaml_config eval: $::yaml_config
+--- apisix_yaml
+stream_routes:
+ - server_addr: 127.0.0.1
+ server_port: 1985
+ id: 1
+ upstream:
+ service_name: service_c
+ discovery_type: consul
+ type: roundrobin
+#END
+--- stream_response_like
+missing consul services
+--- ignore_error_log
+
+
+
+=== TEST 6: test skip keys
+skip some services, return default nodes, get response: missing consul services
+--- yaml_config
+apisix:
+ node_listen: 1984
+deployment:
+ role: data_plane
+ role_data_plane:
+ config_provider: yaml
+discovery:
+ consul:
+ servers:
+ - "http://127.0.0.1:8600";
+ prefix: "upstreams"
+ skip_services:
+ - "service_a"
+ default_service:
+ host: "127.0.0.1"
+ port: 20999
+ metadata:
+ fail_timeout: 1
+ weight: 1
+ max_fails: 1
+#END
+--- apisix_yaml
+stream_routes:
+ - server_addr: 127.0.0.1
+ server_port: 1985
+ id: 1
+ upstream:
+ service_name: service_a
+ discovery_type: consul
+ type: roundrobin
+#END
+--- stream_response_like
+missing consul services
+--- ignore_error_log
