Skip to content

docs: clarify parallelism migration guidance for existing jobs and new default strategies#1013

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/clarify-parallelism-migration-guidance
Draft

docs: clarify parallelism migration guidance for existing jobs and new default strategies#1013
Copilot wants to merge 3 commits intomainfrom
copilot/clarify-parallelism-migration-guidance

Conversation

Copy link
Contributor

Copilot AI commented Feb 19, 2026

Users repeatedly hit confusion around whether system-level parallelism settings retroactively apply to existing streaming jobs — they do not. This adds a dedicated migration guide covering both the "future jobs" path (ALTER SYSTEM) and the "existing jobs" path (per-relation ALTER).

Description

operate/manage-a-large-number-of-streaming-jobs.mdx — new section: Migrate to recommended parallelism defaults

  • Recommended defaults table — documents streaming_parallelism_strategy_for_source, streaming_parallelism_strategy_for_table, and adaptive_parallelism_strategy target values with an explicit callout that they apply to newly created jobs only.
  • System defaults SQL — three ALTER SYSTEM SET statements to configure cluster-wide defaults for future jobs.
  • Existing-relations migration playbook — three-step SQL workflow:
    1. Inspect current parallelism via rw_streaming_parallelism
    2. Generate ALTER … SET PARALLELISM = 4 for sources/tables deviating from target
    3. Generate ALTER … SET PARALLELISM = adaptive for unbounded adaptive MVs/sinks/indexes
  • Operational safety — actor-count check, staged rollout, per-batch verification, capacity awareness.
  • Version awareness — parameters (adaptive_parallelism_strategy, streaming_parallelism_strategy_for_source, streaming_parallelism_strategy_for_table) were introduced in v2.3.0; the recommended BOUNDED(4) / BOUNDED(64) defaults were introduced in v2.8.0. Clusters upgraded from versions before v2.8.0 do not automatically inherit the new defaults.

deploy/k8s-cluster-scaling.mdx — cross-link section at page end pointing to the new migration guide for clusters created before v2.8.0 or before the recommended defaults were applied.

Related code PR

risingwavelabs/risingwave#24678

Related doc issue

https://github.com/risingwavelabs/risingwave-docs/issues/

Checklist

  • I have run the documentation build locally to verify the updates are applied correctly.
  • For new pages, I have updated mint.json to include the page in the table of contents.
  • All links and references have been checked and are not broken.
Original prompt

This section details on the original issue you should resolve

<issue_title>Clarify parallelism migration guidance: SQL for existing jobs and new default strategies</issue_title>
<issue_description>## Context
Slack thread (customer + internal triage):

Related change referenced in discussion:

Current docs pages involved:

Problem

Users are confused about whether they must manually update all existing MVs/streaming jobs when adopting newer recommended defaults (bounded(4) for source/table and bounded(64) system adaptive).

The current docs explain adaptive strategy and per-object ALTER commands, but do not clearly provide:

  1. A migration playbook for clusters that were created before the new defaults.
  2. SQL patterns to generate bulk ALTER statements for existing relations.
  3. A clear split between:
  • settings that affect future jobs only, and
  • per-relation changes required for existing jobs.

This gap leads to repeated support questions and inconsistent operational changes.

Suggested Fix

Add a dedicated note/section in operate/manage-a-large-number-of-streaming-jobs.mdx (and cross-link from deploy/k8s-cluster-scaling.mdx) titled something like Migrate to recommended parallelism defaults.

Include:

  1. Recommended defaults and scope
  • streaming_parallelism_strategy_for_source = 'BOUNDED(4)'
  • streaming_parallelism_strategy_for_table = 'BOUNDED(4)'
  • adaptive_parallelism_strategy = 'BOUNDED(64)'
  • Explicitly state these defaults affect newly created jobs (unless altered later).
  1. SQL to set system defaults for future jobs
ALTER SYSTEM SET streaming_parallelism_strategy_for_source = 'BOUNDED(4)';
ALTER SYSTEM SET streaming_parallelism_strategy_for_table = 'BOUNDED(4)';
ALTER SYSTEM SET adaptive_parallelism_strategy = 'BOUNDED(64)';
  1. SQL patterns to migrate existing relations
  • Show how to inspect current parallelism and generate ALTER statements for existing relations that deviate from target values.
  • Provide separate examples for source/table vs other streaming jobs where appropriate.
  • Keep examples safe and explicit (generate SQL first, review, then execute).
  1. Operational safety notes
  • Recommend staged rollout and observation window.
  • Call out actor-count/capacity checks before and after changes.
  • Clarify there is no single switch that force-updates all existing jobs without per-relation ALTER.
  1. Version-awareness note
  • Mention that clusters on older versions may not have these defaults and should follow migration guidance.

This should reduce ambiguity around “existing vs future” behavior and make support guidance consistent with PR risingwavelabs/risingwave-docs#24678 defaults.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…aming jobs

Co-authored-by: kwannoel <47273164+kwannoel@users.noreply.github.com>
Copilot AI changed the title [WIP] Clarify parallelism migration guidance for SQL jobs docs: clarify parallelism migration guidance for existing jobs and new default strategies Feb 19, 2026
Copilot AI requested a review from kwannoel February 19, 2026 23:25

## Migrate existing jobs to recommended defaults

If your cluster was created before v2.3.0 or before the recommended parallelism defaults were applied, existing streaming jobs retain their original parallelism settings. For a step-by-step guide on inspecting current parallelism and generating bulk `ALTER` statements to bring existing relations in line with the recommended defaults, see [Migrate to recommended parallelism defaults](/operate/manage-a-large-number-of-streaming-jobs#migrate-to-recommended-parallelism-defaults).
Copy link
Collaborator

Choose a reason for hiding this comment

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

@copilot this should be v2.8.0

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in 54c1211 — changed v2.3.0 to v2.8.0 in both k8s-cluster-scaling.mdx and the version-awareness section in manage-a-large-number-of-streaming-jobs.mdx. I also kept the existing v2.3.0 reference (when the parameters themselves were first introduced) and clarified that the recommended BOUNDED defaults were added in v2.8.0.

… defaults

Co-authored-by: kwannoel <47273164+kwannoel@users.noreply.github.com>
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.

Clarify parallelism migration guidance: SQL for existing jobs and new default strategies

2 participants