The AI guidelines said that listing AI tooling in a commit with a
`co-authored-by`, `assisted-by`, or `generated-by` trailer was not necessary,
which read as discouragement and left contributors unsure whether such a trailer
was welcome at all. The maintainers have since agreed that these trailers are
fine, so say so.
What the guidelines require is unchanged: sign-off is the human contributor's,
and AI assistance is disclosed in the pull request description.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
Ask contributors without write access to keep no more than three pull requests
open at the same time, so that maintainer review — the project's limiting
resource — is not spread too thin, enforced through the repository's pull
request limit. Contributors with write access, who are actively engaged with
the project, are not restricted; anyone with a genuine need to exceed the limit
can raise it with a maintainer.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
`AGENTS.md` is almost entirely links into `Documentation/`, which is what keeps
it from duplicating the documentation and drifting away from it. That only works
while the links resolve, and nothing checked them: the link checker walks
`Documentation/` alone, so a moved page would leave `AGENTS.md` pointing at
nothing and silently misdirect its reader.
Include it in the files the link checker walks.
The other markdown files in the repository root are left out on purpose. Several
of them already contain dead external links, and adding them here would fail the
nightly job for reasons unrelated to this change.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
AI coding agents read a top-level `AGENTS.md` by convention, and Rook has no
file at that path, so an agent entering this repository starts with no knowledge
of its conventions. The result is predictable: unsigned commits, invalid commit
prefixes, `pkg/apis` changes with no regenerated CRDs, AI attribution trailers
that the AI guidelines ask contributors not to use, and pull request checklists
with every box ticked.
Add an `AGENTS.md` that maps the reader onto the contributor documentation
instead of restating it, so that the two cannot come to disagree. What little it
states inline is the policy that holds no matter what else the reader skips,
such as signing off and disclosing AI assistance. Everything mechanical, and
therefore liable to change, is a link.
It also points at the pull request template, which GitHub supplies to anyone
opening a pull request in a browser but not to a tool that submits a body
directly, and which such a tool therefore has to be told to go and read.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
The integration tests mix testify's `assert` and `require`, and the choice
between them is not arbitrary: `require` fails fast so that later code does not
run against a nil or zero value, while `assert` lets a run report every property
that is wrong instead of only the first.
Write down the convention, along with the rule that neither belongs inside a
poll closure, where an assertion defeats the retry and `require` is not safe on
testify's `Eventually` goroutine.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
Three of the checklist items say "if necessary" without saying what would make
them necessary, and a box ticked without a matching change misleads the reviewer
who reads the checklist as a claim about the diff. The deciding criterion in
each case is simply which folder the change touches.
State that folder next to each item, so the test is visible where the box is
ticked and needs no judgement to apply.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
The development flow guide described running unit tests and `make lint`, but
several other checks also gate every pull request and were documented nowhere:
`make golangci-lint`, `make codegen`, `make crds`, and commitlint. A contributor
had no way to learn about them short of pushing and reading a red CI run.
Add a table of the gating checks and the command that runs each one locally,
and document the parts that are easy to get wrong:
- Any change under `pkg/apis` requires regenerating the client, deepcopy
functions, CRD manifests, and CRD reference docs, and the regenerated files
belong in the same commit. This includes editing a godoc comment, since those
comments are copied verbatim into the CRD description fields.
- Commitlint infers a trailer from the shape of a line, so a body line that
begins with a word followed by a colon is read as one, and the commit is
rejected with `footer-leading-blank`.
- The commit prefix must come from the type list in `.commitlintrc.json`.
Also note that `make test` only covers `cmd/` and `pkg/`, so test files under
`tests/framework/` are compiled but never run by the unit test CI.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
Rook enforces Conventional Commits with commitlint in CI, but the only way to
check a message before pushing was a long `npx` invocation buried in the
developer guide. A make target is easier to remember and to reach for, both for
contributors and for tools.
`make lint.commits` runs the same commitlint over the commits on the current
branch. It compares against `origin/master`, rather than a local `master` that
is easy to leave stale and would drag already-merged upstream commits into the
range; override with `COMMITLINT_BASE` when the upstream is a different remote.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
The daily CI smoke, object, and other suites now run
all of the known Ceph versions, including stable
Squid, Tentacle, and Umbrella, as well as devel
versions of the same releases.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The rook fork should only run the daily integration
tests. This disables the markdown checker in other
forks.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
the .nvmeof pool was incorrectly tagged with the rbd
application and initialized as an rbd pool. add .nvmeof
to the built-in pool switch so it gets the nvmeof-meta
application tag instead, and skip rbd pool init.
Signed-off-by: Oded Viner <oviner@redhat.com>
Add VolumeGroupSnapshotClass and VolumeGroupSnapshot example manifests
for RBD and NFS, similar to the existing CephFS examples.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Praveen M <m.praveen@ibm.com>
The canary that checks every RGW zone.json *_pool field is covered by
Rook's zonePoolNSSuffix map was inline in runObjectE2ETest, running
against the legacy per-pass store before the shared store existed.
Move it into tests/integration/object/zonepools as a standalone
shared-store consumer. It now validates the shared store's zone, which
carries the real shared-pool placements the canary is meant to guard,
and runs first among the shared-store packages so it still sees a fresh
zone.
Add a Sharedstore.Installer() accessor so the packaged canary can run
radosgw-admin inside the cluster while keeping the uniform
(t, k8sh, store) package entry signature.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
if the csi secret is updated or a client profile is updated
we need a re-reconile of rns
So added the watcher for it
Signed-off-by: parth-gr <partharora1010@gmail.com>
Changes:
- Use a dedicated .nvmeof pool (via CephBlockPool CR named
builtin-nvmeof) for the NVMe-oF gateway internal state.
- Use a separate nvmeof pool for the StorageClass data.
- Remove the pool field from the CephNVMeOFGateway CRD.
The gateway now always uses the .nvmeof pool, hardcoded
in the operator.
- Add .nvmeof to the allowed CephBlockPool name overrides.
- Create a production example nvmeof.yaml (instances: 2,
replicas: 3) and a CI-only nvmeof-test.yaml (instances: 1,
replicas: 1).
- Update documentation and CI test script accordingly.
Signed-off-by: Oded Viner <oviner@redhat.com>