Skip to content

Commit

Permalink
docs: clarify the operator design doc a bit
Browse files Browse the repository at this point in the history
I the operator design document, custom resource definition(CRD) seems to have been used as a synonym
for custom resource(CR) which is usually not correct.

This change makes the wording a little clearer  by using CRD only when
technically correct and using CR when appropriate.

Signed-off-by: Michael Adam <[email protected]>
  • Loading branch information
obnoxxx committed Nov 7, 2024
1 parent e197b23 commit d37b777
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/design/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ graph TD

In this diagram:

- **CRD Changes**: Represents changes made to Custom Resource Definitions,
- **CR Changes**: Represents changes made to Custom Resources (CRs),
which trigger actions in the operator.
- **Operator**: Listens for changes in CRDs and initiates the installation and
- **Operator**: Listens for changes in CRs and initiates the installation and
configuration of CSI drivers.
- **Configure CephFS, NFS, RBD**: Actions performed by the operator to install
and configure the respective CSI drivers based on the CRD changes.
and configure the respective CSI drivers based on the CR changes.

## CRDs for ceph-csi-operator

Expand Down

0 comments on commit d37b777

Please sign in to comment.