Merge pull request #16317 from rook/mergify/bp/release-1.18/pr-16312

docs: minor syntax fixes for CephCluster CRD documentation (backport #16312)
This commit is contained in:
Travis Nielsen authored and GitHub committed 2025-08-14 09:07:13 -06:00
commit 1851dd033f
1 file changed
+8 -7
@@ -180,7 +180,7 @@ A specific will contain a specific release of Ceph as well as security fixes fro
**Note:** Configuring this section applies specific affinity rules to assign each mon to one
of the specified zones. When this section is used, there is no need to define mon placement
under the[Placement Configuration Settings](#placement-configuration-settings), as the zone
under the [Placement Configuration Settings](#placement-configuration-settings), as the zone
settings will take precedence.
* `stretchCluster`: The stretch cluster settings that define the zones (or other failure domain labels) across which to configure the cluster.
@@ -421,10 +421,11 @@ Neither will the `arbiter` placement be merged with the `all` placement to allow
The remaining mons will still use the `mon` and/or `all` sections.
Other considerations of the placement settings include:
- If OSDs are defined using `storageClassDeviceSets`, placement settings must be specified within each device set and the `osd` key here will be ignored.
- If OSDs are created via other settings (e.g., `useAllDevices` or `storage.nodes`), the `osd` key in this section applies.
- When `zones` are configured in the `mon` settings, specific affinity rules are automatically generated to assign each mon to one of the defined zones, without needing to configure this section.
- Other components from separate CRDs, such as metadata servers in the `CephFilesystem` CRD, have their own placement configurations and are not affected by this section, even if the `all` key is used.
- If OSDs are defined using `storageClassDeviceSets`, placement settings must be specified within each device set and the `osd` key here will be ignored.
- If OSDs are created via other settings (e.g., `useAllDevices` or `storage.nodes`), the `osd` key in this section applies.
- When `zones` are configured in the `mon` settings, specific affinity rules are automatically generated to assign each mon to one of the defined zones, without needing to configure this section.
- Other components from separate CRDs, such as metadata servers in the `CephFilesystem` CRD, have their own placement configurations and are not affected by this section, even if the `all` key is used.
A Placement configuration is specified (according to the kubernetes PodSpec) as:
@@ -441,8 +442,8 @@ The Rook Ceph operator creates a Job called `rook-ceph-detect-version` to detect
#### Placement Example
To control where various services will be scheduled by kubernetes, use the placement configuration sections below.
The example under 'all' would have all services scheduled on kubernetes nodes labeled with 'role=storage-node`.
Specific node affinity and tolerations that only apply to the`mon`daemons in this example require the label
The example under 'all' would have all services scheduled on kubernetes nodes labeled with `role=storage-node`.
Specific node affinity and tolerations that only apply to the `mon` daemons in this example require the label
`role=storage-mon-node` and also tolerate the control plane taint.
```yaml