Skip to content

Commit f6c2ea1

Browse files
Merge pull request #928 from redis/DOC-4597-rdi-install-updates
DOC-4597 removed obsolete bits about automatic RDI DB creation
2 parents b23bf9d + 6d48181 commit f6c2ea1

File tree

3 files changed

+30
-55
lines changed

3 files changed

+30
-55
lines changed

content/integrate/redis-data-integration/installation/install-k8s.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ information. *This requires Redis Enterprise v6.4 or greater*.
6161
- Use the Redis console to create a database with 250MB RAM with one primary and one replica.
6262
- If you are deploying RDI for a production environment then secure this database with a password
6363
and [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security).
64+
- Set the database's
65+
[eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) to `noeviction` and set
66+
[data persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}})
67+
to AOF - fsync every 1 sec.
6468

6569
You should then provide the details of this database in the [`values.yaml`](#the-valuesyaml-file)
6670
file as described below.

content/integrate/redis-data-integration/installation/install-vm.md

Lines changed: 15 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This guide explains how to install Redis Data Integration (RDI) on one or more V
2020
your source database. You can also
2121
[Install RDI on Kubernetes]({{< relref "/integrate/redis-data-integration/installation/install-k8s" >}}).
2222

23-
{{< note >}}We recommend you use RDI v1.4.0. The previous version, RDI v1.2.8,
23+
{{< note >}}We recommend you use RDI v1.4.2 or above. The previous version, RDI v1.2.8,
2424
will not work on VMs where IPv6 is disabled. This problem is solved with version 1.4.0.
2525
{{< /note >}}
2626

@@ -33,7 +33,7 @@ Each of the RDI VMs should have at least:
3333
2-6 extra cores on top of this if your dataset is big and you want to ingest the
3434
baseline snapshot as fast as possible.
3535
- **RAM**: 2GB
36-
- **Disk**: 25GB, which includes the OS footprint. In particular, you should
36+
- **Disk**: 25GB, which includes the OS footprint. In particular,
3737
RDI requires 7GB in `/var` and 1GB in `/opt` folder (to
3838
store the log files).
3939
- **Network interface**: 10GB or more.
@@ -181,21 +181,18 @@ RDI uses a database on your Redis Enterprise cluster to store its state
181181
information. *This requires Redis Enterprise v6.4 or greater*.
182182

183183
The installer gives you instructions to help you create secrets and create your pipeline.
184-
It will ask you for cluster admin credentials during installation. You should supply
185-
these if you want the installer to create the RDI database for you.
186-
187-
{{<note>}}The installer does not create the RDI Redis database with
188-
[TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security)/
189-
[mTLS](https://en.wikipedia.org/wiki/Mutual_authentication#mTLS).
190-
If you want to use TLS or other advanced options then you must create the Redis database
191-
yourself using the Redis Enterprise console.{{</note>}}
184+
It will ask you for cluster admin credentials during installation.
192185

193-
If you don’t want the installation to create the RDI database for you:
186+
Use the Redis console to create the RDI database with the following requirements:
194187

195-
- Use the Redis console to create a database with 250MB RAM with 1 primary and 1 replica.
188+
- 250MB RAM with one primary and one replica.
196189
- If you are deploying RDI for a production environment then secure this database with a password
197190
and TLS.
198191
- Provide the installation with the required RDI database details.
192+
- Set the database's
193+
[eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) to `noeviction` and set
194+
[data persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}})
195+
to AOF - fsync every 1 sec.
199196
200197
{{< note >}}If you specify `localhost` as the address of the RDI database server during
201198
installation then the connection will fail if the actual IP address changes for the local
@@ -235,31 +232,17 @@ title = "RDI Silent Installer Config"
235232
scaffold = true
236233
deploy_directory = "/opt/rdi/config"
237234
238-
# If you are *not* using an existing RDI database and you want
239-
# the installer to create one then remove the properties in this
240-
# section, apart from :
241-
# - `password`
242-
# - `use_existing_rdi` - set this to `false`
243-
# Also, uncomment the [rdi.cluster] section below.
235+
# Needed if the installer detects a DNS resolver with a loopback address
236+
# as an upstream DNS server
237+
nameservers = ["8.8.8.8", "8.8.4.4"]
238+
244239
[rdi.database]
245240
host = "localhost"
246241
port = 12001
247242
username = "username"
248243
password = "password"
249-
use_existing_rdi = true
250244
ssl = true
251245
252-
# Uncomment this section and remove properties from the
253-
# [rdi.database] section as described above if you
254-
# are *not* using an existing RDI database and you want
255-
# the installer to create one.
256-
# [rdi.cluster]
257-
# host = "localhost"
258-
# port = 9443
259-
# username = "username"
260-
# password = "password"
261-
262-
263246
# Uncomment the properties in this section only if the RDI
264247
# database uses TLS/mTLS.
265248
# [rdi.database.certificates]
@@ -278,41 +261,23 @@ The sections below describe the properties in more detail.
278261
| Property | Description |
279262
|-- |-- |
280263
| `title` | Text to identify the file. RDI doesn't use use this, so you can use any text you like. |
281-
| `high_availability` | Do you want to enable replication on the RDI database (true/false)? You should only use this if you ask the installer to create the RDI database for you. |
282264
| `scaffold` | Do you want to enable [scaffolding]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-scaffold" >}}) during the install? (true/false) |
283265
| `db_index` | Integer to specify the source database type for scaffolding. The options are 2 (MySQL/MariaDB), 3 (Oracle), 4 (PostgreSQL), and 5 (SQL Server). |
284266
| `deploy_directory` | Path to the directory where you want to store the RDI configuration. |
267+
| `nameservers` | This is needed if the installer detects a DNS resolver with a loopback address as an upstream DNS server (for example, `nameservers = ["8.8.8.8", "8.8.4.4"]`). |
285268

286269
#### `rdi.database`
287270

288-
Use the properties in this section if you want to use an existing RDI database.
289-
See [`rdi.cluster`](#rdicluster) below if you want the installer to create a new
290-
RDI database. However, you should still supply the `password` in this
291-
section and set `use_existing_rdi` to `false` if the installer creates the
292-
database.
271+
Use the properties in this section to specify your RDI database.
293272

294273
| Property | Description |
295274
|-- |-- |
296275
| `host` | Hostname for the Redis database to store RDI state. |
297276
| `port` | Port for the RDI database. |
298277
| `username` | Username for the RDI database. |
299278
| `password` | Password for the RDI database. |
300-
| `use_existing_rdi` | Do you want to use an existing RDI instance (true) or create a new one (false)? If you enable SSL (see the property below), this will be set to true, overriding the value you specify here. |
301279
| `ssl` | Is SSL enabled for the RDI database (true/false)? If this is false then RDI will ignore the settings in the [`rdi.database.certificates`](#rdidatabasecertificates) section. |
302280

303-
#### `rdi.cluster`
304-
305-
Use the properties in this section if you are *not* using an existing RDI database
306-
and you want the installer to create one.
307-
See [`rdi.database`](#rdidatabase) above if you want to use an existing RDI database.
308-
309-
| Property | Description |
310-
|-- |-- |
311-
| `host` | Hostname of the Redis cluster to use for RDI. |
312-
| `port` | Port for the cluster. |
313-
| `username` | Username for the cluster. |
314-
| `password` | Password for the cluster. |
315-
316281
#### `rdi.database.certificates`
317282

318283
Use these properties only if the RDI database requires

content/integrate/redis-data-integration/quick-start-guide.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,17 @@ RDI will create the pipeline template for your chosen source database type at
5252

5353
At the end of the installation, RDI CLI will prompt you to set the access secrets
5454
for both the source PostgreSQL database and the Redis RDI database. RDI needs these to
55-
run the pipeline. If you provide admin credentials for your Redis Enterprise cluster here then RDI CLI will
56-
create the RDI database for you automatically. Otherwise, you should create this
57-
database yourself with the Redis Enterprise management console. A single-shard
58-
database with 125MB of RAM will work fine for this tutorial but you can also add a
59-
replica if you want (this will double the RAM requirements to 250MB).
55+
run the pipeline.
56+
57+
Use the Redis console to create the RDI database with the following requirements:
58+
59+
- A single-shard database with 125MB RAM is enough for the quickstart but double this
60+
to 250MB if you want to add a replica.
61+
- Provide the installation with the required RDI database details.
62+
- Set the database's
63+
[eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) to `noeviction` and set
64+
[data persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}})
65+
to AOF - fsync every 1 sec.
6066

6167
### Prepare the pipeline
6268

0 commit comments

Comments
 (0)