Skip to content

[RUN-3161] Add server-side runner compact processor configuration properties#1825

Merged
fdevans merged 6 commits into
rundeck:4.0.xfrom
jgarces-pd:doc-runner-compact-processor
Jun 29, 2026
Merged

[RUN-3161] Add server-side runner compact processor configuration properties#1825
fdevans merged 6 commits into
rundeck:4.0.xfrom
jgarces-pd:doc-runner-compact-processor

Conversation

@jgarces-pd

Copy link
Copy Markdown
Contributor

Summary

Adds documentation for two new server-side configuration properties introduced in rundeckpro#3680 (RUN-3161 — Optimizations on runner report handling in database).

  • rundeck.runner.compactProcessor.enabled — enables a compact processing mode that stores each runner report as a single compressed database row instead of one row per data object, significantly reducing database transaction pressure.
  • rundeck.runner.compactProcessor.maxReportDataSize — limits the maximum runner report data stored in the database per operation (default: 1gb), acting as a safeguard against unbounded data growth.

Both properties are server-side (rundeck-config.properties) settings. Documentation is added as a new "Server-side report processing" section in docs/administration/runner/runner-config.md, placed alongside the existing runner client-side performance tuning guidance.

Related

Test plan

  • Review the new section renders correctly in VuePress
  • Confirm property names and defaults match those in RefreshableRundeckConfig.groovy and pro-features.properties from the code PR

🤖 Generated with Claude Code

@jgarces-pd jgarces-pd requested a review from a team June 24, 2026 14:23
@jgarces-pd

Copy link
Copy Markdown
Contributor Author

@forrestrd @fdevans I make this PR to document a feature released on 5.13.0 that was not documented.

@jgarces-pd jgarces-pd left a comment

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.

everything looks alright.

@fdevans

fdevans commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Server side configs should mention configuring in the System Config over directly in file based configs.

@fdevans fdevans left a comment

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.

See previous comment. Need to guide towards System Config, not just file based configs

@fdevans fdevans changed the title docs: add server-side runner compact processor configuration properties [RUN-3161] Add server-side runner compact processor configuration properties Jun 24, 2026
@jgarces-pd

Copy link
Copy Markdown
Contributor Author

@fdevans that is correct. Let me make that change.

@jgarces-pd

Copy link
Copy Markdown
Contributor Author

@fdevans addressed — moved the properties out of runner-config.md and into the rundeck-config.properties reference page (docs/administration/configuration/config-file-reference.md), with a tip callout directing users to configure them via the System Configuration GUI rather than directly editing the file.

@jgarces-pd jgarces-pd left a comment

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.

LGTM

@fdevans fdevans added this to the 6.1.0 milestone Jun 29, 2026
@fdevans fdevans requested a review from Copilot June 29, 2026 18:48

Copilot AI left a comment

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.

Pull request overview

Adds documentation for new server-side Rundeck runner report “compact processor” settings by introducing a new “Runner report processing (Commercial)” section in the configuration file reference, including guidance to prefer System Configuration UI.

Changes:

  • Documented rundeck.runner.compactProcessor.enabled behavior, default, and example configuration.
  • Documented rundeck.runner.compactProcessor.maxReportDataSize behavior, default, accepted values, and example configuration.
  • Added a System Configuration UI “recommended” tip for configuring these settings.

Comment thread docs/administration/configuration/config-file-reference.md
Comment thread docs/administration/configuration/config-file-reference.md
Comment thread docs/administration/configuration/config-file-reference.md
Comment thread docs/administration/configuration/config-file-reference.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@fdevans

fdevans commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

@fdevans fdevans merged commit 649ac8a into rundeck:4.0.x Jun 29, 2026
1 of 2 checks passed
@jgarces-pd jgarces-pd deleted the doc-runner-compact-processor branch June 30, 2026 14:25
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