Skip to content

Fix Database field doc to match PVC behavior - #70

Open
umago wants to merge 1 commit into
openstack-k8s-operators:mainfrom
umago:fix-pvc-description
Open

Fix Database field doc to match PVC behavior#70
umago wants to merge 1 commit into
openstack-k8s-operators:mainfrom
umago:fix-pvc-description

Conversation

@umago

@umago umago commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

The comment claimed an emptyDir volume was used when Database was omitted, but a PersistentVolumeClaim is always created.

The comment claimed an emptyDir volume was used when Database was
omitted, but a PersistentVolumeClaim is always created.

Signed-off-by: Lucas Alvares Gomes <lucasagomes@gmail.com>
@openshift-ci
openshift-ci Bot requested review from Akrog and lpiwowar August 31, 2026 10:01
@openshift-ci

openshift-ci Bot commented Aug 31, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: umago

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 4aa3fbd3-5d43-409c-aadf-503baf23bb97

📥 Commits

Reviewing files that changed from the base of the PR and between 296e589 and 287b1fe.

📒 Files selected for processing (3)
  • api/v1beta1/openstacklightspeed_types.go
  • bundle/manifests/lightspeed.openstack.org_openstacklightspeeds.yaml
  • config/crd/bases/lightspeed.openstack.org_openstacklightspeeds.yaml

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Clarified that database storage always uses a PersistentVolumeClaim.
    • Documented that omitted storage settings use the default size and cluster StorageClass.
    • Removed outdated documentation describing temporary emptyDir storage and potential data loss.

Walkthrough

The Database field documentation now states that a PersistentVolumeClaim is always created and mounted. Omitted configuration uses the default size and cluster-default StorageClass. The emptyDir behavior description was removed from the API type and generated CRD manifests.

Changes

Database storage documentation

Layer / File(s) Summary
Storage contract documentation
api/v1beta1/openstacklightspeed_types.go, config/crd/bases/..., bundle/manifests/...
The API type and generated CRD manifests document unconditional PersistentVolumeClaim usage. They specify default size and cluster-default StorageClass behavior when database is omitted. The previous emptyDir description was removed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 287b1

This change corrects the Database field documentation to describe the existing PersistentVolumeClaim behavior; no actionable merge-blocking risk remains.

Suggested reviewers: akrog, lpiwowar

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states that the Database field documentation was corrected to match PVC behavior.
Description check ✅ Passed The description accurately explains that the documentation incorrectly stated emptyDir usage and that a PersistentVolumeClaim is always created.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@openshift-ci

openshift-ci Bot commented Aug 31, 2026

Copy link
Copy Markdown

@umago: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/openstack-lightspeed-kuttl-4-20 287b1fe link true /test openstack-lightspeed-kuttl-4-20

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.

@umago

umago commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator Author

/test openstack-lightspeed-kuttl-4-20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant