Skip to content

RDSC-4603 Update RDI public documentation#3262

Open
stoyanr wants to merge 11 commits intoredis:mainfrom
stoyanr:RDSC-4603-update-rdi-docs
Open

RDSC-4603 Update RDI public documentation#3262
stoyanr wants to merge 11 commits intoredis:mainfrom
stoyanr:RDSC-4603-update-rdi-docs

Conversation

@stoyanr
Copy link
Copy Markdown
Contributor

@stoyanr stoyanr commented May 5, 2026

See https://redislabs.atlassian.net/browse/RDSC-4603 and https://github.com/RedisLabs/redis-data-integration/pull/2565


Note

Low Risk
Low risk: documentation-only changes, though broad updates could cause user confusion if any details or links are incorrect.

Overview
Adds extensive public docs for the new Flink stream processor alongside the existing classic processor, including a new architecture comparison page and a step-by-step migration guide.

Updates pipeline configuration and reference docs to expose processors.type (classic/flink), clarify which settings are classic-only vs. Flink-only (including processors.advanced), and document Flink-only features like expression/lookup caching and redis.lookup batching.

Refreshes install/upgrade/FAQ/observability guidance to cover Flink-specific images, Helm-level sizing knobs, and the new metrics model (Flink JobManager/TaskManager metrics vs. rdi-metrics-exporter), plus small clarifications and formatting cleanups across examples.

Reviewed by Cursor Bugbot for commit e26eb81. Bugbot is set up for automated code reviews on this repo. Configure here.

@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented May 5, 2026

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

@stoyanr stoyanr marked this pull request as draft May 5, 2026 13:23
@stoyanr stoyanr marked this pull request as ready for review May 5, 2026 14:57
Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of minor suggestions but otherwise LGTM.

Comment thread content/integrate/redis-data-integration/data-pipelines/pipeline-config.md Outdated
Comment thread content/integrate/redis-data-integration/installation/upgrade.md Outdated

## Step 5: Update observability

The Flink processor does not use `rdi-metrics-exporter`. It exposes
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Flink processor does not use `rdi-metrics-exporter`. It exposes
The Flink processor does not use `rdi-metrics-exporter` component. It exposes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the docs to talk about "rdi-metrics-exporter service" everywhere consistently. This particular reference here I dropped as it was not needed.


The classic processor silently ignores `processors.advanced`, so keeping
both top-level properties and their `processors.advanced` equivalents lets
you switch back without further edits.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
you switch back without further edits.
you switch back without further edits. Likewise, the Flink processor silently ignores the settings that only apply under classic.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I proposed a slightly different sentence, hopefully still ok.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants