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
***Encryption key**: Select the [encryption key](#create-encryption-key) you created earlier.
2
+
3
+
***Resource permissions**: Add the following permissions to your secret to allow the Redis data pipeline to access your secret. Replace `<AWS ACCOUNT ID>` with the AWS account ID for the Redis Cloud cluster that you saved earlier.
Copy file name to clipboardExpand all lines: content/operate/rc/databases/rdi/define.md
+24-9Lines changed: 24 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,12 @@ After you have [prepared your source database]({{<relref "/operate/rc/databases/
30
30
-**Database**: Your database's name, or the root database *(PostgreSQL, Oracle only)*, or a comma-separated list of one or more databases you want to connect to *(SQL Server only)*
31
31
-**Database Server ID**: Unique ID for the replication client. Enter a number that is not used by any existing replication clients *(mySQL and mariaDB only)*
32
32
-**PDB**: Name of the Oracle pluggable database *(Oracle only)*
33
-
1. Enter the ARN of your [database credentials secret]({{< relref "/operate/rc/databases/rdi/setup#share-source-database-credentials" >}}) in the **Source database secrets ARN** field.
33
+
1. Enter the ARN of your [database credentials secret]({{< relref "/operate/rc/databases/rdi/setup#create-database-credentials-secrets" >}}) in the **Source database secrets ARN** field.
34
+
1. If your database requires TLS, select **Use TLS**. Enter the ARN of your [CA certificate secret]({{< relref "/operate/rc/databases/rdi/setup#create-database-credentials-secrets" >}}) in the **CA Cert Secret ARN** field.
35
+
{{<imagefilename="images/rc/rdi/rdi-define-tls.png"alt="The Source database connectivity section, with Use TLS selected and the CA Cert Secret ARN field." >}}
36
+
1. If your database requires mTLS, select **Use mTLS**. Enter the ARN of your [Client certificate secret]({{< relref "/operate/rc/databases/rdi/setup#create-database-credentials-secrets" >}}) in the **Client Certificate Secret ARN** field and the ARN of your [Client key secret]({{< relref "/operate/rc/databases/rdi/setup#create-database-credentials-secrets" >}}) in the **Client Key Secret ARN** field.
37
+
{{<imagefilename="images/rc/rdi/rdi-define-mtls.png"alt="The Source database connectivity section, with Use TLS selected and the Client Certificate Secret ARN and Client Key Secret ARN fields." >}}
38
+
1. If your database requires mTLS with a client key passphrase, enter the ARN of your [Client key passphrase secret]({{< relref "/operate/rc/databases/rdi/setup#create-database-credentials-secrets" >}}) in the **Please add a secret ARN for the password to use with the secret store** field.
1. Redis Cloud will attempt to connect to PrivateLink. If your PrivateLink does not allow automatic acceptance of incoming connections, accept the incoming connection on AWS PrivateLink to proceed. See [Accept or Reject PrivateLink connection requests](https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#accept-reject-connection-requests).
@@ -53,21 +58,29 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
53
58
54
59
### Configure a new pipeline
55
60
56
-
1. In the [Redis Cloud console](https://cloud.redis.io/), go to your target database and select the **Data Pipeline** tab. If your pipeline is already provisioned, select **Complete setup** to go to the **Select data** section.
61
+
1. In the [Redis Cloud console](https://cloud.redis.io/), go to your target database and select the **Data Pipeline** tab. If your pipeline is already provisioned, select **Complete setup** to go to the **Data modeling** section.
You can select any number of columns from a table.
62
71
63
-
{{<imagefilename="images/rc/rdi/rdi-select-columns.png"alt="The select source data section. A table is expanded with a few columns selected."width=75% >}}
72
+
{{<imagefilename="images/rc/rdi/rdi-select-columns.png"alt="The manage columns screen, with a few columns selected from one table"width=75% >}}
64
73
65
-
If any tables are missing a unique constraint, the **Missing unique constraint**list will appear. Select the columns that define a unique constraint for those tables from the list.
74
+
If any tables are missing a unique constraint, a warning will appear in the **Data modeling**section. Select **Manage columns** to select the columns that define a unique constraint for those tables.
1.In the **Pipeline definition** section, select the Redis data type to write keys to the target. You can choose **Hash** or **JSON** if the target database supports JSON.
96
+
1.Select the Redis data type to write keys to the target. You can choose **Hash** or **JSON** if the target database supports JSON.
You can also supply one or more [transformation job files]({{< relref "/integrate/redis-data-integration/data-pipelines/transform-examples" >}}) that specify how you want to transform the captured data before writing it to the target. Select **Upload jobs** to upload your job files.
87
100
88
101
{{<imagefilename="images/rc/rdi/rdi-transformation-jobs.png"alt="The transformation jobs section. Select Upload jobs to upload transformation jobs." >}}
89
102
103
+
When you upload job files, Redis Cloud will validate the job files to check for errors.
1. Review the tables you selected in the **Summary**. If everything looks correct, select **Start ingest** to start ingesting data from your source database.
108
+
1. Review the tables you selected in the **Review and deploy** section. If everything looks correct, select **Confirm & Deploy** to start ingesting data from your source database.
At this point, the data pipeline will ingest data from the source database to your target Redis database. This process will take time, especially if you have a lot of records in your source database.
Select a tab to learn how to create the required secret.
233
+
234
+
{{< multitabs id="rdi-cloud-secrets"
235
+
tab1="Credentials secret"
236
+
tab2="CA Certificate secret"
237
+
tab3="Client certificate secret"
238
+
tab4="Client key secret"
239
+
tab5="Client key passphrase secret" >}}
220
240
221
241
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following settings:
222
242
223
243
- **Key/value pairs**: Enter the following key/value pairs.
224
244
225
245
- `username`: Database username
226
246
- `password`: Database password
227
-
- `trust_certificate`: Server certificate in PEM format *(TLS only)*
228
-
- `client_public_key`: [X.509 client certificate](https://en.wikipedia.org/wiki/X.509) or chain in PEM format *(mTLS only)*
229
-
- `client_private_key`: Key for the client certificate or chain in PEM format *(mTLS only)*
230
-
- `client_private_key_passphrase`: Passphrase or password for the client certificate or chain in PEM format *(mTLS only)*
231
-
232
-
{{<note>}}
233
-
If your source database has TLS or mTLS enabled, we recommend that you enter the `trust_certificate`, `client_public_key`, and `client_private_key` into the secret editor using the **Key/Value** input method instead of the **JSON** input method. Pasting directly into the JSON editor may cause an error.
234
-
{{</note>}}
235
-
236
-
- **Encryption key**: Select the [encryption key](#create-encryption-key) you created earlier.
237
-
238
-
- **Resource permissions**: Add the following permissions to your secret to allow the Redis data pipeline to access your secret. Replace `<AWS ACCOUNT ID>` with the AWS account ID for the Redis Cloud cluster that you saved earlier.
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following settings:
253
+
254
+
- **Key/value pairs**: Select **Plaintext** and enter the server certificate.
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following settings:
261
+
262
+
- **Key/value pairs**: Select **Plaintext** and enter the client certificate.
Use the [AWS CLI create-secret command](https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/create-secret.html) or the [AWS CreateSecret API endpoint](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html) to create a binary secret containing the client key.
269
+
270
+
For example, using the AWS CLI, run the following command:
271
+
272
+
```sh
273
+
aws secretsmanager create-secret \
274
+
--name <secret-name> \
275
+
--secret-binary fileb://<path-to-client-key> \
276
+
--kms-key-id <encryption-key-arn>
277
+
```
278
+
279
+
Where:
280
+
- `<secret-name>` - Name of the secret
281
+
- `<path-to-client-key>` - Path to the client key file
282
+
- `<encryption-key-arn>` - ARN of the [encryption key](#create-encryption-key) you created earlier
283
+
284
+
After you create the secret, you need to add permissions to allow the data pipeline to access it.
285
+
286
+
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. Select the private key secret you just created and then select **Edit permissions**.
287
+
288
+
Add the following permissions to your secret:
289
+
290
+
{{< embed-md "rc-rdi-secrets-permissions.md" >}}
291
+
292
+
Replace `<AWS ACCOUNT ID>` with the AWS account ID for the Redis Cloud cluster that you saved earlier.
293
+
294
+
--tab-sep--
295
+
296
+
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following settings:
297
+
298
+
- **Key/value pairs**: Select **Plaintext** and enter the client key passphrase.
After you store this secret, you can view and copy the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources) of your secret on the secret details page.
You can select any number of columns from a table.
57
60
58
-
{{<imagefilename="images/rc/rdi/rdi-select-columns.png"alt="The select source data section. A table is expanded with a few columns selected."width=75% >}}
61
+
{{<imagefilename="images/rc/rdi/rdi-select-columns.png"alt="The manage columns screen, with a few columns selected from one table"width=75% >}}
59
62
60
-
If any tables are missing a unique constraint, the **Missing unique constraint**list will appear. Select the columns that define a unique constraint for those tables from the list.
63
+
If any tables are missing a unique constraint, a warning will appear in the **Data modeling**section. Select **Manage columns** to select the columns that define a unique constraint for those tables.
1. In the **Pipeline definition** section, select the Redis data type to write keys to the target. You can choose **Hash** or **JSON** if the target database supports JSON.
88
+
You can also supply one or more [transformation job files]({{< relref "/integrate/redis-data-integration/data-pipelines/transform-examples" >}}) that specify how you want to transform the captured data before writing it to the target. Select **Upload jobs** to upload your job files.
89
+
90
+
{{<imagefilename="images/rc/rdi/rdi-transformation-jobs.png"alt="The transformation jobs section. Select Upload jobs to upload transformation jobs." >}}
91
+
92
+
When you upload job files, Redis Cloud will validate the job files to check for errors.
79
93
80
-
{{<imagefilename="images/rc/rdi/rdi-configure-new-pipeline.png"alt="The Pipeline definition screen. Configure a new pipeline is selected."width=75% >}}
0 commit comments