Add analyze-db.sh script for post-restore database warmup

[mstaeble]

Summary

• Adds scripts/analyze-db.sh to run ANALYZE VERBOSE on the sippy database via a one-shot pod after cloning/restoring the production database to staging
• Adds argument validation to scripts/backfill-summaries.sh for missing flag values
• Documents the new script in README.md

Test plan

• Run ./scripts/analyze-db.sh --dry-run to verify dry-run output
• Run ./scripts/analyze-db.sh against staging to verify ANALYZE completes
• Run ./scripts/backfill-summaries.sh --table (no value) to verify the new error message

🤖 Generated with Claude Code

Summary by CodeRabbit

• New Features

  • Added a database analysis utility that refreshes PostgreSQL planner statistics after restoration.
  • Supports namespace and database-secret overrides, plus a dry-run mode to preview actions.

• Bug Fixes

  • Improved command-line validation for database backfill options, providing clear errors when required values are missing.

• Documentation

  • Added guidance for database performance recovery, default configuration values, available overrides, and dry-run usage.

[openshift-merge-bot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: automatic mode

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mstaeble
Once this PR has been reviewed and has the lgtm label, please assign smg247 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mstaeble]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[coderabbitai]

Warning

Review limit reached

@mstaeble, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 17 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 35103553-d844-4d7c-bccd-10dedb804cbb

📥 Commits

Reviewing files that changed from the base of the PR and between 52420bf and 2391d59.

📒 Files selected for processing (3)

• README.md
• scripts/analyze-db.sh
• scripts/backfill-summaries.sh

Walkthrough

Adds a configurable ANALYZE VERBOSE script for restored PostgreSQL databases, documents its usage, and strengthens missing-value validation for options in the backfill summaries script.

Changes

Database analysis workflow

Layer / File(s)	Summary
Database analysis script scripts/analyze-db.sh, README.md	The new script parses namespace, database secret, and dry-run options; optionally creates a pod that runs ANALYZE VERBOSE using the configured database DSN. README documents defaults and overrides.

Backfill argument validation

Layer / File(s)	Summary
Backfill option validation scripts/backfill-summaries.sh	Value-taking options now reject missing arguments with an error instead of assigning an absent positional value.

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

Sequence Diagram(s)

sequenceDiagram
  participant Operator
  participant AnalyzeScript
  participant KubernetesPod
  participant PostgreSQL
  Operator->>AnalyzeScript: invoke analysis options
  AnalyzeScript->>KubernetesPod: delete and create analysis pod
  KubernetesPod->>PostgreSQL: run ANALYZE VERBOSE through psql
  PostgreSQL-->>KubernetesPod: return analysis results
  KubernetesPod-->>AnalyzeScript: complete pod command

Loading

🚥 Pre-merge checks | ✅ 20 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Test Coverage For New Features	⚠️ Warning	New shell behavior in analyze-db.sh and backfill-summaries.sh has no automated tests; the PR only changes README and scripts.	Add automated shell tests (e.g., bats/shunit) for analyze-db dry-run/args and backfill missing-flag-value errors.

✅ Passed checks (20 passed)

Check name	Status	Explanation
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.
Go Error Handling	✅ Passed	This PR only changes README and shell scripts; no Go code or error-handling paths are touched, so the Go error-handling check is not applicable.
Sql Injection Prevention	✅ Passed	No SQL is built from user input; analyze-db.sh runs fixed ANALYZE VERBOSE;, and backfill-summaries.sh only adds shell arg validation.
Excessive Css In React Should Use Styles	✅ Passed	PR changes only README and shell scripts; no React components or inline CSS were added, so the style rule is not applicable.
Single Responsibility And Clear Naming	✅ Passed	The PR only adds two focused scripts with descriptive names; each script handles one workflow and no broad packages/structs/methods were introduced.
Feature Documentation	✅ Passed	No relevant docs/features page covers the new db ops scripts; the only feature doc is about job symptoms, and README was updated instead.
Stable And Deterministic Test Names	✅ Passed	PR only changes README and shell scripts; no test files or Ginkgo titles were added or modified.
Test Structure And Quality	✅ Passed	No Ginkgo test files were changed; the PR only updates README and shell scripts, so this check is not applicable.
Microshift Test Compatibility	✅ Passed	Only README and shell scripts changed; no new Ginkgo e2e tests or MicroShift-unsafe APIs/features were added.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	PR changes only README and shell scripts; no new Ginkgo e2e tests or SNO-sensitive assumptions were added.
Topology-Aware Scheduling Compatibility	✅ Passed	Only docs and utility scripts changed; neither adds node selectors, affinity, spread rules, replica logic, or topology-specific scheduling assumptions.
Ote Binary Stdout Contract	✅ Passed	PR only changes README and shell scripts; no process-level OTE binary code or stdout contract changes were introduced.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	PR changes only README and shell scripts; no new Ginkgo e2e tests or IPv4-specific test code were added.
No-Weak-Crypto	✅ Passed	The PR adds no weak/custom crypto or secret/token comparisons; touched files only add ANALYZE automation, flag validation, and docs.
Container-Privileges	✅ Passed	Changed files add no privileged/host* settings, no SYS_ADMIN, and no explicit root or allowPrivilegeEscalation=true settings in the generated pod specs.
No-Sensitive-Data-In-Logs	✅ Passed	No new log output exposes secrets, tokens, PII, or customer data; added messages are generic status text.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: adding analyze-db.sh for post-restore database warmup.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 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 `@scripts/analyze-db.sh`:
- Around line 40-54: Add the required top-level --image option to the oc run
invocation using the same PostgreSQL image already specified in the overrides,
and retain --rm so the temporary pod is removed automatically.

🪄 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: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: f4078982-680e-4550-8e87-5535d4197238

📥 Commits

Reviewing files that changed from the base of the PR and between 6b1a47a and 52420bf.

📒 Files selected for processing (3)

• README.md
• scripts/analyze-db.sh
• scripts/backfill-summaries.sh

[openshift-merge-bot]

Scheduling required tests:
/test e2e

[openshift-ci]

@mstaeble: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.