- 
                Notifications
    
You must be signed in to change notification settings  - Fork 270
 
RC: RDI in the cloud #570
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
    
  
     Merged
                    RC: RDI in the cloud #570
Changes from 13 commits
      Commits
    
    
            Show all changes
          
          
            57 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      c4d39e6
              
                begin index and setup drafts
              
              
                kaitlynmichael d586971
              
                overview draft
              
              
                kaitlynmichael b5beb6a
              
                edit desc
              
              
                kaitlynmichael 10d5de8
              
                fix relref
              
              
                kaitlynmichael c9e5161
              
                get started, doc link
              
              
                kaitlynmichael 42fcff9
              
                prepare source database with link
              
              
                kaitlynmichael 17270d8
              
                setup connectivity
              
              
                kaitlynmichael 9e0de8e
              
                connectivity steps
              
              
                kaitlynmichael efc8b0b
              
                pane > box
              
              
                kaitlynmichael 20c3050
              
                Limitations draft
              
              
                kaitlynmichael c3b7bca
              
                Apply suggestions from code review
              
              
                cmilesb 85c6d08
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb e938762
              
                Edits and DB credentials changes
              
              
                cmilesb a5977a2
              
                Add setup step and more edits
              
              
                cmilesb 289f0e4
              
                Move last step to provision
              
              
                cmilesb 1d6fce4
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 272e518
              
                Add some of Yaron's suggestions to intro
              
              
                cmilesb 9d12553
              
                Apply suggestions from code review
              
              
                cmilesb 1551e1d
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb a32204e
              
                Add define steps
              
              
                cmilesb 07bc249
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb bc41625
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 71f431c
              
                Fix relrefs
              
              
                cmilesb e8ea310
              
                stash commit
              
              
                cmilesb 860944a
              
                Add security information
              
              
                cmilesb 639fc50
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 697d665
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb fa87f86
              
                Add View/Edit
              
              
                cmilesb 49d1f54
              
                Incorporate Yaron's feedback, part 1
              
              
                cmilesb 4abac23
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 4d69274
              
                stash commit
              
              
                cmilesb 129d6af
              
                More suggestions from Yaron
              
              
                cmilesb 99229b1
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb c3e501e
              
                Apply suggestions from code review
              
              
                cmilesb 01907d8
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb c9469e0
              
                Combine define and provision and remove errors section
              
              
                cmilesb d56188a
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb f817848
              
                Add secret permissions and keys
              
              
                cmilesb 8f274f5
              
                Update content/operate/rc/databases/rdi/define.md
              
              
                cmilesb 2d2820d
              
                Fix note
              
              
                cmilesb 46603a6
              
                replace account ID in resource permissions
              
              
                cmilesb 89e0c4f
              
                DOC-4548 Setup and define screenshots
              
              
                cmilesb 962c1e9
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 2b110b4
              
                stash commit
              
              
                cmilesb a51743b
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 35c8dc5
              
                Fix screenshot widths
              
              
                cmilesb 52412cc
              
                add edit pipeline images
              
              
                cmilesb 7ef44a2
              
                Apply suggestions from code review
              
              
                cmilesb d0bf623
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 07b45a0
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb ff2c061
              
                Added metrics
              
              
                cmilesb 79fee3a
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 40891de
              
                DOC-4674 Addressing feedback from Georgiana, Yaron, and Cornel
              
              
                cmilesb 375cf15
              
                Update content/operate/rc/databases/rdi/view-edit.md
              
              
                cmilesb c8483de
              
                Apply suggestions from code review
              
              
                cmilesb ed0a757
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb 5ff8b8b
              
                Merge branch 'main' into DOC-4137
              
              
                cmilesb File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| Title: Data Integration | ||
| alwaysopen: false | ||
| categories: | ||
| - docs | ||
| - operate | ||
| - rc | ||
| description: Use Redis Data Integration with Redis Cloud. | ||
| hideListLinks: true | ||
| weight: 99 | ||
| --- | ||
| 
     | 
||
| Redis Cloud now supports [Redis Data Integration (RDI)]({{<relref "integrate/redis-data-integration">}}), a fast and simple way to bring your data into Redis. | ||
| 
     | 
||
| A relational database usually handles queries much more slowly than a Redis database. If your application uses a relational database and makes many more reads than writes (which is the typical case) then you can improve performance by using Redis as a cache to handle the read queries quickly. Redis Cloud uses [ingest]({{<relref "/integrate/redis-data-integration/ingest/">}}) to help you offload all read queries from the application database to Redis automatically. | ||
| 
     | 
||
| RDI helps Redis customers sync Redis Cloud with live data from their primary databases to: | ||
| - Meet the required speed and scale of read queries and provide an excellent and predictable user experience. | ||
| - Save resources and time when building pipelines and coding data transformations. | ||
| - Reduce the total cost of ownership by saving money on expensive database read replicas. | ||
| 
     | 
||
| Using RDI with Redis Cloud simplifies managing your data integration pipeline. No need to worry about hardware or underlying infrastructure, as Redis Cloud manages that for you. Creating the data flow from source to target is much easier, and there are validations in place to reduce errors. | ||
| 
     | 
||
| ## Prerequisites | ||
| 
     | 
||
| Before you can create a data pipeline, you must have: | ||
| 
     | 
||
| - A [Redis Cloud Pro database]() hosted on Amazon Web Services (AWS) | ||
| - One supported source database, also hosted on AWS: | ||
| - Insert supported source DBs here. | ||
| 
     | 
||
| {{< note >}} | ||
| Please be aware of the following limitations: | ||
| 
     | 
||
| - 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. | ||
| - Only the Ingest use case is supported at this time. | ||
                
      
                  cmilesb marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| - Source databases must also be hosted on AWS. | ||
| - One source database can only be connected to one target database. | ||
                
      
                  cmilesb marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| {{< /note >}} | ||
| 
     | 
||
| ## Get started | ||
| 
     | 
||
| To create a new data pipeline, you need to: | ||
| 
     | 
||
| 1. [Prepare your source database]({{<relref "content/operate/rc/databases/rdi/setup">}}) and any associated credentials. | ||
| 2. [Provision data pipeline] | ||
| 3. [Define data pipeline] | ||
| 
     | 
||
| Once your data pipeline is defined, you can [manage]() and [observe]() it. | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| Title: Prepare source database | ||
| alwaysopen: false | ||
| categories: | ||
| - docs | ||
| - operate | ||
| - rc | ||
| description: null | ||
| hideListLinks: true | ||
| weight: 1 | ||
| --- | ||
| 
     | 
||
| 
     | 
||
| ## Create new data pipeline | ||
| 
     | 
||
| 1. In the Redis Cloud console, go to your target database and select the **Data Pipeline** tab. | ||
| 1. Select **Create data pipeline**. | ||
| 1. Select your source database type. The following database types are supported: | ||
                
      
                  cmilesb marked this conversation as resolved.
               
          
            Show resolved
            Hide resolved
         | 
||
| - Insert here | ||
| 1. If you know the size of your source database, enter it into the **Source dataset size** field. | ||
| 
     | 
||
| ## Prepare source database | ||
| 
     | 
||
| Before using the pipeline, you must first prepare your source database to use the Debezium connector for change data capture (CDC). | ||
| 
     | 
||
| See [Prepare source databases]({{<relref "/integrate/redis-data-integration/ingest/data-pipelines/prepare-dbs/">}}) to find steps for your database type. | ||
                
      
                  cmilesb marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| See the [RDI architecture overview]({{< relref "/integrate/redis-data-integration/ingest/architecture#overview" >}}) for more information about CDC. | ||
                
      
                  cmilesb marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| ## Share source database credentials | ||
                
      
                  cmilesb marked this conversation as resolved.
               
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| You need to share your source database credentials in an Amazon secret with Redis Cloud so that the pipeline can connect to your database. | ||
| 
     | 
||
| 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 key/value fields: | ||
| 
     | 
||
| - `port`: Database port | ||
| - `schema_name`: Database name or schema name | ||
| - `pdb_name`: Database name *(Oracle only)* | ||
| - `username`: Database username | ||
| - `password`: Database password | ||
| - `server_certificate`: Server certificate in PEM format *(TLS only)* | ||
| - `client_certificate`: [X.509 client certificate](https://en.wikipedia.org/wiki/X.509) or chain in PEM format *(mTLS only)* | ||
| - `client_certificate_key`: Key for the client certificate or chain in PEM format *(mTLS only)* | ||
| - `client_certificate_passphrase`: Passphrase or password for the client certificate or chain in PEM format *(mTLS only)* | ||
| 
     | 
||
| {{<note>}} | ||
| If your source database has TLS or mTLS enabled, we recommend that you enter the `server_certificate`, `client_certificate`, and `client_certificate_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. | ||
| {{</note>}} | ||
| 
     | 
||
| 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. | ||
| 
     | 
||
| ## Setup connectivity | ||
| 
     | 
||
| To expose your source database to Redis, you need to [edit your AWS PrivateLink VPC permissions](https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permissions). | ||
| 
     | 
||
| 1. Open your [Amazon VPC console]() and navigate to **Endpoint services**. | ||
| 1. Copy the Amazon Resource Name (ARN) provided in **Setup connectivity** pane. | ||
| 1. Navigate to **Allow principals** tab. | ||
| 1. Add the Redis Cloud ARN and choose **Allow principals**. | ||
| 
     | 
||
| For more details on AWS PrivateLink, see [Share your services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html). | ||
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just checking... these links are intentionally blank for now, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, I'll fix these before this goes out.