Commit Graph
73 Commits
Author SHA1 Message Date
Travis Nielsen 5db8627aec docs: remove extra paren from upgrade guide
The upgrade guide had an extra paren after a link.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2026-01-13 12:29:21 -07:00
Travis Nielsen 76e9c04b36 csi: disable read affinity for ceph v20.2.0
Read affinity in Ceph v20.2.0 can cause corruption.
Disable this feature for this version of Ceph to
avoid hitting any corruption in this case. When the next
patch release is out for tentacle, this issue will be
resolved and when upgrading to it, read affinity would
automatically be re-enabled if needed.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2026-01-12 13:46:43 -07:00
Blaine Gardner 48e353b934 docs: update upgrade docs for v1.19
Update the upgrade docs for the upcoming Rook v1.19 release.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2026-01-12 09:12:31 -07:00
subhamkrai 304cdc8c83 core: remove support for reef v18 in Rook v1.19
For Rook v1.19,removing support for Ceph Reef. It is at end of life.
Users on Reef can continue to use Rook v1.18.x or older.
The latest two Ceph versions Squid and Tentacle are supported.

Signed-off-by: subhamkrai <srai@redhat.com>
2025-12-04 13:11:35 +05:30
Travis Nielsen 6a73afdc19 doc: add breaking helm change to upgrade guide for ceph image settings
The ceph image settings have moved outside the cephClusterSpec
section of the values overrides, to allow specifying the repository
or image tag that will be deployed. The cephVersion image settings
under the cephClusterSpec section of the values overrides must be
removed.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-10-07 14:59:59 -06:00
parth-gr 473b69eff3 doc: update the upgrade doc with the helm breaking change
Signed-off-by: parth-gr <partharora1010@gmail.com>
2025-09-10 21:15:32 +05:30
Travis Nielsen b856338c5e docs: csi operator deployment documentation
With the csi operator becoming the default for deployment,
the docs are now updated with the details in the quickstart
guide and upgrade guide to help with the transition.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-08-13 16:06:15 -06:00
Travis Nielsen ba30d383dc docs: upgrade guide support from 1.17 to 1.18
With the pending 1.18 release, the upgrade guide now
documents considerations for the upgrade from
v1.17 to v1.18.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-08-04 16:30:13 -06:00
Travis Nielsen 66a006b99c core: update ceph version to v19.2.3
With the new squid patch release, update the base
image, the docs, and the examples to all use the latest
stable Ceph release v19.2.3.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-07-29 11:51:11 -06:00
Deepika Upadhyay 984ae7a0f3 docs: clarify Ceph version support phrasing in release notes
Signed-off-by: Deepika Upadhyay <deepika.upadhyay@clyso.com>
2025-06-18 23:12:12 +05:30
Joshua Hoblitt 02c65b832e doc: add CephBucketTopic kafka mechanism field to upgrade docs
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
2025-04-14 16:08:58 -07:00
Travis Nielsen f62e6d9cc2 core: set default ceph version to v19.2.2
Update the examples and docs and operator base image to
the latest ceph release v19.2.2.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-04-14 12:59:39 -06:00
Blaine Gardner deb9838324 doc: update release notes and upgrade docs
Update pending release notes and upgrade docs for v1.17.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2025-04-07 09:57:20 -06:00
Patryk Rostkowski 20f2af02ee docs: add comprehensive Rook Ceph cluster maintenance guide
- Introduced a detailed markdown document outlining
  procedures for safe cluster shutdown and restart
  as per https://github.com/rook/rook/issues/14995
- Document includes steps to scale down applications,
  set Ceph flags, and orderly shutdown of Ceph
  components (operator, RGW, CSI, OSD, MON, MGR).
- Provides command examples for both scaling
  down and scaling up deployments.
- Adds additional Q&A and best practices to help
  cluster administrators manage maintenance with
  minimal downtime.

Signed-off-by: Patryk Rostkowski <patrostkowski@gmail.com>
2025-02-25 21:52:25 +01:00
subhamkrai 0e395f0a67 manifest: update default ceph version to v19.2.1
with ceph release v19.2.1 updating it to be dafult version
in rook.

Signed-off-by: subhamkrai <srai@redhat.com>
2025-02-20 23:24:54 +05:30
Travis Nielsen 26ff895f0a docs: remove obsolete min csi version
The csi version is no longer checked by Rook. If the user
changes the default csi version, it's their responsibility
to ensure it is updated according to the upgrade guide,
we just don't officially have a min version anymore.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-12-17 12:39:32 -07:00
Travis Nielsen 07d8012d36 manifest: update default ceph version to v19
With the v19.2.0 release being out for some time now,
update the default version to be deployed with Rook
as v19.2.0.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-12-11 14:45:26 -07:00
Blaine Gardner 9bf562c253 docs: update guides and examples for v1.16 release
Update upgrade guides, docs, and exmaple manifests for the Rook v1.16
release.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-12-09 11:57:08 -07:00
Blaine Gardner 5539eedd1b multus: finish deprecating holder pods
Finish the process of deprecating holder pods by removing Rook's ability
to deploy them. The intent of this change is to make the most
superficial changes possible to accomplish this. There are still
remnants of code in Rook (particularly the CSI controller) that helped
configure or deploy holder pods. Due to the risk of breaking some
features, cleanup work of hose remnants will be deferred for future
work.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-10-23 16:29:02 -06:00
Travis Nielsen b665d7a7b7 core: remove support for ceph quincy
Given that Ceph Quincy (v17) is past end of life,
remove Quincy from the supported Ceph versions,
examples, and documentation.

Supported versions now include only Reef and Squid.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-10-03 11:12:55 -06:00
Blaine Gardner 6026fb1c36 docs: update upgrade docs for v1.15
Update Rook and Ceph upgrade docs for upcoming v1.15 release.
Tidy up pending release notes in the working text as well as official
doc texts.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-08-13 10:47:58 -06:00
Travis Nielsen e26920a483 manifest: update the ceph recommended version to v18.2.4
Since Reef v18.2.4 is released, set it to the default
ceph version that is deployed with Rook.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-07-24 11:06:09 -06: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
Blaine Gardner e11f81e5f2 Merge pull request #14023 from BlaineEXE/doc-network-csi-host-net-not-supported
doc: make CSI host netowrking required
2024-04-04 13:57:13 -06:00
Blaine Gardner 519c7e8911 doc: make CSI host netowrking required
The network providers doc, including the holder pod migration sections,
were developed with the understanding that CSI could be placed into pod
networking mode if desired by users. In reality, this hasn't been
supported due to bugs.

This allows streamlining the holder pod migration sections to no longer
need to document for users what to do if they use CSI in pod network
mode.

Rook will continue to have the `CSI_ENABLE_HOST_NETWORK` config
available as an undocumented value. This can allow users who desperately
cannot use host networking to still use pod networking, though this will
mean any CSI node plugin updates could stall mounts for running apps.
Thus we do not support it.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-04-03 12:19:15 -06:00
Travis Nielsen 64f71d9258 helm: separate repository and tags for csi images
The csi images in the operator helm chart previously were a single
image name including the repository and tag in a single string.
Now the repository and tag values are separated to allow for
greater customization of the repository from the version tags.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-04-03 11:43:11 -06:00
Blaine Gardner 0736d7613d doc: update release notes and upgrade docs for v1.14
Update pending release notes, upgrade docs, and supplementary
documentation relevant for upgrades for the upcoming Rook v1.14 release.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-04-02 12:25:24 -06:00
Blaine Gardner 4f555dbbcb csi: allow force disabling holder pods
Add new CSI_DISABLE_HOLDER_PODS option for rook-ceph-operator.
This option will disable holder pods when set to "true".

In the long term, Rook plans to deprecate the holder pods entirely.
This new option will allow users to choose to migrate their clusters to
non-holder clusters when they are ready and able, giving them time to
gracefully migrate before the holders are permanently removed.

This option is set to "false" by default so that upgrading users don't
have their CSI pods modified unexpectedly.
Example manifests are modified to set this value to true so that new
clusters will not deploy holder pods.

Migrating users are provided with documentation to instruct them about
the new requirements they need to satisfy to successfully remove holder
pods, a procedure for migrating pods from holder to non-holder mounts,
and a way to delete holder pods once they are no longer in use.

When users set CSI_DISABLE_HOLDER_PODS="true", the CSI controller will
no longer deploy or update the holder pod Daemonsets, but it does not
delete any existing Daemonsets. This allows already-attached PVCs to
continue operating normally with their network connection continuing to
exist in the current holder pod. This is critical to avoid causing
ia cluster-wide storage outage.

More info: https://github.com/rook/rook/issues/13055

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2024-03-14 09:53:08 -06:00
Travis Nielsen 026d745f8a core: set default ceph version to v18.2.2
With the release of Reef v18.2.2 we update the default
recommended version of Ceph to fix the prometheus issues
seen with v18.2.1

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-03-11 11:06:59 -06:00
travisn 806608cdbc pool: allow setting the application on a pool
Rook has been setting the application automatically on all
pools to rbd for CephBlockPools, rook-ceph-rgw for
CephObjectStores, mgr on the built-in .mgr pool,
and nfs on the built-in .nfs pool.

The legacy pool device_health_metrics is long gone
from Pacific which is no longer supported, so we can
remove special handling for that pool in the upgrade
guide and in the code.

The application setting is now available on the pool spec
although it is not expected to commonly need to override
the default applications set by Rook.

The application for CephFilesystem pools is now being
set to cephfs, where it was previously blank.

Signed-off-by: travisn <tnielsen@redhat.com>
2024-02-14 16:53:25 -07:00
travisn 56a3370d83 docs: update all examples to ceph v18.2.1
Since v18.2.1 is the default recommendation for the ceph version,
update all the docs and examples to that version.

Signed-off-by: travisn <tnielsen@redhat.com>
2024-01-03 14:37:11 -07:00
Kyle Fazzari ce6baa4f31 docs: specify that rook-ceph helm chart should be upgraded first
Today, it's unclear that there is an expected order of operation when it
comes up upgrades. In reality, the `rook-ceph` helm chart includes the
operator, which should have the opportunity to update any custom
resources before the `rook-ceph-cluster` is upgraded.

Signed-off-by: Kyle Fazzari <kyrofa@ubuntu.com>
2023-12-13 13:09:14 -08:00
Blaine Gardner 06d18a7122 docs: update upgrade docs for v1.13 release
Update docs for the upcoming v1.13 release.

Ensure that the pending release doc has critical notes.

Ensure upgrade guide versions are updated and tested.

Clarify some minor documentation points regarding features present in pending release doc.

Special care has been taken to update notes and docs for removal of the admission controller, which may be confusing for the estimated-small number of acive users.

Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
2023-12-08 14:12:20 -07:00
subhamkrai 28cc1ebc55 core: remove webhook & controller-runtime from apis
This commits removes controller-runtime dependencies
from the apis dir and to achieve that we are removing
webhook.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-12-01 14:15:40 +05:30
travisn 03d077aa6b core: remove support for ceph pacific
Pacific is end of life and no longer necessary to
support in Rook with v1.13.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-11-14 17:07:03 -07:00
Redouane Kachach 0e132f45a6 docs: adding specific instructions to upgrade Rook toolbox
Closes: https://github.com/rook/rook/issues/13010

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2023-10-18 14:33:46 +02:00
Rakshith R a2113684e4 docs: add note in upgrade guide about cephfs driver's breaking change
CephCSI CephFS introduced a breaking change in v3.9.0.
This commit adds a note in upgrade guide regarding the same.

refer: https://github.com/ceph/ceph-csi/blob/v3.9.0/docs/ \
       ceph-csi-upgrade.md/#upgrading-cephfs

Signed-off-by: Rakshith R <rar@redhat.com>
2023-08-01 10:52:56 +05:30
Blaine Gardner 03d8fcf932 docs: use imperative language in health verifcation doc
Following with the latest efforts to improve Rook docs, convert the
health verification doc to use imperative language and avoid use of "you".

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-07-17 10:52:27 -06:00
Blaine Gardner 5a1f3f7b8c docs: use imperative language in rook/ceph upgrade docs
Following with the latest efforts to improve Rook docs, convert the Rook
and Ceph upgrade docs to use imperative language and avoid use of "you".

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-07-17 10:52:24 -06:00
Blaine Gardner b3438a8b60 docs: update upgrade docs to add ceph reef support
Ceph Reef v18 is supported by Rook v1.12 even though it is still in
pre-release. Add Reef support to docs, and note that Pacific support
will be dropped in the next Rook release.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-07-17 10:52:01 -06:00
Rakshith R 1af70aca60 csi: update cephcsi to v3.9.0
This commit updates cephcsi image to
v3.9.0 release and also removes support
for v3.7.x.

refer:
https://github.com/ceph/ceph-csi/releases/tag/v3.8.0

Signed-off-by: Rakshith R <rar@redhat.com>
2023-06-28 20:38:29 +05:30
Sheetal Pamecha eee31f2b72 ci: update the minimum kubernetes version supported
For v1.12 update the minimum K8s version supported to v1.22,
and run CI against the most recent six versions.

Signed-off-by: Sheetal Pamecha <spamecha@redhat.com>
2023-06-25 22:01:40 +05:30
Sheetal Pamecha b7eb449e7f docs: update the upgrade guide for the v1.12 release
Signed-off-by: Sheetal Pamecha <spamecha@redhat.com>
2023-06-13 03:13:09 +05:30
Blaine Gardner 6500c11d57 nfs: pare down config file volume sources
Pare down the available volume sources for NFS config files so that the
CRD isn't unnecessarily huge. This allows us to recommend
`kubectl apply` again in the upgrade doc.

Size of the NFS CRD is reduced by approximately 60%.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-05-02 11:34:24 -06:00
travisn 609ac91cb1 core: update default image to ceph v17.2.6
With the release of ceph v17.2.6, the examples and the base
image for the operator are updated to pick up the latest
and greatest.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-04-11 14:07:11 -06:00
Blaine Gardner 38f896ea30 docs: use kubectl replace instead of apply for crd updates
'kubectl apply --server-side' still doesn't always update CRDs
correctly if a CRD is too big to have its last applied annotation. Use
'kubectl replace' instead.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-02-27 14:54:01 -07:00
parth-grandBlaine Gardner 69ae9569cd build: update k8s version to 1.26.1
Update the Kubernetes API version used to 1.26.1, and start testing
against Kubernetes version 1.26.1 in CI.

Co-authored-by: parth-gr <paarora@redhat.com>
Co-authored-by: Blaine Gardner <blaine.gardner@redhat.com>

Signed-off-by: parth-gr <paarora@redhat.com>
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-02-23 20:18:47 -07:00
Madhu Rajanna b01180580c csi: update cephcsi to v3.8.0
updating the cephcsi image to v3.8.0
release and also removing support for
3.6.0 as its deprecated and not supported
any more.

More details at
https://github.com/ceph/ceph-csi/releases/tag/v3.8.0
and https://github.com/ceph/ceph-csi/tree/release-v3.8
\#ceph-csi-container-images-and-release-compatibility

fixes #11688

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-02-22 15:49:36 +01:00
Blaine Gardner a2009fc0af Merge pull request #11734 from BlaineEXE/doc-update-release-helm
doc: add helm supported version note to upgrade doc
2023-02-21 13:29:04 -07:00
Blaine Gardner 1d3880322b docs: add helm supported version note to upgrade doc
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2023-02-21 13:26:22 -07:00