RDSC-4603 Update RDI public documentation#3262
Conversation
|
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. |
andy-stark-redis
left a comment
There was a problem hiding this comment.
A couple of minor suggestions but otherwise LGTM.
|
|
||
| ## Step 5: Update observability | ||
|
|
||
| The Flink processor does not use `rdi-metrics-exporter`. It exposes |
There was a problem hiding this comment.
| The Flink processor does not use `rdi-metrics-exporter`. It exposes | |
| The Flink processor does not use `rdi-metrics-exporter` component. It exposes |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
I proposed a slightly different sentence, hopefully still ok.
…ne-config.md Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
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 (includingprocessors.advanced), and document Flink-only features like expression/lookup caching andredis.lookupbatching.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.