-
Notifications
You must be signed in to change notification settings - Fork 851
Doc: storage.yaml #12609
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 11-Dev
Are you sure you want to change the base?
Doc: storage.yaml #12609
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Introduces documentation for the new unified storage.yaml cache configuration, and marks the legacy storage.config and volume.config formats as deprecated. It also updates the admin config index and documents per-volume avg_obj_size and fragment_size overrides.
Changes:
- Add comprehensive
storage.yamldocumentation including schema (spans,volumes,volumes.spans), allocation rules, and migration/backwards compatibility information. - Mark
storage.configandvolume.configas deprecated in favor ofstorage.yamland cross-link them appropriately. - Update the admin “Configuration Files” index to include
storage.yamland to reflect the new deprecation status ofstorage.configandvolume.config.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
doc/admin-guide/files/storage.yaml.en.rst |
New, full reference and examples for storage.yaml, covering storage spans, volume definitions (including avg_obj_size and fragment_size), allocation behavior, and compatibility with existing storage.config/volume.config. |
doc/admin-guide/files/storage.config.en.rst |
Adds an .. important:: block to mark storage.config as deprecated in favor of storage.yaml. |
doc/admin-guide/files/volume.config.en.rst |
Adds an .. important:: block to mark volume.config as deprecated in favor of storage.yaml. |
doc/admin-guide/files/index.en.rst |
Registers storage.yaml in the configuration files toctree and updates one-line descriptions for storage.config, storage.yaml, and volume.config to reflect the new deprecations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
d3a7be1 to
e3e54b8
Compare
Co-authored-by: Alan M. Carroll <[email protected]>
e3e54b8 to
ba0370d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Revive #11000 for the config project. Diffs from #11000 are
storage.configandvolume.config, but keeps them for compatibility, so we can merge to master branch.spans.idtospans.namefor clarityvolumes.avg_obj_sizeandvolumes.fragment_sizesupportIf this looks good, I'll work on implementation.