Skip to content

Commit 291e223

Browse files
DOC-4367 improvements to other pages and new links
1 parent 1beeb1a commit 291e223

File tree

5 files changed

+70
-20
lines changed

5 files changed

+70
-20
lines changed

content/integrate/redis-data-integration/architecture.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,14 +136,28 @@ traffic. The diagram below shows this configuration:
136136

137137
{{< image filename="images/rdi/ingest/ingest-active-passive-vms.png" >}}
138138

139+
See [Install on VMs]({{< relref "/integrate/redis-data-integration/installation/install-vm" >}})
140+
for more information.
141+
139142
### RDI on Kubernetes
140143

141-
You can run RDI in a namespace on your own Kubernetes cluster with
142-
a separate deployment for each of the control plane
143-
components (REST API, operator, and metrics exporter). The operator
144-
creates and configures deployments for the collector and stream processor
145-
when you start a pipeline from the CLI tool. This means that you must
146-
provide the operator with a service account that has permissions to create and manipulate pods in the namespace.
144+
You can use the RDI [Helm chart](https://helm.sh/docs/topics/charts/) to install
145+
on [Kubernetes (K8s)](https://kubernetes.io/). This creates:
146+
147+
- A K8s [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) named `rdi`.
148+
- [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) for the
149+
[RDI operator]({{< relref "/integrate/redis-data-integration/architecture#how-rdi-is-deployed" >}}),
150+
[metrics exporter]({{< relref "/integrate/redis-data-integration/observability" >}}), and API server.
151+
- A [service account](https://kubernetes.io/docs/concepts/security/service-accounts/) along with a
152+
[role](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#restrictions-on-role-creation-or-update)
153+
and [role binding](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) for the RDI operator.
154+
- A [Configmap](https://kubernetes.io/docs/concepts/configuration/configmap/)
155+
for the different components with RDI Redis database details.
156+
- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
157+
with the RDI Redis database credentials and TLS certificates.
158+
159+
See [Install on Kubernetes]({{< relref "/integrate/redis-data-integration/installation/install-k8s" >}})
160+
for more information.
147161

148162
### Secrets and security considerations
149163

content/integrate/redis-data-integration/data-pipelines/deploy.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,17 @@ secrets are only relevant to TLS/mTLS connections.
5858

5959
If you are hosting RDI on your own VMs, you can use the
6060
[`deploy`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-deploy" >}})
61-
command to deploy a configuration, including the jobs, once you have created them.
61+
command to deploy a configuration, including the jobs, once you have created them:
6262

63-
If your RDI CLI is deployed as a pod in a Kubernetes cluster, you should perform the following
64-
steps to deploy a pipeline:
63+
```bash
64+
redis-di deploy --dir <path to pipeline folder>
65+
```
66+
67+
You can also deploy a pipeline using [Redis Insight]({{< relref "/develop/connect/insight/rdi-connector" >}}).
68+
69+
If your RDI CLI is deployed as a pod in a
70+
[Kubernetes cluster]({{< relref "/integrate/redis-data-integration/installation/install-k8s" >}}),
71+
you should perform the following steps to deploy a pipeline:
6572

6673
- Create a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) from the
6774
YAML files in your `jobs` folder:
@@ -93,4 +100,4 @@ You have two options to update the ConfigMap:
93100
kubectl create configmap redis-di-jobs --from-file=jobs/ --dry-run=client -o yaml | kubectl apply -f -
94101
```
95102

96-
{{< note >}} You must run `kubectl exec -it pod/redis-di-cli -- redis-di deploy` after updating the ConfigMap with either option.{{< /note >}}
103+
{{< note >}} You must run `kubectl exec -it pod/redis-di-cli -- redis-di deploy` after updating the ConfigMap with either option.{{< /note >}}

content/integrate/redis-data-integration/installation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ linkTitle: Installation
1414
summary: Redis Data Integration keeps Redis in sync with the primary database in near
1515
real time.
1616
type: integration
17-
weight: 1
17+
weight: 2
1818
---
1919

2020
The guides in this section explain the options you have for installing RDI.

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

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ The installation creates the following K8s objects:
2828
[metrics exporter]({{< relref "/integrate/redis-data-integration/observability" >}}), and API server.
2929
- A [service account](https://kubernetes.io/docs/concepts/security/service-accounts/) along with a
3030
[role](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#restrictions-on-role-creation-or-update)
31-
and [role binding](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) for the RDI operator
31+
and [role binding](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) for the RDI operator.
3232
- A [Configmap](https://kubernetes.io/docs/concepts/configuration/configmap/)
33-
for the different components with RDI Redis database details
33+
for the different components with RDI Redis database details.
3434
- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
35-
with the RDI Redis database credentials and TLS certificates
35+
with the RDI Redis database credentials and TLS certificates.
3636

3737
You can use this installation on [OpenShift](https://docs.openshift.com/) and other K8s distributions
3838
including cloud providers' K8s managed clusters.
@@ -51,10 +51,26 @@ Complete the following steps before running Helm:
5151
more information).
5252
- Download the RDI helm chart tar file from the [download center](https://cloud.redis.io/#/rlec-downloads).
5353

54+
### Create the RDI database
55+
56+
RDI uses a database on your Redis Enterprise cluster to store its state
57+
information. *This requires Redis Enterprise v6.4 or greater*.
58+
59+
Before installing RDI:
60+
61+
- Use the Redis console to create a database with 250MB RAM with 1 primary and 1 replica.
62+
- If you are deploying RDI for a production environment then secure this database with a password
63+
and [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security).
64+
65+
You should then provide the details of this database in [the `values.yaml` file](#the-valuesyaml-file),
66+
as described below.
67+
5468
### Using a private image registry
5569

5670
Add the RDI images from [Docker Hub](https://hub.docker.com/) to your local registry.
57-
The example below shows how to specify the registry and image pull secret in `values.yaml`:
71+
The example below shows how to specify the registry and image pull secret in the
72+
[`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-values) file for the
73+
Helm chart:
5874

5975
```yaml
6076
global:
@@ -85,14 +101,24 @@ To pull images from a local registry, you must provide the image pull secret and
85101
tar -xvf rdi-k8s-<rdi-tag>.tar.gz
86102
```
87103

88-
1. Open the `values.yaml` file and set the appropriate values (see list of values below).
104+
1. Open the `values.yaml` file and set the appropriate values for your installation
105+
(see [The `values.yaml` file](#the-valuesyaml-file) below for the full set of
106+
available values).
89107

90108
1. Start the installation:
91109

92110
```bash
93111
helm install <The logical chart name> rdi-k8s/<rdi-tag>/helm
94112
```
95113

114+
### The `values.yaml` file
115+
116+
The annotated `values.yaml` file below describes the values you can set
117+
for the RDI Helm installation:
118+
119+
```yaml
120+
```
121+
96122
## Check the installation
97123

98124
To verify the status of the K8s deployment, run the following command:
@@ -101,8 +127,7 @@ To verify the status of the K8s deployment, run the following command:
101127
helm list -n monitoring -n rdi
102128
```
103129

104-
The output looks like the following. Check that `<logical_chart_name>` has
105-
the value `IDT` in the `STATUS` column.
130+
The output looks like the following. Check that `<logical_chart_name>` is listed.
106131

107132
```
108133
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ and is already set up for the RDI collector to use.
4444
### Install RDI
4545

4646
Install RDI using the instructions in the
47-
[installation guide]({{< relref "/integrate/redis-data-integration/installation" >}})
47+
[VM installation guide]({{< relref "/integrate/redis-data-integration/installation/install-vm" >}}).
4848

4949
RDI will create the pipeline template for your chosen source database type at
5050
`/opt/rdi/config`. You will need this pathname later when you prepare the pipeline for deployment
@@ -112,7 +112,8 @@ contexts.
112112

113113
### Deploy the pipeline
114114

115-
You can use Redis Insight to deploy the pipeline by adding a connection to the RDI API
115+
You can use [Redis Insight]({{< relref "/develop/connect/insight/rdi-connector" >}})
116+
to deploy the pipeline by adding a connection to the RDI API
116117
endpoint (which has the same IP address as your RDI VM and uses port 8083) and then clicking the **Deploy** button. You can also deploy it with the following command:
117118

118119
```bash
@@ -127,6 +128,9 @@ validates your pipeline and then deploys it if the configuration is correct.
127128
Once the pipeline is running, you can use Redis Insight to view the data flow using the
128129
pipeline metrics. You can also connect to your target database to see the keys that RDI has written there.
129130

131+
See [Deploy a pipeline]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}})
132+
for more information about deployment settings.
133+
130134
### View RDI's response to data changes
131135

132136
Once the pipeline has loaded a *snapshot* of all the existing data from the source,

0 commit comments

Comments
 (0)