Repository navigation
docs: keep the RGW placement contract in HACKING.md for now - #892
Open
johnramsden wants to merge 2 commits into
Open
johnramsden wants to merge 2 commits into
johnramsden wants to merge 2 commits into
Conversation
johnramsden
added this pull request to stack #894
September 23, 2026 04:20
This was referenced Sep 23, 2026
3 of 5 tasks
johnramsden
marked this pull request as ready for review
September 23, 2026 04:31
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
September 23, 2026 05:19
316fddb to
94fb290
Compare
johnramsden
marked this pull request as draft
September 23, 2026 06:12
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
September 23, 2026 18:19
94fb290 to
bdbbc24
Compare
lmlg
approved these changes
Sep 23, 2026
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
September 24, 2026 19:32
bdbbc24 to
fc5fe59
Compare
johnramsden
marked this pull request as ready for review
September 25, 2026 23:06
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
September 29, 2026 18:43
fc5fe59 to
75277ce
Compare
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
September 29, 2026 19:50
75277ce to
c7261cb
Compare
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
2 times, most recently
from
October 2, 2026 04:08
686beaa to
d36c52c
Compare
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
October 6, 2026 00:47
d36c52c to
b227b7b
Compare
RGW placement is still being built, so a published reference page would describe an API that can still change underneath it. The standing rules go where developers look instead: a new "RGW placement (in development)" section at the end of HACKING.md, which is not part of the Sphinx build under docs/ and so carries no promise of stability to an external reader. The section documents the rgw object's fields with an example policy, the rules that hold today and what a PUT returns for RGW, the three on-member files (radosgw.conf, radosgw.conf.pending, rgw-tls/<hash>/), the upgrade limitation for a policy stored while rgw was still a boolean, and where the code lives. Assisted-by: claude-code:claude-fable-5-1 Assisted-by: pi:gpt-6-astra Signed-off-by: John Ramsden <john.ramsden@canonical.com>
Assisted-by: omp:openrouter/openai/gpt-6-astra Signed-off-by: John Ramsden <john.ramsden@canonical.com>
johnramsden
force-pushed
the
rgw-stack/12-hacking
branch
from
October 10, 2026 00:47
b227b7b to
dad43a9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
RGW placement is still being built, so a published reference page would describe an API that can still change underneath it. The standing rules go where developers look instead: a new "RGW placement (in development)" section at the end of
HACKING.md, which is not part of the Sphinx build underdocs/and so carries no promise of stability to an external reader.The section documents the
rgwobject's fields with an example policy, the rules that hold today and what aPUTreturns for RGW, the three on-member files (radosgw.conf,radosgw.conf.pending,rgw-tls/<hash>/), the upgrade limitation for a policy stored whilergwwas still a boolean, and where the code lives.Stack: PR 12 of 13. Merge in order. Each PR is one logical change on top of the one before it.
Type of change
How has this been tested?
Documentation only. Every statement was checked against the code in this stack.
Contributor checklist
Please check that you have: