Commit Graph
21 Commits
Author SHA1 Message Date
Mörgæsis 2497940603 docs: link to Ceph docs with incorrect heading link
Found that `#set-*` doesn't exist on the linked pages, but `#setting-*`
does.

Signed-off-by: Mörgæsis <morgaesis+git@morgaes.is>
2025-12-28 12:51:49 +00:00
Travis Nielsen c05768feb3 docs: add pool parameter for erasure code optimizations
Ceph Tentacle v20 comes with erasure coding optimizations
that must be enabled explicitly with a setting on the pool.
Add this setting to the docs and examples.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2025-12-04 11:42:07 -07:00
Madhu Rajanna a6be0c7b52 doc: update the existing document to set clusterID
Updating the existing document to set the clusterID
for cephfs and rbd storageclass.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2025-07-28 08:31:21 +02:00
Anthony D'Atri 202c1a253e doc: improve Documentation/CRDs/Block-Storage/ceph-block-pool-crd.md
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2025-05-01 14:58:11 -04:00
subhamkrai 420178fe3e rbdmirror: mirroring b/w implicit and defined ns
this commit add support for mirroring b/w implicit rados namespace and
defined rados namespace. To support this, rook will treat `<implicit>`
name on cephblockpool as `""` empty string. This will allow mirroring
b/w implicit and defined radosnamespace.

Signed-off-by: subhamkrai <srai@redhat.com>
2025-04-01 10:46:06 +05:30
Vilius Puškunalis a7f338505c docs: fix specific pool properties key name and config example
Fixes an example of setting specific pool properties where all values must be of type string. Also fixes the parameters key name.

Signed-off-by: Vilius Puškunalis <47086537+puskunalis@users.noreply.github.com>
2025-03-24 21:10:54 +02:00
parth-gr 9785ef5c8d rbdmirror: enable periodic monitoring for rados namespace
enable monitoring for rados namespace

Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-11-05 13:45:02 +05:30
parth-gr 2cef47a9b7 rbdmirror: enable rbd rados namespace mirroring
Modify the CR to allow mirroring of an rados namespace
to a differently named namespace on the remote cluster

1) enable rados namesapce mirroring only
if the blockpool mirrroing is enabled

2) disable blockpool mirroing only if
all the namesapce mirroing is disabled

if the rbd mirroring fails and ceph version is not supported
provide a error message with supported version details
and reason of failing

Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-10-10 14:23:11 +05:30
Deepika Upadhyay 8bb2c3b9f6 docs: add docs for enableCrushUpdates option
Signed-off-by: Deepika Upadhyay <deepikaupadhyay01@gmail.com>
2024-06-13 00:23:40 +05:30
8e7ac95f97 docs: document how to have StorageClass consume Rados Namespace
closes: https://github.com/rook/rook/issues/13214

Co-authored-by: Travis Nielsen <tnielsen@redhat.com>
Co-authored-by: Blaine Gardner <b.blaine.gardner@gmail.com>
Signed-off-by: Michael Adam <obnox@samba.org>
2024-05-18 12:21:56 +02:00
Michael Adam 10df932d62 docs: improve wording in BlockPoolRados Namespace CRD doc
Signed-off-by: Michael Adam <obnox@samba.org>
2024-05-07 12:43:57 +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
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 38981f2649 docs: clarify device class use on all pools
If the device class property is specified on any pool,
it must be specified on all pools so the pg autoscaler
will remain healthy.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-03-07 16:04:24 -07:00
Alexander Trost 787be917dc docs: fix ceph cluster crd list indentation issue
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2023-01-17 15:21:39 +01:00
Travis Nielsen 05590dfc9b docs: set crd page titles to crd name
The name of the CRD is more clear for finding the CRD specs
instead of a modified form of the name that was intended
to be more human readable. When someone is looking for the
CRD settings, they more naturally expect the CRD name
in the title

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-11-09 16:12:58 -07:00
Joshua Hoblitt 5b01da877c docs: fix html rendering of nested list items -- "because markdown"
Nested list items need to be intended 3 spaces in order for markdown to
consistently handle nested lists.

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
2022-08-25 08:51:26 -07:00
Josh Soref 6e7b8767f3 core: fix spelling
* another
* are
* availability
* available
* bootstrap
* boundaries
* ceph
* certificate
* class
* codifies
* consuming
* corrupted
* createor
* csi
* deployments
* exceeded
* execute
* filesystem
* healthiness
* heuristics
* immediately
* insecure
* installed
* isolated
* maintained
* maximum
* minute
* monitor
* new
* nginx
* nonexistent
* not
* occurs
* omitempty
* operator
* orchestration
* persistentvolumes
* placement
* preexisting
* prometheus
* protecting
* provisioner
* purposes
* reconcile
* regex
* related
* requests
* returns
* rubbish
* running
* schedulable
* schedule
* serviceaccount
* simulating
* snapshots
* statement
* static
* tenants
* the
* unavailable
* volumeattachment
* waiting
* with
* wrapper
* zonegroup

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-07-07 18:10:47 -04:00
Travis Nielsen dad97f3425 core: remove support for ceph octopus
With octopus coming to end of life, we remove support from
Rook for deploying Ceph Octopus and assume a min version of
Pacific v16. Any checks for octopus or earlier are removed
from the reconciles since they are obsolete.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-07-07 15:03:26 -06:00
Travis Nielsen 34ca5d661b docs: refactor cluster crd doc for subtopics
The cluster CR doc is extremely long and in need of refactoring.
Now we have four new sub-topics for a host-based cluster,
PVC-based cluster, stretch cluster, and an external cluster.
Each of those topics has its own description and examples.
The main cluster CR topic still contains the details about
all the possible cluster CR settings.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-06-27 17:04:54 -06: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