Skip to content

Commit 4e2b6a8

Browse files
authored
DOC-6096 RS: Clarified that upload custom module artifact REST API requests require the module .zip file (#2540)
1 parent f9cade9 commit 4e2b6a8

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To add a custom module to a cluster running Redis Enterprise Software version 8.
5959

6060
```sh
6161
POST https://<host>:<port>/v2/local/modules/user-defined/artifacts
62-
"module=@/tmp/custom-module.so"
62+
"module=@/tmp/custom-module.zip"
6363
```
6464

6565
The *module* parameter specifies the full path of the module artifact and must be submitted as form-data. In addition, the module artifact must be available and accessible to the server processing the request.

content/operate/rs/references/rest-api/requests/modules/user-defined.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Returns a JSON array of custom module artifacts.
7979
POST /v2/modules/user-defined
8080
```
8181

82-
Creates a module object in the cluster configuration store (CCS). After calling this endpoint, you still need to upload the module's `.so` file to each node by calling [`POST /v2/local/modules/user-defined/artifacts`](#post-local-user-defined-artifacts) on each node.
82+
Creates a module object in the cluster configuration store (CCS). After calling this endpoint, you still need to upload the module's `.zip` file, which contains the `.so` and `module.json` files, to each node by calling [`POST /v2/local/modules/user-defined/artifacts`](#post-local-user-defined-artifacts) on each node.
8383

8484
#### Permissions
8585

@@ -170,6 +170,18 @@ POST /v2/local/modules/user-defined/artifacts
170170

171171
A local API to upload a custom module's artifact to the current node. You must call this API on each cluster node.
172172

173+
The module must be packaged as a `.zip` file containing:
174+
175+
- **module.json**: A metadata file with module information including:
176+
- `module_name`: The actual module name
177+
- `version`: Numeric version
178+
- `semantic_version`: Semantic version string (for example, "1.0.0")
179+
- `min_redis_version`: Minimum compatible Redis version
180+
- `commands`: List of commands the module provides
181+
- `capabilities`: List of module capabilities
182+
183+
- **Module binary**: The compiled `.so` file for the target platform
184+
173185
#### Permissions
174186

175187
| Permission name | Roles |

0 commit comments

Comments
 (0)