You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md
+58-18Lines changed: 58 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,12 @@ linkTitle: Install on a cluster
10
10
weight: 10
11
11
---
12
12
13
-
[Redis Enterprise Software]({{< relref "/operate/rs" >}}) comes packaged with several modules. As of version 7.8.2, Redis Enterprise Software includes three feature sets, compatible with different Redis database versions. You can view the installed modules, their versions, and their minimum compatible Redis database versions from **Cluster > Modules** in the Cluster Manager UI.
13
+
[Redis Enterprise Software]({{< relref "/operate/rs" >}}) comes packaged with several modules. As of version 8.0, Redis Enterprise Software includes four feature sets, compatible with different Redis database versions. You can view the installed modules, their versions, and their minimum compatible Redis database versions from **Cluster > Modules** in the Cluster Manager UI.
14
14
15
15
To use other modules or upgrade an existing module to a more recent version, you need to install the new module package on your cluster.
16
16
17
17
{{<warning>}}
18
-
- Some module versions are not supported or recommended for use with Redis Enterprise.
19
-
20
-
- We recommend consulting [Redis support](https://redis.io/support/) before you upgrade a module on the cluster, especially if the cluster is used in production.
18
+
Some module versions are not supported or recommended for use with Redis Enterprise Software.
21
19
{{</warning>}}
22
20
23
21
## Get packaged modules
@@ -28,17 +26,61 @@ To install or upgrade a module on a [Redis Enterprise Software]({{< relref "/ope
28
26
29
27
- For custom-packaged modules, download a [custom-packaged module](https://redislabs.com/community/redis-modules-hub/) from the developer.
30
28
31
-
## Add a module to a cluster
29
+
## Add a user-defined module to a cluster (Redis Software v8.0.x and later) {#add-user-defined-module-to-cluster}
30
+
31
+
To add a custom module to a cluster running Redis Enterprise Software version 8.0.x or later, use the following REST API requests:
32
+
33
+
1.[Upload the custom module configuration]({{< relref "/operate/rs/references/rest-api/requests/modules/user-defined#post-user-defined-module" >}}). Replace the values in the following example with your own.
34
+
35
+
```sh
36
+
POST https://<host>:<port>/v2/modules/user-defined
37
+
{
38
+
"module_name": "TestModule",
39
+
"version": 1,
40
+
"semantic_version": "0.0.1",
41
+
"display_name": "test module",
42
+
"commands": [
43
+
{
44
+
"command_arity": -1,
45
+
"command_name": "module.command",
46
+
"first_key": 1,
47
+
"flags": ["write"],
48
+
"last_key": 1,
49
+
"step": 1
50
+
}
51
+
],
52
+
"command_line_args": "",
53
+
"capabilities": ["list", "of", "capabilities"],
54
+
"min_redis_version": "2.1"
55
+
}
56
+
```
57
+
58
+
1. For each node in the cluster, [upload the custom module artifact]({{< relref "/operate/rs/references/rest-api/requests/modules/user-defined#post-local-user-defined-artifacts">}}):
59
+
60
+
```sh
61
+
POST https://<host>:<port>/v2/local/modules/user-defined/artifacts
62
+
"module=@/tmp/custom-module.so"
63
+
```
64
+
65
+
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.
66
+
67
+
## Add a module to a cluster (Redis Software v7.22.x and earlier) {#add-a-module-to-a-cluster}
68
+
69
+
Use one of the following methods to add a module to a cluster running Redis Enterprise Software version 7.22.x or earlier:
32
70
33
-
Use one of the following methods to add a module to a Redis Enterprise cluster:
71
+
{{< multitabs id="install-modules"
72
+
tab1="Cluster Manager UI"
73
+
tab2="REST API">}}
34
74
35
-
- REST API [`POST` request to the `/v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#post-module-v2" >}}) endpoint
75
+
To add a module to the cluster using the Cluster Manager UI:
36
76
37
-
- Redis Enterprise Cluster Manager UI
77
+
1. Go to **Cluster > Modules**.
38
78
39
-
- For RedisGears, follow these [installation instructions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears" >}})
79
+
1. Select **Upload module**.
40
80
41
-
### REST API method
81
+
1. Use the file browser to add the packaged module.
82
+
83
+
-tab-sep-
42
84
43
85
To add a module to the cluster using the REST API:
44
86
@@ -47,23 +89,21 @@ To add a module to the cluster using the REST API:
47
89
1. Add the module to the cluster with a [`POST` request to the `/v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#post-module-v2">}}) endpoint:
Here, the *module* parameter specifies the full path of the module package and must be submitted as form-data. In addition, the package must be available and accessible to the server processing the request.
55
97
56
98
1. If the module installation succeeds, the `POST` request returns a [JSON object]({{< relref "/operate/rs/references/rest-api/objects/module">}}) that represents the new module. If it fails, it may return a JSON object with an `error_code` and `description` with more details.
57
99
58
-
### Cluster Manager UI method
100
+
{{< /multitabs >}}
59
101
60
-
To add a module to the cluster using the Cluster Manager UI:
102
+
For RedisGears, follow these [installation instructions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears">}}) instead.
61
103
62
-
1. Go to **Cluster > Modules**.
63
-
64
-
1. Select **Upload module**.
65
-
66
-
1. Use the file browser to add the packaged module.
104
+
{{<warning>}}
105
+
We recommend consulting [Redis support](https://redis.io/support/) before you upgrade a module on the cluster, especially if the cluster is used in production.
0 commit comments