feat(control): add hosts/reload to control api

apache · Nov 5, 2024 · d7c8580 · d7c8580
1 parent 45679ae
commit d7c8580
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 5 deletions.
diff --git a/apisix/control/router.lua b/apisix/control/router.lua
@@ -203,10 +203,15 @@ local function reload_plugins()
     plugin_mod.load()
 end
 
+local function reload_hosts()
+    core.log.info("start to hot reload hosts")
+    core.resolver.reload_hosts()
+end
+
 
 function _M.init_worker()
-    -- register reload plugin handler
-    events:register(reload_plugins, builtin_v1_routes.reload_event, "PUT")
+    events:register(reload_plugins, builtin_v1_routes.reload_plugins_event, "PUT")
+    events:register(reload_hosts, builtin_v1_routes.reload_hosts_event, "PUT")
 end
 
 return _M
diff --git a/apisix/control/v1.lua b/apisix/control/v1.lua
@@ -32,7 +32,8 @@ local events = require("apisix.events")
 
 local _M = {}
 
-_M.RELOAD_EVENT = 'control-api-plugin-reload'
+_M.RELOAD_PLUGINS_EVENT = 'control-api-plugins-reload'
+_M.RELOAD_HOSTS_EVENT = 'control-api-hosts-reload'
 
 function _M.schema()
     local http_plugins, stream_plugins = plugin.get_all({
@@ -404,14 +405,28 @@ function _M.dump_plugin_metadata()
 end
 
 function _M.post_reload_plugins()
-    local success, err = events:post(_M.RELOAD_EVENT, ngx.req.get_method(), ngx.time())
+    local success, err = events:post(_M.RELOAD_PLUGINS_EVENT, ngx.req.get_method(), ngx.time())
     if not success then
         core.response.exit(503, err)
     end
 
     core.response.exit(200, "done")
 end
 
+function _M.post_reload_hosts()
+    local success, err = events:post(_M.RELOAD_HOSTS_EVENT, ngx.req.get_method(), ngx.time())
+    if not success then
+        core.response.exit(503, err)
+    end
+
+    core.response.exit(200, "done")
+end
+
+function _M.get_hosts()
+    local hosts = core.resolver.get_hosts()
+    return 200, hosts
+end
+
 return {
     -- /v1/schema
     {
@@ -491,6 +506,19 @@ return {
         uris = {"/plugins/reload"},
         handler = _M.post_reload_plugins,
     },
+    -- /v1/hosts/reload
+    {
+        methods = {"PUT"},
+        uris = {"/hosts/reload"},
+        handler = _M.post_reload_hosts,
+    },
+    -- /v1/hosts/reload
+    {
+        methods = {"GET"},
+        uris = {"/hosts"},
+        handler = _M.get_hosts,
+    },
     get_health_checkers = _get_health_checkers,
-    reload_event = _M.RELOAD_EVENT,
+    reload_plugins_event = _M.RELOAD_PLUGINS_EVENT,
+    reload_hosts_event = _M.RELOAD_HOSTS_EVENT,
 }
diff --git a/apisix/core/resolver.lua b/apisix/core/resolver.lua
@@ -41,6 +41,16 @@ local function init_hosts_ip()
 end
 
 
+function _M.reload_hosts()
+    init_hosts_ip()
+end
+
+
+function _M.get_hosts()
+    return HOSTS_IP_MATCH_CACHE
+end
+
+
 function _M.init_resolver(args)
     --  initialize /etc/hosts
     init_hosts_ip()

diff --git a/docs/en/latest/control-api.md b/docs/en/latest/control-api.md
@@ -485,3 +485,11 @@ Triggers a hot reload of the plugins.
 ```shell
 curl "http://127.0.0.1:9090/v1/plugins/reload" -X PUT
 ```
+
+### PUT /v1/hosts/reload
+
+Triggers a hot reload of the hosts.
+
+```shell
+curl "http://127.0.0.1:9090/v1/hosts/reload" -X PUT
+```