28 Commits
Author SHA1 Message Date
Oded Viner ec502c3f80 nvmeof: use .nvmeof pool for gateway and remove pool field from CRD
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>
2026-07-21 20:19:44 +03:00
N3rdBot bc8d40095d docs: update node loss handling instructions
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>
2026-07-15 16:29:37 +08:00
Travis Nielsen 46a1b0d19b Merge pull request #17887 from Madhu-1/add-node-publish-volume
csi: Add supported files for krbd QoS
2026-07-13 11:55:16 -06:00
Madhu Rajanna fb71b7406e doc: update the documentation for QoS
Updated the required documentation and yamls
where we are adding support for the QoS for
the rbd pvc that uses the krbd mounter.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2026-07-10 12:27:12 +05:30
Michael Adam e8a39e3f90 docs: fix docs-build
After some markdown link fixes,
make docs-build failed due to some non-existing anchors in documentation
sources.

This changes fixes the docs-build by rectifying anchors.

Assisted-by: IBM-Bob
Signed-off-by: Michael Adam <obnox@samba.org>
2026-07-09 19:31:22 +02:00
Oded VinerandNiels de Vos f647a0f12d doc: add csi operator support for nvmeof
Update the NVMe-oF documentation to use the Ceph-CSI-Operator to deploy
the Ceph-CSI/NVMe-oF components.

Co-authored-by: Niels de Vos <ndevos@ibm.com>
Signed-off-by: Oded Viner <oviner@redhat.com>
2026-03-24 12:18:45 +01:00
Travis Nielsen 002f33898a Merge pull request #17019 from OdedViner/nvmeof_provisioner_images
nvmeof: update expansion fields and sidecar images
2026-02-06 07:14:24 -07:00
Oded Viner 83c0b98418 nvmeof: update expansion fields and sidecar images
add expand secrets and set volume expansion in examples
update provisioner and resizer images to canary

Signed-off-by: Oded Viner <oviner@redhat.com>
2026-02-05 20:41:52 +02:00
subhamkrai ae33d23053 csi: remove rbd wording from node loss doc
since ceph-csi driver now handles both rbd and cephfs
volume node loss case, let's remove rbd specific
wording from the node loss doc in rook.

Signed-off-by: subhamkrai <srai@redhat.com>
2026-01-23 13:56:38 +05:30
Oded Viner 88a9bf5c7f nvmeof: add nvme-of gateway crd support
adds CephNVMeOFGateway crd for managing ceph nvme-of gateways.
supports configurable instances, placement, resources,
and networking options.

Signed-off-by: Oded Viner <oviner@redhat.com>
2026-01-20 13:19:18 +02:00
Travis Nielsen 4cd6416dab docs: example of application migration with dynamic pv
Document how to migrate an application with a dynamic
PV rather than a static PV, since static PVs have limitations
such as not supporting snapshots and clones.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-11-06 12:00:46 -07:00
Travis Nielsen dba69aab0a docs: example of application migration between clusters
Applications can be migrated between clusters that are
connecting to the same external Ceph cluster.
This is done with a static PV that can be mounted
by the application across the clusters.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-11-06 09:37:39 -07:00
Mathieu Parent d9109fb3b9 docs: fix storageclass ec link
Signed-off-by: Mathieu Parent <math.parent@gmail.com>
2025-10-24 16:57:57 +02:00
subhamkrai 1d4efa9392 csi: csi-addon no longer needed for network fence
with latest design for networkFence, no need for
csi-addons to be installed as the implementation
is moved to csi-drivers.

Signed-off-by: subhamkrai <srai@redhat.com>
2025-09-24 21:08:44 +05:30
Madhu Rajanna 3d024ce3c7 csi: update the csi-operator API
updating the csi operator API version
to latest version.

Adding the cephFS and RBD controllerPublish
secret that are required for the fencing
operation that is supported by ceph-csi
with csi-operator.

Updated the storageclass to include the
secrets incase if user wants to override
the defaults in the clientProfile for
new PVC's.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2025-08-13 09:30:50 +02:00
Zac Dover fb682e2e24 doc: block-storage.md: Add formatting to namespaces
Add formatting to some namespace names and provisioner values in order
to make the
Storage-Configuration/Block-Storage-RBD/block-storage/provision-storage
section more legible.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-12-04 13:39:06 +01:00
Madhu Rajanna 1d1ed5e962 csi: disable fencing in Rook
Disabling the RBD and CephFS fencing
in Rook for now as its having bugs where
Rook is blocklisting wrong IP address
due to timing issues.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-10-10 19:28:15 +02:00
Madhu Rajanna 266fd49c02 csi: update csi-addons repo link
updating csi-addons repo link
to pull the yamls for installation

closes: #14394

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-07-02 17:36:24 +02:00
Blaine Gardner c9d99e01a0 ci: use markdownlint to enforce mkdocs compatibility
mkdocs uses a markdown renderer that is hardcoded to 4 spaces per tab
for detecting indentation levels, including ordered- and
unordered-lists. Since we cannot easily change the renderer, begin using
a markdown linter in CI that will fail if official docs do not adhere to
the spacing rules.

As a starting point, the markdownlint config does not begin with the
default set of checks, which might overwhelm attempts to fix them.
Instead, focus on list-tab-spacing rules and a few other highly useful
checks.

markdownlint also has some gaps in its abilities that allow common Rook
doc issues to pass acceptance. However, it allows creating custom
linting plugins. Create 2 such linting plugins to check 2 things:

- all doc lines (except code blocks) must be aligned to a 4-space
  boundary, without exception. This ensures that markdown will render
  correctly with mkdocs. This unfortunately makes it possible to create
  lists that are internally aligned strangely.
- admonitions must all follow the same format of
  ```
  !!! header
      body
  ```

For the strange lists, this is allowed and renders correctly, but it
looks strange:

```md
- first bullet
- second bullet
    still second bullet
- third bullet

    has a paragraph
    of text inside

- last bullet

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-04-29 17:25:11 -06:00
Niels de Vos 1ca1257c65 csi: update the CSI-Addons sidecar to v0.8.0
Quite some improvements have been included in the recently released
v0.8.0 of the CSI-Addons sidecar for Kubernetes. Rook users will benefit
from running the latest version of the sidecar when deploying Ceph-CSI.

See-also: https://github.com/csi-addons/kubernetes-csi-addons/releases/tag/v0.8.0
Signed-off-by: Niels de Vos <ndevos@ibm.com>
2023-12-15 15:13:42 +01:00
subhamkrai 39b5c057ce core: faster recovery from rbd rwo node loss
in the existing node watcher, we'll check for node update
event and see if there are `out-of-service` taints are applied
and `ROOK_WATCH_FOR_NODE_FAILURE` is enabled in rook-ceph-operator-configmap,
if then we'll create the networkFence cr and delete the cr if nodes come back.
And, added the unit test too.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-07-07 21:16:25 +05:30
Travis Nielsen 2991ee1e61 docs: add link to failover and failback topic
A note in the rbd mirroring topic was missing a link
to the failover and failback doc.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-12-19 10:51:00 -07:00
Travis Nielsen 2c1645e66b Merge pull request #11324 from ideepika/wip-fix-nit
docs: update rbd-mirror doc
2022-11-17 11:06:00 -07:00
Deepika Upadhyay 2e048406ab docs: update rbd-mirror doc
the pool mentioned in docs didn't have hypen
doc ref: https://rook.io/docs/rook/v1.9/Storage-Configuration/Block-Storage-RBD/rbd-mirroring/#create-rbd-pools

[root@centos-4gb-hel1-1 rook]# kubectl get cephblockpool.ceph.rook.io/mirroredpool
Error from server (NotFound): cephblockpools.ceph.rook.io "mirroredpool" not found

Signed-off-by: Deepika Upadhyay <deepika@koor.tech>
2022-11-17 23:19:52 +05:30
Anthony D'Atri 10b398cc02 docs: add additional RBD image features to docs and YAML files
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-10-27 10:57:50 -06:00
yati1998 9b4361b379 rbdmirror: remove volume replication sidecar
The volume replication operator is being moved to
kubernetes-csi-addons. This commit hence, removes
the volume replication sidecar and updates the
related documentation.
It will also update the csi-addons sidecar version
to the latest one.

Closes: #10655

Signed-off-by: yati1998 <ypadia@redhat.com>
2022-09-07 14:49:19 +05:30
chienfuchen32 5ddca98460 docs: update Example Configurations Docs
Some link fixing in Example Configurations
Ref: https://rook.io/docs/rook/v1.9/Storage-Configuration/Block-Storage-RBD/rbd-mirroring/
     https://rook.io/docs/rook/v1.9/Getting-Started/example-configurations/#block-devices

Signed-off-by: chienfuchen32 <chienfuchen32@gmail.com>
2022-07-19 12:43:38 +08:00
Alexander Trost 74431443e3 docs: use mkdocs and restructure docs
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-05-18 16:06:22 +02:00