Skip to content

Commit 2d3e41d

Browse files
committed
DOC-4564 RS: Added missing module requirements to recover DB
1 parent 1384274 commit 2d3e41d

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

content/operate/rs/databases/recover.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The database recovery process includes:
2323

2424
1. If the cluster failed, [recover the cluster]({{< relref "/operate/rs/clusters/cluster-recovery.md" >}}).
2525
1. Identify recoverable databases.
26+
1. Verify the module versions used by any databases are installed on the cluster.
2627
1. Restore the database data.
2728
1. Verify that the databases are active.
2829

@@ -70,6 +71,72 @@ of the configuration and persistence files on each of the nodes.
7071

7172
If you cannot resolve the issues, contact [Redis support](https://redis.com/company/support/).
7273

74+
1. Verify the module versions used by any recoverable databases are installed on the cluster:
75+
76+
1. Check which module versions are currently installed on the cluster using one of the following methods:
77+
78+
{{< multitabs id="get-module-versions"
79+
tab1="Cluster Manager UI"
80+
tab2="rladmin"
81+
tab3="REST API" >}}
82+
83+
In the Cluster Manager UI, go to **Cluster > Modules**.
84+
85+
-tab-sep-
86+
87+
Run [`rladmin status modules`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-modules" >}}):
88+
89+
```sh
90+
rladmin status modules
91+
```
92+
93+
-tab-sep-
94+
95+
Send a [`GET /v1/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#list-modules" >}}) request:
96+
97+
```sh
98+
GET https://<host>:<port>/v1/modules
99+
```
100+
101+
{{< /multitabs >}}
102+
103+
1. Identify the module versions required by your databases from the cluster configuration store (CCS) files.
104+
105+
1. Download any missing modules versions from the [Redis download center](https://redis.io/downloads/#tools).
106+
107+
1. [Install the downloaded modules on the cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}}) using one of the following methods:
108+
109+
{{< multitabs id="install-modules"
110+
tab1="Cluster Manager UI"
111+
tab2="REST API" >}}
112+
113+
To add a module to the cluster using the Cluster Manager UI:
114+
115+
1. Go to **Cluster > Modules**.
116+
117+
1. Select **Upload module**.
118+
119+
1. Use the file browser to add the packaged module.
120+
121+
-tab-sep-
122+
123+
To add a module to the cluster using the REST API:
124+
125+
1. Copy the module package to a node in the cluster.
126+
127+
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:
128+
129+
```sh
130+
POST https://[host][:port]/v2/modules
131+
"module=@/tmp/redisearch.Linux-ubuntu16.04-x86_64.2.2.6.zip"
132+
```
133+
134+
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.
135+
136+
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.
137+
138+
{{< /multitabs >}}
139+
73140
1. Recover the database using one of the following [`rladmin recover`]({{< relref "/operate/rs/references/cli-utilities/rladmin/recover" >}}) commands:
74141

75142
- Recover all databases from the persistence files located in the persistent storage drives:

0 commit comments

Comments
 (0)