Skip to content

Commit 99acfbf

Browse files
authored
Merge pull request #2558 from redis/DOC-6043
Q4 Rebrand: Update RDI screenshots
2 parents 4c88900 + ac33582 commit 99acfbf

32 files changed

+24
-15
lines changed

content/operate/rc/databases/rdi/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Before you can create a data pipeline, you must have:
7575
Please be aware of the following limitations:
7676

7777
- The target database must be a Redis Cloud Pro database hosted on Amazon Web Services (AWS). Redis Cloud Essentials databases and databases hosted on Google Cloud do not support Data Integration.
78-
- The target database must use multi-zone [high availability]({{< relref "/operate/rc/databases/configuration/high-availability" >}}).
78+
- The target database must use [high availability]({{< relref "/operate/rc/databases/configuration/high-availability" >}}). It can use either single-zone or multi-zone high availability.
7979
- The target database can use TLS, but can not use mutual TLS.
8080
- The target database cannot be in the same subscription as another database that has a data pipeline.
8181
- Source databases must also be hosted on AWS.

content/operate/rc/databases/rdi/define.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ After you have [prepared your source database]({{<relref "/operate/rc/databases/
3636
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.
3737
{{<image filename="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." >}}
3838
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.
39+
1. Select **Advanced properties** to configure additional optional properties for your pipeline.
40+
{{<image filename="images/rc/rdi/rdi-advanced-properties.png" alt="The advanced properties section." >}}
41+
You can add any [Debezium source property](https://debezium.io/documentation/reference/stable/connectors/) for your source database type in the **Collector source properties** section and any [Redis server Debezium sink property](https://debezium.io/documentation/reference/stable/operations/debezium-server.html#_redis_stream) in the **Collector sink properties** section.
3942
1. Select **Start pipeline setup**.
4043
{{<image filename="images/rc/rdi/rdi-start-pipeline-setup.png" alt="The start pipeline setup button." width=200px >}}
4144
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).
@@ -73,10 +76,6 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
7376

7477
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.
7578

76-
{{<image filename="images/rc/rdi/rdi-missing-unique-constraint.png" alt="The missing unique constraint list." width=75% >}}
77-
78-
{{<image filename="images/rc/rdi/rdi-select-constraints.png" alt="The missing unique constraint list with columns selected." width=75% >}}
79-
8079
Select **Save** to save your column changes and go back to schema selection.
8180

8281
{{<image filename="images/rc/button-save.png" alt="The save button." width=100px >}}
@@ -93,8 +92,8 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
9392

9493
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
9594

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.
97-
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The pipeline definition screen." width=75% >}}
95+
1. Select the Redis data type to write keys to the target. You can choose **Hash key** or **JSON key** if the target database supports JSON.
96+
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The data modeling section, with Hash Key selected." width=75% >}}
9897

9998
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.
10099

@@ -105,6 +104,13 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
105104
Select **Continue**.
106105
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
107106

107+
1. In the **Advanced properties** section, you can add any processor properties to control how the data is processed. See the [RDI configuration file reference]({{< relref "/integrate/redis-data-integration/reference/config-yaml-reference#processors" >}}) for all available processor properties.
108+
109+
{{<image filename="images/rc/rdi/rdi-processor-properties.png" alt="The advanced properties section with processor properties." >}}
110+
111+
Select **Continue**.
112+
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
113+
108114
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.
109115

110116
{{<image filename="images/rc/rdi/rdi-confirm-deploy.png" alt="The Confirm & Deploy button." width=175px >}}

content/operate/rc/databases/rdi/view-edit.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ The **Status** table shows statistics for the whole data pipeline:
2020
- **Status**: The status of the data pipeline. Possible statuses include:
2121
| Status | Description |
2222
|--------|-------------|
23-
| {{<image filename="images/rc/rdi/pipeline-status-initial-sync.png#no-click" height=30px alt="Initial Sync" class="inline" >}} | The data pipeline is ingesting all records from the source database into the target database. |
24-
| {{<image filename="images/rc/rdi/pipeline-status-streaming.png#no-click" height=30px alt="Streaming" class="inline" >}} | The data pipeline is capturing new changes from the source database as they happen. Changes in the source database are added to the target database within a few seconds. |
25-
| {{<image filename="images/rc/rdi/pipeline-status-stopped.png#no-click" height=30px alt="Stopped" class="inline" >}}| The data pipeline has been [stopped](#stop-and-restart-data-pipeline). |
26-
| {{<image filename="images/rc/rdi/pipeline-status-error.png#no-click" height=30px alt="Error" class="inline" >}} | There is an error in the data pipeline. [Reset the pipeline](#reset-data-pipeline) and contact support if the issue persists. |
23+
| **Initial Sync** | The data pipeline is ingesting all records from the source database into the target database. |
24+
| **Streaming** | The data pipeline is capturing new changes from the source database as they happen. Changes in the source database are added to the target database within a few seconds. |
25+
| **Stopped**| The data pipeline has been [stopped](#stop-and-restart-data-pipeline). |
26+
| **Error** | There is an error in the data pipeline. [Reset the pipeline](#reset-data-pipeline) and contact support if the issue persists. |
2727
- **Total ingested**: Total number of records ingested from the source database.
2828
- **Total inserted**: Total number of records inserted into the target database.
2929
- **Total filtered**: Total number of records filtered from being inserted into the target database.
@@ -62,10 +62,6 @@ To change the data you want to ingest from the data pipeline:
6262

6363
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.
6464

65-
{{<image filename="images/rc/rdi/rdi-missing-unique-constraint.png" alt="The missing unique constraint list." width=75% >}}
66-
67-
{{<image filename="images/rc/rdi/rdi-select-constraints.png" alt="The missing unique constraint list with columns selected." width=75% >}}
68-
6965
Select **Save** to save your column changes and go back to schema selection.
7066

7167
{{<image filename="images/rc/button-save.png" alt="The save button." width=100px >}}
@@ -94,6 +90,13 @@ To change the data you want to ingest from the data pipeline:
9490
Select **Continue**.
9591
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
9692

93+
1. In the **Advanced properties** section, you can add any processor properties to control how the data is processed. See the [RDI configuration file reference]({{< relref "/integrate/redis-data-integration/reference/config-yaml-reference#processors" >}}) for all available processor properties.
94+
95+
{{<image filename="images/rc/rdi/rdi-processor-properties.png" alt="The advanced properties section with processor properties." >}}
96+
97+
Select **Continue**.
98+
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
99+
97100
1. Review the tables you selected in and select how you want to update the data pipeline:
98101

99102
{{<image filename="images/rc/rdi/rdi-update-preferences.png" alt="The Select update preferences section." width=25% >}}

static/images/rc/button-save.png

762 Bytes
Loading
44 Bytes
Loading
36.8 KB
Loading
-9 Bytes
Loading
4 Bytes
Loading
-22 Bytes
Loading
55 Bytes
Loading

0 commit comments

Comments
 (0)