From: Zac Dover Date: Sat, 10 Feb 2024 03:14:59 +0000 (+1000) Subject: doc/radosgw: remove invalid LUA context options X-Git-Tag: v19.1.0~330^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=8bfe2d1ae6e24590651bfde3854b60d950677b37;p=ceph.git doc/radosgw: remove invalid LUA context options Remove "background", "getdata", and "putdata" from the list of LUA context options. Passing these options throws the following error: "ERROR: invalid script context: background. must be one of: preRequest, postRequest". Fixes: https://tracker.ceph.com/issues/64327 Signed-off-by: Zac Dover --- diff --git a/doc/radosgw/lua-scripting.rst b/doc/radosgw/lua-scripting.rst index 8f95aea3c14a0..a663c8ed04d55 100644 --- a/doc/radosgw/lua-scripting.rst +++ b/doc/radosgw/lua-scripting.rst @@ -8,11 +8,8 @@ Lua Scripting This feature allows users to assign execution context to Lua scripts. The supported contexts are: - - ``prerequest`` which will execute a script before each operation is performed - - ``postrequest`` which will execute after each operation is performed - - ``background`` which will execute within a specified time interval - - ``getdata`` which will execute on objects' data when objects are downloaded - - ``putdata`` which will execute on objects' data when objects are uploaded + - ``preRequest`` which will execute a script before each operation is performed + - ``postRequest`` which will execute after each operation is performed A request (pre or post) or data (get or put) context script may be constrained to operations belonging to a specific tenant's users. The request context script can also access fields in the request and modify certain fields, as well as the `Global RGW Table`_. @@ -43,29 +40,28 @@ To upload a script: :: - # radosgw-admin script put --infile={lua-file-path} --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}] + # radosgw-admin script put --infile={lua-file-path} --context={preRequest|postRequest} [--tenant={tenant-name}] -* When uploading a script with the ``background`` context, a tenant name should not be specified. * When uploading a script into a cluster deployed with cephadm, use the following command: :: - # cephadm shell radosgw-admin script put --infile=/rootfs/{lua-file-path} --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}] + # cephadm shell radosgw-admin script put --infile=/rootfs/{lua-file-path} --context={prerequest|postrequest} [--tenant={tenant-name}] To print the content of the script to standard output: :: - # radosgw-admin script get --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}] + # radosgw-admin script get --context={preRequest|postRequest} [--tenant={tenant-name}] To remove the script: :: - # radosgw-admin script rm --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}] + # radosgw-admin script rm --context={preRequest|postRequest} [--tenant={tenant-name}] Package Management via CLI