RDSC-5692 Update public docs that Flink processor is GA#3628
Conversation
|
Added the RDSC-5718 smoke-test documentation findings in commit 91cb3db: detailed wait.enabled replication prerequisites, observed failure symptoms, and no-reset recovery behavior. The branch also includes the corrected VM processor metrics URL and stale Kubernetes-only cleanup adopted in commit 0061729. |
| - operate | ||
| - rs | ||
| description: | | ||
| New Flink-based stream processor for Kubernetes deployments (Preview), with horizontal scaling, Flink checkpointing, and significantly higher throughput. |
There was a problem hiding this comment.
We should not be modifying the release notes of 1.18.0. They should remain as they are.
|
|
||
| |Name|Type|Description|Required| | ||
| |----|----|-----------|--------| | ||
| |**type**<br/>(Processor type)|`string`|Processor implementation to run. `classic` runs the classic processor; `flink` runs the Apache Flink-based processor (Kubernetes deployments only).<br/>Default: `"classic"`<br/>Enum: `"classic"`, `"flink"`<br/>|| |
There was a problem hiding this comment.
The changes to this file are OK, but I think we're modifying the file directly here, instead aren't we generating this file from redis-data-integration?
There was a problem hiding this comment.
Yes, regenerated it properly now. This pulled-in other changes as it seems it has not been regenerated for a while. All should be ok for the new release.
| [`processors.advanced` reference]({{< relref "/integrate/redis-data-integration/reference/config-yaml-reference#processors" >}}) | ||
| for the full set of available properties. | ||
|
|
||
| ### Optional replica acknowledgement |
There was a problem hiding this comment.
I think this comment must not be here in the migration guide as it has nothing to do with the migration. It's the same with the old and the new processor.
There was a problem hiding this comment.
The PR got corrupted somehow while adopting the changes from your PR. Now this section is no longer there.
91cb3db to
0061729
Compare
See https://redislabs.atlassian.net/browse/RDSC-5692
Note
Low Risk
Markdown-only documentation changes with no runtime or config enforcement; risk is limited to readers acting on outdated guidance if anything was missed.
Overview
Updates RDI public docs so the Flink stream processor is described as generally available (RDI 1.19.0) for production on VMs and Kubernetes, not Preview/Kubernetes-only.
Positioning and guidance: The FAQ now recommends Flink for new and migrated pipelines (classic remains default and supported), and embed/when-to-use notes drop Preview wording while still noting Flink roughly doubles throughput limits.
Capability parity: Docs remove prior limits that Flink only supported
hash/jsonor ran only on K8s—the classic vs Flink page and transform examples (set,sorted_set,stream,string) no longer warn those outputs are classic-only; the comparison table drops deployment-target and supported-output rows in favor of shared transformation/data-type coverage.Installation and migration: Adds Configure the Flink processor on install-vm; K8s install and migration pages clarify Helm tuning is K8s-only while per-pipeline
processors.type: flinkworks on both; migration drops the output-type blocker and trims an advancedtarget.waitexample.Reference and ops:
config-yaml-referencesyncs processor type, source/table/RIOTX fields, Debeziumsources.advanced.sourceknobs, metadatarevision/tags, and replica-wait notes; upgrade documents enabling Flink post-1.19.0; observability fixes the VM classic processor metrics path tohttps://<RDI_HOST>/processor/metrics.Reviewed by Cursor Bugbot for commit 15687fc. Bugbot is set up for automated code reviews on this repo. Configure here.