Skip to content

Commit 8bfe2d1

Browse files
committed
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 <[email protected]>
1 parent f8e4e33 commit 8bfe2d1

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

doc/radosgw/lua-scripting.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,8 @@ Lua Scripting
88

99
This feature allows users to assign execution context to Lua scripts. The supported contexts are:
1010

11-
- ``prerequest`` which will execute a script before each operation is performed
12-
- ``postrequest`` which will execute after each operation is performed
13-
- ``background`` which will execute within a specified time interval
14-
- ``getdata`` which will execute on objects' data when objects are downloaded
15-
- ``putdata`` which will execute on objects' data when objects are uploaded
11+
- ``preRequest`` which will execute a script before each operation is performed
12+
- ``postRequest`` which will execute after each operation is performed
1613

1714
A request (pre or post) or data (get or put) context script may be constrained to operations belonging to a specific tenant's users.
1815
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:
4340

4441
::
4542
46-
# radosgw-admin script put --infile={lua-file-path} --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}]
43+
# radosgw-admin script put --infile={lua-file-path} --context={preRequest|postRequest} [--tenant={tenant-name}]
4744

4845

49-
* When uploading a script with the ``background`` context, a tenant name should not be specified.
5046
* When uploading a script into a cluster deployed with cephadm, use the following command:
5147

5248
::
5349

54-
# cephadm shell radosgw-admin script put --infile=/rootfs/{lua-file-path} --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}]
50+
# cephadm shell radosgw-admin script put --infile=/rootfs/{lua-file-path} --context={prerequest|postrequest} [--tenant={tenant-name}]
5551

5652

5753
To print the content of the script to standard output:
5854

5955
::
6056
61-
# radosgw-admin script get --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}]
57+
# radosgw-admin script get --context={preRequest|postRequest} [--tenant={tenant-name}]
6258

6359

6460
To remove the script:
6561

6662
::
6763
68-
# radosgw-admin script rm --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}]
64+
# radosgw-admin script rm --context={preRequest|postRequest} [--tenant={tenant-name}]
6965

7066

7167
Package Management via CLI

0 commit comments

Comments
 (0)