Skip to content

Commit

Permalink
Merge pull request rook#14752 from travisn/config-doc
Browse files Browse the repository at this point in the history
docs: Declare cephconfig settings stable
  • Loading branch information
travisn authored Sep 30, 2024
2 parents 0481c8f + 1c9727c commit fc8e500
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 11 additions & 3 deletions Documentation/CRDs/Cluster/ceph-cluster-crd.md
Original file line number Diff line number Diff line change
Expand Up @@ -825,9 +825,6 @@ set the `allowUninstallWithVolumes` to true under `spec.CleanupPolicy`.

## Ceph Config

!!! attention
This feature is experimental.

The Ceph config options are applied after the MONs are all in quorum and running.
To set Ceph config options, you can add them to your `CephCluster` spec as shown below.
See the [Ceph config reference](https://docs.ceph.com/en/latest/rados/configuration/general-config-ref/)
Expand All @@ -848,6 +845,17 @@ spec:
osd_max_scrubs: "10"
```

The Rook operator will actively apply these values, whereas the
[ceph.conf settings](../../Storage-Configuration/Advanced/ceph-configuration/#custom-cephconf-settings)
only take effect after the Ceph daemon pods are restarted.

If both these `cephConfig` and [ceph.conf settings](../../Storage-Configuration/Advanced/ceph-configuration/#custom-cephconf-settings)
are applied, the `cephConfig` settings will take higher precedence if there is an overlap.

If Ceph settings need to be applied to mons before quorum is initially created, the
[ceph.conf settings](../../Storage-Configuration/Advanced/ceph-configuration/#custom-cephconf-settings)
should be used instead.

!!! warning
Rook performs no direct validation on these config options, so the validity of the settings is the
user's responsibility.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ ceph osd pool set rbd pg_num 512

## Custom `ceph.conf` Settings

!!! warning
!!! info
The advised method for controlling Ceph configuration is to use the [`cephConfig:` structure](../../CRDs/Cluster/ceph-cluster-crd.md#ceph-config)
in the `CephCluster` CRD.
<br><br>It is highly recommended that this only be used when absolutely necessary and that the `config` be
Expand Down

0 comments on commit fc8e500

Please sign in to comment.