Skip to content

Update druid docs examples to latest supported version (36.0.0)#915

Open
tamalsaha wants to merge 4 commits into
masterfrom
update-druid-docs-version
Open

Update druid docs examples to latest supported version (36.0.0)#915
tamalsaha wants to merge 4 commits into
masterfrom
update-druid-docs-version

Conversation

@tamalsaha

@tamalsaha tamalsaha commented Jun 30, 2026

Copy link
Copy Markdown
Member

Bumps the druid example and guide manifests to the latest supported version (36.0.0) per the installer active_versions.json.

  • General "deploy a druid" examples use the latest version.
  • Version-upgrade guides keep a nearest-older source and upgrade to the latest (preserved as a real upgrade, not a no-op).
  • Illustrative command outputs (kubectl get ...version tables, describe dumps) and other products'/backend versions are left unchanged.

Summary by CodeRabbit

  • Documentation
    • Updated Druid guides and example manifests (quickstart, autoscaling, backup/restore, monitoring, scaling, TLS, reconfiguration, restart, failover, and update-version) with refreshed Druid version references.
    • Bumped example spec.version values and related walkthrough/status snippets to 36.0.0 to match expected kubectl outputs.
    • Refreshed the version upgrade tutorial to reflect the 35.0.1 → 36.0.0 flow, including updated target-version examples and verification output.

Bump the druid example/guide manifests to the latest supported version per
installer active_versions.json. Deploy examples use the latest; version-upgrade
guides keep an older source and upgrade to the latest. Illustrative command
outputs and other products' versions are left unchanged.

Signed-off-by: Tamal Saha <tamal@appscode.com>
kodiak-appscode[bot]
kodiak-appscode Bot previously approved these changes Jun 30, 2026
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a76dc995-eea1-498f-91f1-5cf3849cef18

📥 Commits

Reviewing files that changed from the base of the PR and between 8409185 and dc819eb.

📒 Files selected for processing (12)
  • docs/guides/druid/backup/application-level/index.md
  • docs/guides/druid/backup/auto-backup/index.md
  • docs/guides/druid/backup/cross-ns-dependencies/index.md
  • docs/guides/druid/backup/logical/index.md
  • docs/guides/druid/clustering/guide/index.md
  • docs/guides/druid/concepts/appbinding.md
  • docs/guides/druid/concepts/druid.md
  • docs/guides/druid/configuration/podtemplating/index.md
  • docs/guides/druid/failover/guide.md
  • docs/guides/druid/quickstart/guide/index.md
  • docs/guides/druid/update-version/guide.md
  • docs/guides/druid/update-version/yamls/update-version-ops.yaml
✅ Files skipped from review due to trivial changes (10)
  • docs/guides/druid/concepts/appbinding.md
  • docs/guides/druid/concepts/druid.md
  • docs/guides/druid/clustering/guide/index.md
  • docs/guides/druid/backup/auto-backup/index.md
  • docs/guides/druid/quickstart/guide/index.md
  • docs/guides/druid/failover/guide.md
  • docs/guides/druid/backup/application-level/index.md
  • docs/guides/druid/update-version/guide.md
  • docs/guides/druid/backup/cross-ns-dependencies/index.md
  • docs/guides/druid/configuration/podtemplating/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/druid/backup/logical/index.md

📝 Walkthrough

Walkthrough

Druid documentation examples and guides update version references to 36.0.0 across quickstart, configuration, scaling, TLS, monitoring, backup, and operational docs. The update-version guide uses 35.0.1 as the starting version and 36.0.0 as the upgrade target.

Changes

Druid docs version updates

Layer / File(s) Summary
Quickstart, concepts, and clustering
docs/examples/druid/quickstart/druid-quickstart.yaml, docs/guides/druid/quickstart/guide/index.md, docs/guides/druid/concepts/druid.md, docs/guides/druid/concepts/appbinding.md, docs/guides/druid/clustering/guide/...
Version references and example manifests are updated to 36.0.0 in quickstart, concepts, and clustering docs.
Configuration guides
docs/guides/druid/configuration/config-file/..., docs/guides/druid/configuration/podtemplating/...
Version references, watch output, and YAML manifests are updated in configuration-file and podtemplating docs.
Operational guides
docs/guides/druid/restart/..., docs/guides/druid/reconfigure/..., docs/guides/druid/reconfigure-tls/..., docs/guides/druid/rotate-auth/..., docs/guides/druid/failover/...
Version references, YAML snippets, and kubectl outputs are updated in restart, reconfigure, reconfigure-tls, rotate-auth, and failover docs.
Scaling and autoscaler guides
docs/guides/druid/scaling/horizontal-scaling/..., docs/guides/druid/scaling/vertical-scaling/..., docs/guides/druid/volume-expansion/..., docs/guides/druid/autoscaler/compute/..., docs/guides/druid/autoscaler/storage/...
Version references and watch outputs are updated in scaling and autoscaler compute/storage docs.
TLS and monitoring
docs/guides/druid/tls/..., docs/guides/druid/monitoring/...
Version references and matching outputs are updated in TLS and monitoring guides and YAML manifests.
Backup guides and examples
docs/guides/druid/backup/logical/..., docs/guides/druid/backup/application-level/..., docs/guides/druid/backup/auto-backup/..., docs/guides/druid/backup/cross-ns-dependencies/..., docs/guides/druid/backup/customization/...
Version references, manifests, AppBinding snippets, and restore verification outputs are updated across backup guides and example YAMLs.
Update-version guide
docs/guides/druid/update-version/guide.md, docs/guides/druid/update-version/yamls/druid-cluster.yaml
The upgrade walkthrough uses 35.0.1 as the starting version and 36.0.0 as the target version, including the DruidOpsRequest YAML and UI verification text.

Estimated code review effort: 3 (Moderate) | ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: updating Druid documentation examples to version 36.0.0.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-druid-docs-version

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/guides/druid/autoscaler/compute/guide.md`:
- Line 128: The kubectl example in the Druid autoscaler guide uses the wrong
resource shorthand, so update the command to use the Druid resource name instead
of kf. Fix the example in the guide by replacing the shorthand with the correct
Druid alias or full resource name, and keep the rest of the kubectl invocation
unchanged so readers can follow the documented workflow.

In `@docs/guides/druid/backup/logical/index.md`:
- Line 626: The restored Druid version is inconsistent between the guide
outputs, so update the later kubectl get druid example to match the
restored-druid version shown here. In the Druid backup logical guide, locate the
output block containing restored-druid and correct the mismatched version in the
later example from the copied MySQL value to 36.0.0 so both Druid outputs are
consistent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 18863d96-bf33-4d6a-9da7-c773f42908df

📥 Commits

Reviewing files that changed from the base of the PR and between d9a1f1a and 97e7e34.

📒 Files selected for processing (52)
  • docs/examples/druid/quickstart/druid-quickstart.yaml
  • docs/guides/druid/autoscaler/compute/guide.md
  • docs/guides/druid/autoscaler/compute/yamls/druid-cluster.yaml
  • docs/guides/druid/autoscaler/storage/guide.md
  • docs/guides/druid/autoscaler/storage/yamls/druid-cluster.yaml
  • docs/guides/druid/backup/application-level/examples/sample-druid.yaml
  • docs/guides/druid/backup/application-level/index.md
  • docs/guides/druid/backup/auto-backup/examples/sample-druid-2.yaml
  • docs/guides/druid/backup/auto-backup/examples/sample-druid.yaml
  • docs/guides/druid/backup/auto-backup/index.md
  • docs/guides/druid/backup/cross-ns-dependencies/examples/sample-druid.yaml
  • docs/guides/druid/backup/cross-ns-dependencies/index.md
  • docs/guides/druid/backup/customization/examples/common/sample-druid.yaml
  • docs/guides/druid/backup/logical/examples/restored-druid.yaml
  • docs/guides/druid/backup/logical/examples/sample-druid.yaml
  • docs/guides/druid/backup/logical/index.md
  • docs/guides/druid/clustering/guide/index.md
  • docs/guides/druid/clustering/guide/yamls/druid-cluster.yaml
  • docs/guides/druid/concepts/appbinding.md
  • docs/guides/druid/concepts/druid.md
  • docs/guides/druid/concepts/druidopsrequest.md
  • docs/guides/druid/configuration/config-file/index.md
  • docs/guides/druid/configuration/config-file/yamls/druid-with-config.yaml
  • docs/guides/druid/configuration/podtemplating/index.md
  • docs/guides/druid/configuration/podtemplating/yamls/druid-cluster.yaml
  • docs/guides/druid/configuration/podtemplating/yamls/druid-node-selector.yaml
  • docs/guides/druid/configuration/podtemplating/yamls/druid-with-tolerations.yaml
  • docs/guides/druid/configuration/podtemplating/yamls/druid-without-tolerations.yaml
  • docs/guides/druid/failover/guide.md
  • docs/guides/druid/monitoring/overview.md
  • docs/guides/druid/monitoring/using-builtin-prometheus.md
  • docs/guides/druid/monitoring/using-prometheus-operator.md
  • docs/guides/druid/monitoring/yamls/druid-monitoring-builtin.yaml
  • docs/guides/druid/monitoring/yamls/druid-with-monitoring.yaml
  • docs/guides/druid/quickstart/guide/index.md
  • docs/guides/druid/reconfigure-tls/guide.md
  • docs/guides/druid/reconfigure-tls/yamls/druid-cluster.yaml
  • docs/guides/druid/reconfigure/guide.md
  • docs/guides/druid/reconfigure/yamls/druid-cluster.yaml
  • docs/guides/druid/restart/guide.md
  • docs/guides/druid/restart/yamls/druid-cluster.yaml
  • docs/guides/druid/rotate-auth/guide.md
  • docs/guides/druid/scaling/horizontal-scaling/guide.md
  • docs/guides/druid/scaling/horizontal-scaling/yamls/druid-cluster.yaml
  • docs/guides/druid/scaling/vertical-scaling/guide.md
  • docs/guides/druid/scaling/vertical-scaling/yamls/druid-cluster.yaml
  • docs/guides/druid/tls/guide.md
  • docs/guides/druid/tls/yamls/druid-cluster-tls.yaml
  • docs/guides/druid/update-version/guide.md
  • docs/guides/druid/update-version/yamls/druid-cluster.yaml
  • docs/guides/druid/volume-expansion/guide.md
  • docs/guides/druid/volume-expansion/yamls/druid-cluster.yaml

Comment thread docs/guides/druid/autoscaler/compute/guide.md Outdated
Comment thread docs/guides/druid/backup/logical/index.md
Signed-off-by: Fazle Rabbi Sarker <fazlerabbi@appscode.com>
kodiak-appscode[bot]
kodiak-appscode Bot previously approved these changes Jun 30, 2026
fr-sarker
fr-sarker previously approved these changes Jun 30, 2026
Signed-off-by: Fazle Rabbi Sarker <fazlerabbi@appscode.com>
@fr-sarker fr-sarker dismissed stale reviews from kodiak-appscode[bot] and themself via dc819eb July 2, 2026 05:40
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.

2 participants