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>
(cherry picked from commit 44fec7aeff)
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>
(cherry picked from commit 83b2c2e488)
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>
(cherry picked from commit dd8f63e6e7)
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>
(cherry picked from commit e32ea6cbab)
The operator image in the rook-ceph chart and the Ceph image in the
rook-ceph-cluster chart are both configured as a repository and tag
pair. The toolbox was the exception, taking a single toolbox.image
string.
Add toolbox.repository and toolbox.tag, so the toolbox image can be
configured the same way as the others. Either setting may be applied on
its own; whichever is left unset falls back to cephImage.repository or
cephImage.tag.
The new settings take precedence over toolbox.image, which continues to
apply when neither is set, so existing values files are unaffected.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit faf2bffe5a)
Document spec.server.port for host-network port conflicts, and describe
how user-managed LoadBalancer and NodePort Services must align port and
targetPort with the CR.
Signed-off-by: raaizik <raaizik@yahoo.com>
Co-Authored-By: Blaine Gardner <b.blaine.gardner@gmail.com>
(cherry picked from commit a400ae6fd5)
When NFS runs with host networking, port 2049 may already be in use.
Add CephNFS spec.server.port (default 2049), wire it through Ganesha
config, the operator Service, and probes, and regenerate CRDs.
Signed-off-by: raaizik <raaizik@yahoo.com>
(cherry picked from commit 5e36fa4bc3)
The Placement field comments on RBDMirroringSpec and
FilesystemMirroringSpec both read "The affinity to place the rgw pods",
copied from GatewaySpec. Neither spec manages RGW pods: RBDMirroringSpec
configures the rbd mirror daemon and FilesystemMirroringSpec the
cephfs-mirror daemon.
Update the comments to name the correct pods, matching the wording
already used by the sibling Resources and PriorityClassName fields in
each struct, and regenerate Documentation/CRDs/specification.md so the
published CRD API reference matches.
Signed-off-by: Anas Khan <83116240+anxkhn@users.noreply.github.com>
(cherry picked from commit b26cad41ef)
Expand the Node Loss section in block-storage.md to accurately describe the automatic fencing flow, and add dedicated Network Fencing sections across the CSI documentation to provide configuration examples for both manifest-based and Helm-based deployments.
* block-storage.md: introduce the Network Fencing prerequisite paragraph with links to the new example sections, replace the single-line "auto-fencing" description with three bullets describing the client blocklist flow, and update Node Recovery to a single sentence covering workload rescheduling and the 5-minute cool-down behavior that triggers automatic unblocklist. Add a Warning admonition instructing administrators not to remove the out-of-service taint before the node completes a full power cycle.
* csi-configuration.md: add a Network Fencing section enumerating the three prerequisites (CSI-Addons controller, CSI-Addons sidecar, enableFencing flag) and showing the RBD Driver CR manifest with deployCsiAddons and enableFencing set together.
* csi-drivers-chart.md: add a Network Fencing subsection under Custom settings showing the per-driver Helm values for deployCsiAddons and enableFencing, with a cross-reference to csi-configuration.md.
* ceph-csi-drivers.md: replace the legacy CSI_ENABLE_CSIADDONS configmap patch in the Enable CSI-Addons Sidecar section with the modern deployCsiAddons approach on OperatorConfig or Driver, and add a Network Fencing overview section that links out for configuration details and the operational flow.
Signed-off-by: N3rdBot <wujiafeng17@gmail.com>
(cherry picked from commit bc8d40095d)
Add optional CephObjectRealm, CephObjectZoneGroup, and CephObjectZone
resources to the rook-ceph-cluster chart so an RGW multisite topology can
be deployed from the chart alongside CephObjectStore.
Each resource type follows the existing per-list template idiom: a new
template ranges over a values list and renders name, namespace, and spec.
The realm template renders spec only when set, supporting both a new realm
(no spec) and a pulled realm (spec.pull.endpoint).
The three lists ship commented out in values.yaml with a multisite
example, matching the opt-in cephECBlockPools precedent, so a default
install creates no multisite resources.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit 8989bff653)
This change fixes some of the broken links in the markdown
documentatoion sources found by the markdown link checker.
Assisted-by: IBM Bob
Signed-off-by: Michael Adam <obnox@samba.org>
(cherry picked from commit a70d68b882)
Rename the Release Cycle page to "Maintenance and Support" and add a
table of the Kubernetes and Ceph versions supported by each Rook minor
release series (1.12 through 1.20).
The per-series numbers are sourced from each release branch's
prerequisites/quickstart guide (Kubernetes) and Ceph upgrade guide
(Ceph), giving users a single place to check version compatibility
across releases. A redirect preserves the previous release-cycle URL.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit a346690ae3)
Fix duplicate words, incorrect articles (a/an), it's/its, and other small
grammar mistakes in Go comments and user-facing messages across pkg/, cmd/,
and tests/.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit c0eb360041)
the label could be different based on differnt cluster
setup so no need for label vased verification of csi-op.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit afff9dbdf4)
Correct duplicate words, incorrect articles, subject/verb agreement, and
other small grammar mistakes across the user-facing Documentation/ pages
and the design/ records. No content or behavior changes.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit d395d1916b)
Several godoc comments led with a stale or incorrect identifier, left
over from renames, exported/unexported changes, copy-paste between
sibling declarations, or plain typos. As a result the documented name no
longer matched the function, method, type, or var it describes. Correct
each leading word to the name of the declaration it documents.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit 49612461a4)
this commit implement api to configure
ceph health warning mute/unmute.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit 9a6c5842bc)
adding api changes to mute/unmute ceph warnings
based on user configuration. The field is map[string]string
key is ceph warning and value is duration how longs
the warnings will be muted.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit ff5f3baa58)
Updated the prerequisite guide to ensure udev is installed on the rook
ceph cluster.
Signed-off-by: Santosh <sapillai@redhat.com>
(cherry picked from commit 28c84a2209)
Make the NVMe-oF gateway image optional in the CR spec.
When not specified, the operator fetches the image from
the Ceph mon config store using the key
mgr/cephadm/container_image_nvmeof. Falls back to the
hardcoded default if the config is unavailable.
Signed-off-by: Oded Viner <oviner@redhat.com>
(cherry picked from commit 8b4fd67e17)
updated the external cluster doc, and helm and manifest
install to make use of csi operator as it is the default
offering now
Signed-off-by: parth-gr <partharora1010@gmail.com>
(cherry picked from commit dbc8d2a541)
The helm values need to be updated if installing the drivers
chart in a namespace other than rook-ceph.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
(cherry picked from commit c5c6ef385d)
Add support for the osd.rook.io/device-class node label to assign
CRUSH device classes to all OSDs on a node.
The operator reads the label during OSD provisioning and
deployment reconciliation. If CR-level deviceClass conflicts
with the node label, the operator will skip reconciling the
node and logs an error.
Resolves: #17131
Signed-off-by: Yuxiang He <yuxiang@dropbox.com>
(cherry picked from commit d9357dbfdc)
adding rook compatible Ceph-Csi driver values.yaml
file making sure, upgrading to 1.20 doesn't break
when csi-driver is moved to admin.
Co-authored-by: Travis Nielsen <tnielsen@redhat.com>
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit 774054c45e)
Add AI guidelines based on discussions from the most recent community
meeting.
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
(cherry picked from commit ebf4656481)
this command adds some examples on how users can add/update
the settings based on new way of managing CSI resources.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit fbef1d755e)
updating rook upgrade to mention the csi changes as breaking
change and updating the steps.
Co-authored-by: Travis Nielsen <tnielsen@redhat.com>
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit 32d68cc4a5)
adding new tls ssl_ciphersuites supporting tls 1.3 and the existing,
ssl_cipher supports tls 1.2 and below. Adding, the docs and unit-test
changs as well.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit b70a0c9257)
So far, the latest supported kubernetes version was documented as 1.35
This change documents 1.36 (I. e. the latest available) as
the latest supported version.
It also updates the minimun supported kubernetes version
from 1.30 to 1.31
Signed-off-by: Michael Adam <obnox@samba.org>
Co-authored-by: Travis Nielsen <tnielsen@redhat.com>
(cherry picked from commit df57b77b6b)
remov restrictions that prevented LVM logical volume from being
provisioned as OSDs. LV devices with a metadatadevice were rejected at
the filtering stage. LV devices without one were incorrectly being
routed to ceph-volume raw mode which was resuting in error. This PR:
- removes metadatadevice restriction on LV devices.
- Adds LVM time check to isSafeToUseRAWMode to prevent raw mode on lvm
Signed-off-by: Santosh <sapillai@redhat.com>
(cherry picked from commit c6d48178dd)
This commit update the csi-operator to latest v1.0.0.
we need to manually patch the csi drivers with the new serviceAccount
name that are being creating based on the latest ceph-csi-operator
release v1.0.0 where serviceAccount are being separate from csi-operator
chart.
co-authored-by: Travis Nielsen <tnielsen@redhat.com>
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit 06452991bf)
kubectl exec requires a double dash ('--') between the pod name and the command to be
executed.
The disaster recovery troubleshooting guide missed those characters
in two places.
This change fixes the guide by adding the missing double dashes
Signed-off-by: Michael Adam <obnox@samba.org>
(cherry picked from commit ef7e80bedc)
adding missing resource request for mon drbd containers
log-collector and shut-down-app and update the unit test
to validate.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit d88e287726)
this commit adds flag stripe_unit for the command
ceph osd erasure-code-profile set [flags]. This key
increase perfomance for ec pool. The default value
is 4kib/4096 bytes.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit 9fb0582dd6)
Going forward, admin will manage the csi operator
CR's and rook will only manage Ceph Connection cr
and client Profile cr.
The old csi driver is completely removed from Rook
and can no longer be used starting in Rook v1.20.
The upgrade guide will contain the needed transition steps
for managing the csi operator settings.
Signed-off-by: subhamkrai <srai@redhat.com>
(cherry picked from commit 4eefad42e8)
Add a section to the teardown documentation with cleanup commands
for CSI operator resources: OperatorConfig, Driver, ClientProfile,
ClientProfileMapping, and CephConnection custom resources, plus the
csi-operator.yaml deployment manifest.
Signed-off-by: Lumir Sliva <61183145+lumir-sliva@users.noreply.github.com>
(cherry picked from commit 943ea89cd5)