]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: undo 55524 55525/head
authorZac Dover <zac.dover@proton.me>
Sat, 10 Feb 2024 14:36:29 +0000 (00:36 +1000)
committerZac Dover <zac.dover@proton.me>
Sat, 10 Feb 2024 14:36:29 +0000 (00:36 +1000)
Roll back the docs changes made in
https://github.com/ceph/ceph/pull/55524, in accordance with Casey
Bodley's instructions to me here:
https://github.com/ceph/ceph/pull/55524#issuecomment-1937020543.

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/radosgw/lua-scripting.rst

index a663c8ed04d55a95c68e85548f98e6031f2f64d1..eafde154e25c0e02999836084e412b361cfa2abb 100644 (file)
@@ -8,6 +8,11 @@ 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
 
@@ -39,29 +44,28 @@ To upload a script:
    
 
 ::
-   
-   # radosgw-admin script put --infile={lua-file-path} --context={preRequest|postRequest} [--tenant={tenant-name}]
-
 
-* When uploading a script into a cluster deployed with cephadm, use the following command:
+   # radosgw-admin script put --infile={lua-file-path} --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}]   
+   
+* When uploading a script with the ``background`` context, a tenant name should not be specified.
 
 ::
 
-  # cephadm shell radosgw-admin script put --infile=/rootfs/{lua-file-path} --context={prerequest|postrequest} [--tenant={tenant-name}]
+  # cephadm shell radosgw-admin script put --infile=/rootfs/{lua-file-path} --context={prerequest|postrequest|background|getdata|putdata} [--tenant={tenant-name}]
 
 
 To print the content of the script to standard output:
 
 ::
    
-   # radosgw-admin script get --context={preRequest|postRequest} [--tenant={tenant-name}]
+   # radosgw-admin script get --context={preRequest|postRequest|background|getdata|putdata} [--tenant={tenant-name}]
 
 
 To remove the script:
 
 ::
    
-   # radosgw-admin script rm --context={preRequest|postRequest} [--tenant={tenant-name}]
+   # radosgw-admin script rm --context={preRequest|postRequest|background|getdata|putdata} [--tenant={tenant-name}]
 
 
 Package Management via CLI