Merge pull request ceph#52326 from yuvalif/wip-yuval-lua-reload

rgw/lua: support reloading lua packages on all RGWs

reviwed-by: dang, cbodle, anthonyeleven

Author: yuvalif

doc/radosgw/lua-scripting.rst

@@ -23,7 +23,8 @@ To change this default value, use the ``rgw_lua_max_memory_per_state`` configura
 
 By default, all Lua standard libraries are available in the script, however, in order to allow for other Lua modules to be used in the script, we support adding packages to an allowlist:
 
-  - All packages in the allowlist are being re-installed using the luarocks package manager on radosgw restart. Therefore a restart is needed for adding or removing of packages to take effect 
+  - Adding a Lua package to the allowlist, or removing a packge from it does not install or remove it. For the changes to take affect a "reload" command should be called.
+  - In addition all packages in the allowlist are being re-installed using the luarocks package manager on radosgw restart.
   - To add a package that contains C source code that needs to be compiled, use the ``--allow-compilation`` flag. In this case a C compiler needs to be available on the host
   - Lua packages are installed in, and used from, a directory local to the radosgw. Meaning that Lua packages in the allowlist are separated from any Lua packages available on the host.
     By default, this directory would be ``/tmp/luarocks/<entity name>``. Its prefix part (``/tmp/luarocks/``) could be set to a different location via the ``rgw_luarocks_location`` configuration parameter. 
@@ -116,6 +117,13 @@ To print the list of packages in the allowlist:
   # radosgw-admin script-package list
 
 
+To apply changes from the allowlist to all RGWs:
+
+::
+
+  # radosgw-admin script-package reload
+
+
 Context Free Functions
 ----------------------
 Debug Log
@@ -460,16 +468,23 @@ First we should add the following packages to the allowlist:
 
 ::
 
-  # radosgw-admin script-package add --package=luajson
+  # radosgw-admin script-package add --package=lua-cjson --allow-compilation
   # radosgw-admin script-package add --package=luasocket --allow-compilation
 
 
-Then, do a restart for the radosgw and upload the following script to the ``postrequest`` context:
+Then, run a server to listen on the Unix socket. For example, use "netcat":
+
+::
+
+  # rm -f /tmp/socket       
+  # nc -vklU /tmp/socket
+
+And last, do a restart for the radosgw and upload the following script to the ``postrequest`` context:
 
 .. code-block:: lua
 
   if Request.RGWOp == "get_obj" then
-    local json = require("json")
+    local json = require("cjson")
     local socket = require("socket")
     local unix = require("socket.unix")
     local s = assert(unix())

src/common/options/rgw.yaml.in

@@ -3755,7 +3755,7 @@ options:
   type: str
   level: advanced
   desc: Directory where luarocks install packages from allowlist
-  default: @rgw_luarocks_location@
+  default: /tmp/rgw_luarocks/$name
   services:
   - rgw
   flags:

src/rgw/driver/daos/rgw_sal_daos.cc

@@ -880,8 +880,8 @@ const std::string& DaosZone::get_current_period_id() {
   return current_period->get_id();
 }
 
-std::unique_ptr<LuaManager> DaosStore::get_lua_manager() {
-  return std::make_unique<DaosLuaManager>(this);
+std::unique_ptr<LuaManager> DaosStore::get_lua_manager(const DoutPrefixProvider *dpp, const std::string& luarocks_path) {
+  return std::make_unique<DaosLuaManager>(this, dpp, luarocks_path);
 }
 
 int DaosObject::get_obj_state(const DoutPrefixProvider* dpp,

src/rgw/driver/daos/rgw_sal_daos.h

@@ -997,7 +997,7 @@ class DaosStore : public StoreDriver {
   }
   virtual std::string get_host_id() { return ""; }
 
-  virtual std::unique_ptr<LuaManager> get_lua_manager() override;
+  std::unique_ptr<LuaManager> get_lua_manager(const DoutPrefixProvider *dpp = nullptr, const std::string& luarocks_path = "") override;
   virtual std::unique_ptr<RGWRole> get_role(
       std::string name, std::string tenant, std::string path = "",
       std::string trust_policy = "", std::string max_session_duration_str = "",

src/rgw/driver/motr/rgw_sal_motr.cc

@@ -1151,9 +1151,9 @@ const std::string& MotrZone::get_current_period_id()
   return current_period->get_id();
 }
 
-std::unique_ptr<LuaManager> MotrStore::get_lua_manager()
+std::unique_ptr<LuaManager> MotrStore::get_lua_manager(const DoutPrefixProvider *dpp, const std::string& luarocks_path)
 {
-  return std::make_unique<MotrLuaManager>(this);
+  return std::make_unique<MotrLuaManager>(this, dpp, luarocks_path);
 }
 
 int MotrObject::get_obj_state(const DoutPrefixProvider* dpp, RGWObjState **_state, optional_yield y, bool follow_olh)
@@ -3901,6 +3901,11 @@ int MotrStore::init_metadata_cache(const DoutPrefixProvider *dpp,
   {
     return -ENOENT;
   }
+  
+  int MotrLuaManager::reload_packages(const DoutPrefixProvider* dpp, optional_yield y)
+  {
+    return -ENOENT;
+  }
 } // namespace rgw::sal
 
 extern "C" {

src/rgw/driver/motr/rgw_sal_motr.h

@@ -559,6 +559,8 @@ class MotrLuaManager : public StoreLuaManager {
   virtual int remove_package(const DoutPrefixProvider* dpp, optional_yield y, const std::string& package_name) override;
   /** List lua packages */
   virtual int list_packages(const DoutPrefixProvider* dpp, optional_yield y, rgw::lua::packages_t& packages) override;
+  /** Reload lua packages */
+  virtual int reload_packages(const DoutPrefixProvider* dpp, optional_yield y) override;
 };
 
 class MotrOIDCProvider : public RGWOIDCProvider {
@@ -1047,7 +1049,7 @@ class MotrStore : public StoreDriver {
     virtual const RGWSyncModuleInstanceRef& get_sync_module() { return sync_module; }
     virtual std::string get_host_id() { return ""; }
 
-    virtual std::unique_ptr<LuaManager> get_lua_manager() override;
+    std::unique_ptr<LuaManager> get_lua_manager(const DoutPrefixProvider *dpp = nullptr, const std::string& luarocks_path = "") override;
     virtual std::unique_ptr<RGWRole> get_role(std::string name,
         std::string tenant,
         std::string path="",