Skip to content

Commit 4d06f74

Browse files
committed
Merge branch 'main' into release-rs-aug
2 parents b58e762 + 0fad283 commit 4d06f74

File tree

17 files changed

+149
-16
lines changed

17 files changed

+149
-16
lines changed

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,6 @@ configuration contains the following data:
172172
Quarkus [Configuration options](https://quarkus.io/guides/all-config)
173173
docs for the full set of available properties.
174174

175-
176-
177175
### Targets
178176

179177
Use this section to provide the connection details for the target Redis
@@ -184,6 +182,18 @@ with a unique name that you are free to choose (here, we have used
184182
`host` and `port` of the server. You can also supply connection credentials
185183
and TLS/mTLS secrets here if you use them.
186184

185+
{{< note >}}If you specify `localhost` as the address of either the source or target server during
186+
installation then the connection will fail if the actual IP address changes for the local
187+
VM. For this reason, we recommend that you don't use `localhost` for the address. However,
188+
if you do encounter this problem, you can fix it using the following commands on the VM
189+
that is running RDI itself:
190+
191+
```bash
192+
sudo k3s kubectl delete nodes --all
193+
sudo service k3s restart
194+
```
195+
{{< /note >}}
196+
187197
## Job files
188198

189199
You can optionally supply one or more job files that specify how you want to

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ Follow the steps below for each of your VMs:
147147
RDI uses a database on your Redis Enterprise cluster to store its state
148148
information. *This requires Redis Enterprise v6.4 or greater*.
149149

150-
The installer will ask you for cluster admin credentials. You should supply
150+
The installer gives you instructions to help you create secrets and create your pipeline.
151+
It will ask you for cluster admin credentials during installation. You should supply
151152
these if you want the installer to create the RDI database for you.
152153

153154
{{<note>}}The installer does not create the RDI Redis database with
@@ -163,9 +164,19 @@ If you don’t want the installation to create the RDI database for you:
163164
and TLS.
164165
- Provide the installation with the required RDI database details.
165166

166-
Once the installation is finished, RDI is ready for use.
167+
{{< note >}}If you specify `localhost` as the address of the RDI database server during
168+
installation then the connection will fail if the actual IP address changes for the local
169+
VM. For this reason, we recommend that you don't use `localhost` for the address. However,
170+
if you do encounter this problem, you can fix it using the following commands on the VM
171+
that is running RDI itself:
167172
168-
{{<note>}}RDI gives you instructions to help you create secrets and create your pipeline.{{</note>}}
173+
```bash
174+
sudo k3s kubectl delete nodes --all
175+
sudo service k3s restart
176+
```
177+
{{< /note >}}
178+
179+
After the installation is finished, RDI is ready for use.
169180
170181
## "Silent" installation
171182

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

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,44 @@ the `config.yaml` file and then edit the following settings:
7272

7373
At this point, the pipeline is ready to deploy.
7474

75+
### Create a context (optional) {#create-context}
76+
77+
To manage and inspect RDI, you can use the
78+
[`redis-di`]({{< relref "/integrate/redis-data-integration/ingest/reference/cli" >}})
79+
CLI command, which has several subcommands for different purposes. Most of these commands require you
80+
to pass at least two options, `--rdi-host` and `--rdi-port`, to specify the host and port of your
81+
RDI installation. You can avoid typing these options repeatedly by saving the
82+
information in a *context*.
83+
84+
When you activate a context, the saved values of
85+
`--rdi-host`, `--rdi-port`, and a few other options are passed automatically whenever
86+
you use `redis-di`. If you have more than one RDI installation, you can create a context
87+
for each of them and select the one you want to be active using its unique name.
88+
89+
To create a context, use the
90+
[`redis-di add-context`]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-add-context" >}})
91+
command:
92+
93+
```bash
94+
redis-di add-context --rdi-host <host> --rdi-port <port> --cluster-host <Redis DB host> --cluster-api-port <Redis DB API port> --cluster-user <Redis DB username> <unique-context-name>
95+
```
96+
97+
These options are required but there are also a few others you can save, such as TLS credentials, if
98+
you are using them (see the
99+
[reference page]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-add-context" >}})
100+
for details). When you have created a context, use
101+
[`redis-di set-context`]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-set-context" >}})
102+
to activate it:
103+
104+
```bash
105+
redis-di set-context <context name>
106+
```
107+
108+
There are also subcommands to
109+
[list]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-list-contexts" >}})
110+
and [delete]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-delete-context" >}})
111+
contexts.
112+
75113
### Deploy the pipeline
76114

77115
You can use Redis Insight to deploy the pipeline by adding a connection to the RDI API
@@ -81,13 +119,15 @@ endpoint (which has the same IP address as your RDI VM and uses port 8083) and t
81119
redis-di deploy --dir <path to pipeline folder>
82120
```
83121

84-
where the path is the one you supplied earlier during the installation. RDI first
122+
where the path is the one you supplied earlier during the installation. (You may also need
123+
to supply `--rdi-host` and `--rdi-port` options if you are not using a
124+
[context](#create-context) as described above.) RDI first
85125
validates your pipeline and then deploys it if the configuration is correct.
86126

87127
Once the pipeline is running, you can use Redis Insight to view the data flow using the
88128
pipeline metrics. You can also connect to your target database to see the keys that RDI has written there.
89129

90-
### View RDI's reponse to data changes
130+
### View RDI's response to data changes
91131

92132
Once the pipeline has loaded a *snapshot* of all the existing data from the source,
93133
it enters *change data capture (CDC)* mode (see the

content/operate/kubernetes/recommendations/persistent-volumes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ spec should include a *persistentSpec* section, in the
3333
Persistence storage is a requirement for production deployments.
3434

3535
{{< note >}}
36-
For **production deployments** of Redis Enterprise Cluster on Kubenetes,
36+
For **production deployments** of Redis Enterprise Cluster on Kubernetes,
3737
the Redis Enterprise Cluster (REC) must be deployed with persistence enabled.
3838
The REC deployment files in the [Kubernetes documentation](https://github.com/RedisLabs/redis-enterprise-k8s-docs) contain this declaration by default.
3939
{{< /note >}}
@@ -53,7 +53,7 @@ Persistent volume claims can be expanded, but not reduced after creation. See [E
5353

5454
{{< note >}}
5555
We recommend that you omit the volumeSize definition from the REC declaration
56-
so that the Redis Enterprise Cluster deployment on Kubenetes use the default volume size.
56+
so that the Redis Enterprise Cluster deployment on Kubernetes use the default volume size.
5757
{{< /note >}}
5858

5959
## Storage class name

content/operate/kubernetes/recommendations/sizing-on-kubernetes.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ To apply the new cluster configuration run:
5050

5151
kubectl apply -f redis-enterprise-cluster.yaml
5252

53-
**Note:** Decreasing the number of nodes is not supported.
54-
53+
{{<warning>}} Decreasing the number of nodes is not supported.{{</warning>}}
5554

5655
### Sizing compute resources
5756

content/operate/rc/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ description: The fastest way to set up Redis - a fully managed Redis database on
99
hideListLinks: true
1010
weight: 10
1111
---
12-
[Redis Cloud](https://redis.io/cloud/) is a fully managed Redis database offering hosted on major public cloud services.
12+
[Redis Cloud](https://redis.io/cloud/) is a fully managed database-as-a-service that brings the speed and reliability of Redis to the cloud, offering seamless scalability and high availability for modern applications.
1313

14-
With Redis Cloud, you get all of the features of Redis Enterprise, including:
14+
With Redis Cloud, you get all of the features of Redis Software, including:
1515
- [Redis]({{< relref "/develop/" >}}) and [Redis Stack]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}) support
1616
- Linear scalability
1717
- Instant failover, backups, and recovery
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
LinkTitle: Vercel Marketplace
3+
Title: Create a Redis Cloud database with the Vercel integration.
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- operate
8+
- rc
9+
description: Shows how to create a Redis Cloud database with Vercel integration.
10+
hideListLinks: true
11+
weight: 66
12+
---
13+
14+
The [Redis Cloud Vercel integration](https://vercel.com/marketplace/redis-cloud) lets you create a new Redis database from your Vercel account and connect it to your Vercel project(s).
15+
16+
## Create database
17+
18+
1. Log in to your Vercel account (or create a new one).
19+
20+
1. Navigate to the **Storage** tab and select **Create database**.
21+
{{<image filename="/images/rc/vercel-storage-create-database-button.png" alt="Storage - Create Database">}}
22+
23+
1. Under **Storage partners**, select **View all partners**.
24+
{{<image filename="/images/rc/vercel-redis-cloud-partners.png" alt="Browse storage" width=40% >}}
25+
26+
1. Find **Redis Cloud** and select **Continue**.
27+
28+
1. In the **Create Database** dialog, select your plan and **Continue**.
29+
30+
{{<image filename="/images/rc/vercel-create-db-select-plan.png" alt="Create database">}}
31+
32+
More configuration options are coming soon, such as region selection and multi-zone high availability.
33+
34+
1. Enter your database name or use the automatically generated name.
35+
36+
1. Select **Create**.
37+
38+
## Connect to your database
39+
40+
After creation, you will see your database details. After provisioning is complete, the status will change from `Initializing` to `Available` (you may need to refresh your browser).
41+
42+
{{<image filename="/images/rc/vercel-status-available.png" alt="Vercel database details">}}
43+
44+
You can use the connection string shown under **Quickstart** to [connect to your database]({{<relref "operate/rc/databases/connect">}}).
45+
46+
## Link database to your project
47+
48+
1. Navigate to the **Storage** tab.
49+
1. Find your new database in the list of your team's databases.
50+
1. Select **Connect Project**.
51+
{{<image filename="/images/rc/vercel-connect-project-button.png" alt="Connect Project button">}}
52+
1. Choose your project and environments and select **Connect**.
53+
{{<image filename="/images/rc/vercel-connect-project.png" alt="Connect project">}}
54+
55+
## Manage your database
56+
57+
From the database details page, you can make edits to your database under **Settings**.
58+
59+
More configuration options are coming soon, including plan changes, multi-zone high availability, and region selection.
60+
61+
### Configure from Redis Cloud
62+
63+
You can also edit some configuration options in Redis Cloud.
64+
65+
From the database detail page, select **Open in Redis Cloud**.
66+
67+
{{<image filename="/images/rc/vercel-open-in-redis-cloud.png" alt="Open in Redis">}}
68+
69+
Your Redis Cloud account is linked to your Vercel account. All your team's Redis databases will be listed under **Databases** in Redis Cloud.
70+
71+
Select your new database to make configuration changes such as passwords or the eviction policy.
72+
73+
{{<note>}} The [eviction policy]({{<relref "/operate/rc/databases/configuration/data-eviction-policies">}}) defaults to `no eviction` for new databases. You can change this by [editing the database details]({{<relref "/operate/rc/databases/view-edit-database">}}).{{</note>}}

content/operate/rs/databases/configure/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ You can require [**TLS**]({{< relref "/operate/rs/security/encryption/tls/" >}})
149149

150150
- **Unauthenticated access** - You can access the database as the default user without providing credentials.
151151

152-
- **Password-only authentication** - When you configure a password for your database's default user, all connections to the database must authenticate with the [AUTH command]({{< relref "/commands/auth" >}}.
152+
- **Password-only authentication** - When you configure a password for your database's default user, all connections to the database must authenticate with the [AUTH command]({{< relref "/commands/auth" >}}).
153153

154154
If you also configure an access control list, connections can specify other users for authentication, and requests are allowed according to the Redis ACLs specified for that user.
155155

layouts/partials/tabs/wrapper.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
</div>
7373
{{ else }}
7474
<!--<a href='/docs/latest/develop/connect/clients/{{ index $tab "quickstartSlug" }}/' tabindex="1" class="rounded rounded-mx px-3 py-1 text-white text-xs-->
75-
<a href='/develop/connect/clients/{{ index $tab "quickstartSlug" }}/' tabindex="1" class="rounded rounded-mx px-3 py-1 text-white text-xs
75+
<a href='{{ absURL (print "develop/connect/clients/" (index $tab "quickstartSlug")) }}/' tabindex="1" class="rounded rounded-mx px-3 py-1 text-white text-xs
7676
hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none
7777
focus:ring-2 focus:white focus:border-slate-500" title="{{$btnQuickStartText}}">
7878
{{ index $tab "title" }} {{ $btnQuickStartText }}
2.89 KB
Loading

0 commit comments

Comments
 (0)