Skip to content

Commit

Permalink
DOC-3836 fixed broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
andy-stark-redis committed May 28, 2024
1 parent 8db66bd commit c198a87
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ These metrics are divided into 3 groups:

RDI reports metrics during the two main phases of the ingest pipeline, the *snapshot*
phase and the *change data capture (CDC)* phase. (See the
[ingest pipeline lifecycle]({{< relref "/integrate/redis-data-integration/ingest/data-transformation/data-pipelines" >}})
[ingest pipeline lifecycle]({{< relref "/integrate/redis-data-integration/ingest/data-pipelines/data-pipelines" >}})
docs for more information). The table below shows the full set of metrics that
RDI reports.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ replica if you want (this will double the RAM requirements to 250MB).
During the installation, RDI asked you for a folder path to place the pipeline templates.
If you go to that folder and run the `ll` command, you will see the pipeline
configuration file, `config.yaml`, and the `jobs` folder (see the page about
[Pipelines]({{< relref "/integrate/redis-data-integration/ingest/data-transformation/data-pipelines" >}}) for more information). Use Redis Insight to open
[Pipelines]({{< relref "/integrate/redis-data-integration/ingest/data-pipelines/data-pipelines" >}}) for more information). Use Redis Insight to open
the `config.yaml` file and then edit the following settings:

- Set the `host` to `localhost` and the `port` to 5432.
Expand Down Expand Up @@ -144,7 +144,7 @@ Once the pipeline has loaded a *snapshot* of all the existing data from the sour
it enters *change data capture (CDC)* mode (see the
[architecture overview]({{< relref "/integrate/redis-data-integration/ingest/architecture#overview" >}})
and the
[ingest pipeline lifecycle]({{< relref "/integrate/redis-data-integration/ingest/data-transformation/data-pipelines#ingest-pipeline-lifecycle" >}})
[ingest pipeline lifecycle]({{< relref "/integrate/redis-data-integration/ingest/data-pipelines/data-pipelines#ingest-pipeline-lifecycle" >}})
for more information
).
To see the RDI pipeline working in CDC mode, open the PostgreSQL tool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ RDI write-behind allows integration between Redis Enterprise (as the source of c
RDI captures the changes to a selected set of key patterns in a Redis keyspace and asynchronously writes them in small batches to the downstream database, so the application doesn't need to take care of remodeling the data or managing the connection with the downstream database.

RDI write-behind can normalize a key in Redis to several records in one or more tables at the target.
To learn more about write-behind declarative jobs and normalization, see the [write-behind quick start guide]({{<relref "/integrate/redis-data-integration/quickstart/write-behind-guide.md">}})
To learn more about write-behind declarative jobs and normalization, see the
[write-behind quick start guide]({{< relref "/integrate/redis-data-integration/write-behind/quickstart/write-behind-guide" >}}).

### Write-behind topology

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ weight: 40
This guide shows you how to configure write-behind target connections.

## Overview
Write-behind target connections are the connections established between an RDI instance and a target database in a [write-behind scenario]({{<relref "/integrate/redis-data-integration/quickstart/write-behind-guide">}}). Write-behind is used to replicate changes captured in an RDI-enabled Redis Enterprise database to a target database.
Write-behind target connections are the connections established between an RDI instance and a target database in a
[write-behind scenario]({{< relref "/integrate/redis-data-integration/write-behind/quickstart/write-behind-guide" >}}).
Write-behind is used to replicate changes captured in an RDI-enabled Redis Enterprise database to a target database.
The connections must be configured in the `config.yaml` before deploying any jobs and must follow one of the formats shown below. Multiple connections can be specified in the `connections` section.

### For relational datastores
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ Throughout this document, the snippets make use of the Kubernetes `kubectl` tool
## Prerequisites

- An existing Redis Enterprise cluster version >= {{<param rdi_rlec_min_version>}}
- [RedisGears](https://redis.com/modules/redis-gears/) {{<param rdi_redis_gears_version>}} installed on the cluster. In case it's missing, see [Install RedisGears for Redis Data Integration]({{<relref "/integrate/redis-data-integration/installation/install-redis-gears.md">}}) to install.
- [RedisGears](https://redis.com/modules/redis-gears/) {{<param rdi_redis_gears_version>}} installed on the cluster.
In case it's missing, see
[Install RedisGears for Redis Data Integration]({{< relref "/integrate/redis-data-integration/write-behind/installation/install-redis-gears">}})
to install.
- A target Redis DB (can be added after installation).

> Note: The version of RedisGears you will install must match the base OS of the Redis Enterprise containers. In case of [Rancher](https://www.rancher.com/), the Redis Enterprise container base OS is Ubuntu 18.04. Use the following command to install RedisGears:
Expand Down Expand Up @@ -56,9 +59,9 @@ curl -k -v -u "user:pwd" https://localhost:9443/v1/modules | jq '.[] | {module_n

There are two options for installing the RDI CLI in an Kubernetes environment:

- Install [RDI CLI]({{<relref "/integrate/redis-data-integration/installation/install-rdi-cli.md">}}) locally
- Install [RDI CLI]({{< relref "/integrate/redis-data-integration/write-behind/installation/install-rdi-cli" >}}) locally

- [Install RDI CLI as a pod in Kubernetes cluster](#install-rdi-cli-on-kubernetes-cluster)
- [Install RDI CLI as a pod in Kubernetes cluster](#install-the-rdi-cli-on-the-kubernetes-cluster)

## Create a new RDI database

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ type: integration
weight: 10
---

The following installation instructions install the RDI CLI on a local workstation. For installing in Kubernetes (K8s) or OpenShift please see [k8s installation]({{<relref "/integrate/redis-data-integration/installation/install-k8s">}}).
The following installation instructions install the RDI CLI on a local workstation. For installing in Kubernetes (K8s) or OpenShift please see
[k8s installation]({{< relref "/integrate/redis-data-integration/write-behind/installation/install-k8s" >}}).

RDI installation is done via the RDI CLI. The CLI should have network access to the Redis Enterprise cluster API (port 9443 by default).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,12 @@ RDI write-behind currently supports these target data stores:
## Prerequisites

The only prerequisite for running RDI write-behind is [Redis Gears Python](https://redis.com/modules/redis-gears/) >= 1.2.6 installed on the Redis Enterprise Cluster and enabled for the database you want to mirror to the downstream data store.
For more information, see [RedisGears installation]({{<relref "/integrate/redis-data-integration/installation/install-redis-gears">}}).
For more information, see
[RedisGears installation]({{< relref "/integrate/redis-data-integration/write-behind/installation/install-redis-gears" >}}).

## Preparing the write-behind pipeline

- Install [RDI CLI]({{<relref "/integrate/redis-data-integration/installation/install-rdi-cli">}}) on a Linux host that has connectivity to your Redis Enterprise Cluster.
- Install [RDI CLI]({{< relref "/integrate/redis-data-integration/write-behind/installation/install-rdi-cli" >}}) on a Linux host that has connectivity to your Redis Enterprise Cluster.
- Run the [`configure`]({{<relref "/integrate/redis-data-integration/reference/cli/redis-di-configure">}}) command to install the RDI Engine on your Redis database, if you have not used this Redis database with RDI write-behind before.
- Run the [`scaffold`]({{<relref "/integrate/redis-data-integration/reference/cli/redis-di-scaffold">}}) command with the type of data store you want to use, for example:

Expand Down Expand Up @@ -250,4 +251,4 @@ If you need to upgrade RDI, you should use the [`upgrade`]({{<relref "/integrate
redis-di upgrade ...
```

See the [Upgrade guide]({{<relref "/integrate/redis-data-integration/upgrade">}}) for more information.
See the [Upgrade guide]({{< relref "/integrate/redis-data-integration/write-behind/upgrade" >}}) for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The following problems can occur when running the `create` command:
When running Redis Enterprise on Kubernetes, each Redis database has a service that is created only after the database has been created. To connect with the CLI from outside of Kubernetes and configure the RDI database, you need an `Ingress` resource for your RDI database and `Ingress Controller` running on the Kubernetes cluster.

A Kubernetes `Service` and `Ingress` are mutually exclusive. So if your database has a `Service` you should remove it and add an `Ingress` resource. Read [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/) for more information.
Alternatively, run the CLI within the Kubernetes cluster as described in [Running on Kubernetes]({{<relref "/integrate/redis-data-integration/installation/install-k8s">}}).
Alternatively, run the CLI within the Kubernetes cluster as described in [Running on Kubernetes]({{<relref "/integrate/redis-data-integration/write-behind/installation/install-k8s">}}).

## Problems running Debezium

Expand Down

0 comments on commit c198a87

Please sign in to comment.