Implement the changes for ClientProfileReplication by rewantsoni · Pull Request #522 · ceph/ceph-csi-operator

rewantsoni · 2026-06-25T10:14:48Z

Describe what this PR does

Implement the changes for clientProfileReplication. The doc for the design was added in the PR #489

Is there anything that requires special attention

Is the change backward compatible?
Yes, the clientProfileMapping works along with clientProfileReplication.

Are there concerns around backward compatibility?
No.

Provide any external context for the change, if any.

Checklist:

Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
Reviewed the developer guide on Submitting a Pull Request
Pending release notes updated with breaking and/or notable changes for the next major release.
Documentation has been updated, if necessary.
Unit tests have been added, if necessary.
Integration tests have been added, if necessary.

rewantsoni · 2026-06-30T07:10:55Z

Testing:

rewantsoni@Rewants-MacBook-Pro ~/work/odf/ceph-csi-operator api-replication* ❯ k get clientprofile -oyaml
apiVersion: v1
items:
- apiVersion: csi.ceph.io/v1
  kind: ClientProfile
  metadata:
    creationTimestamp: "2026-06-30T06:54:32Z"
    finalizers:
    - csi.ceph.com/cleanup
    generation: 1
    name: clientprofile-sample
    namespace: ceph-csi-operator-system
    resourceVersion: "14150"
    uid: cdbb0f39-8816-456f-90fc-08b888b3848e
  spec:
    cephConnectionRef:
      name: cephconnection-sample
    rbd:
      radosNamespace: dummy
  status:
    message: ClientProfile reconciled successfully
    phase: Ready
kind: List
metadata:
  resourceVersion: ""
---
rewantsoni@Rewants-MacBook-Pro ~/work/odf/ceph-csi-operator api-replication* ❯ k get clientprofilereplication -oyaml
apiVersion: v1
items:
- apiVersion: csi.ceph.io/v1
  kind: ClientProfileReplication
  metadata:
    creationTimestamp: "2026-06-30T07:03:07Z"
    generation: 1
    name: clientprofilereplication-sample
    namespace: ceph-csi-operator-system
    resourceVersion: "16131"
    uid: 335bf9d2-86ec-4877-813d-96f690d2cd3e
  spec:
    localClientProfile: clientprofile-sample
    rbd:
      poolMapping:
      - name: pool1
        remoteID: "1"
      - name: pool2
        remoteID: "2"
    remoteClientProfile: clientprofile-sample-remote
  status:
    message: accepted
    phase: Ready
kind: List
metadata:
  resourceVersion: ""
---
rewantsoni@Rewants-MacBook-Pro ~/work/odf/ceph-csi-operator api-replication* ❯ k get cm ceph-csi-config -oyaml | yq '.data."config.json"' | jq
[
  {
    "clusterID": "clientprofile-sample",
    "monitors": [
      "10.0.43.14:3300"
    ],
    "cephFS": {
      "kernelMountOptions": "",
      "fuseMountOptions": "",
      "controllerPublishSecretRef": {}
    },
    "rbd": {
      "radosNamespace": "dummy",
      "controllerPublishSecretRef": {},
      "nodePublishSecretRef": {}
    },
    "nfs": {},
    "nvmeof": {
      "controllerPublishSecretRef": {}
    },
    "readAffinity": {},
    "replicationDestination": {
      "remoteClusterID": "clientprofile-sample-remote",
      "rbd": {
        "remotePoolMapping": {
          "pool1": {
            "poolID": "1"
          },
          "pool2": {
            "poolID": "2"
          }
        }
      }
    }
  }
]


**Multiple ClientProfileReplication**

apiVersion: v1
items:
- apiVersion: csi.ceph.io/v1
  kind: ClientProfileReplication
  metadata:
    creationTimestamp: "2026-06-30T07:03:07Z"
    generation: 1
    name: clientprofilereplication-sample
    namespace: ceph-csi-operator-system
    resourceVersion: "16131"
    uid: 335bf9d2-86ec-4877-813d-96f690d2cd3e
  spec:
    localClientProfile: clientprofile-sample
    rbd:
      poolMapping:
      - name: pool1
        remoteID: "1"
      - name: pool2
        remoteID: "2"
    remoteClientProfile: clientprofile-sample-remote
  status:
    message: accepted
    phase: Ready
- apiVersion: csi.ceph.io/v1
  kind: ClientProfileReplication
  metadata:
    creationTimestamp: "2026-06-30T07:07:53Z"
    generation: 1
    name: clientprofilereplication-sample-2
    namespace: ceph-csi-operator-system
    resourceVersion: "17703"
    uid: f6b9b163-796a-4691-96f4-e6b0836af4e7
  spec:
    localClientProfile: clientprofile-sample
    remoteClientProfile: clientprofile-sample-remote
  status:
    message: 'rejected: another ClientProfileReplication ''clientprofilereplication-sample''
      is already active for localClientProfile ''clientprofile-sample'''
    phase: Rejected
kind: List
metadata:
  resourceVersion: ""

Madhu-1

Please update the documentation and helm charts for this new CR creation

Madhu-1 · 2026-07-07T04:59:59Z

@@ -0,0 +1,108 @@
+/*
+Copyright 2024.


Madhu-1 · 2026-07-07T05:19:58Z

+    app.kubernetes.io/managed-by: kustomize
+  name: clientprofilereplication-sample
+spec:
+  # TODO(user): Add fields here


add an example here

Madhu-1 · 2026-07-07T05:21:49Z

+	RBD             *remoteRBDDetails `json:"rbd,omitempty"`
+}
+
+type remoteRBDDetails struct {


RBD ro Rbd

Madhu-1 · 2026-07-07T05:26:11Z

@@ -0,0 +1,219 @@
+/*
+Copyright 2024.


Madhu-1 · 2026-07-07T05:29:19Z

+	// Step 3: Conflict detection - oldest CR wins
+	// Sort by creation timestamp (oldest first)
+	sort.Slice(cprList.Items, func(i, j int) bool {
+		return cprList.Items[i].CreationTimestamp.Before(&cprList.Items[j].CreationTimestamp)


creation timestamp will be in seconds? can we also consider the name of the CR as tie breaker to get the same sorted slice always

It will be in timestamp format, so it will capture seconds as well, yes I will add the CR name as well as a tie breaker

Madhu-1 · 2026-07-07T05:31:30Z

+			r.clientProfile.Status.Phase = csiv1.ClientProfilePhaseFailed
+			r.clientProfile.Status.Message = fmt.Sprintf("failed to remove finalizer: %v", err)
 			return err
 		}


dont we need return nil here to avoid status update to Ready for cleanup?

The status will be updated irrespective what the reconcile returns

After removing the finalizer we should not be setting the status as Ready

Madhu-1 · 2026-07-07T05:33:03Z

+		}
+	}
+
+	if len(readyCRs) > 1 {


this need to be moved below cleanup?

Madhu-1 · 2026-07-07T05:44:24Z

+	// Step 4: Update status based on whether this CR is the winner
+	if r.clientProfileReplication.Name == winner.Name && r.clientProfileReplication.Namespace == winner.Namespace {
+		r.log.Info("this CR is the winner, marking as Ready")
+		r.clientProfileReplication.Status.Phase = csiv1.ClientProfileReplicationPhaseReady


dont we need finalizers on the CR to ensure we dont leave any stale values in the configmap?

When the clientProfileReplication is deleted, it will also trigger the clientProfile controller so it should eventually update the configmap to remove the value

what about the controller restart, if it works between restarts we are good

The record is constructed each time and is overwritten. So if a clientProfileReplication is deleted when controller is down, as soon as controller is brought up again it will be removed from the configmap

Madhu-1 · 2026-07-07T05:48:21Z


+	reconcileErr := r.reconcilePhases()
+
+	statusErr := r.Status().Update(r.ctx, &r.clientProfile)


in line 196, can we add finalizer only when r.cleanup is not set

this commit does the following: 1. add the api changes required for clientProfileReplication and ClientProfile 2. Scaffolding the api/controller 3. add the generated changes Signed-off-by: Rewant Soni <resoni@redhat.com>

implement the clientProfileReplication controller Signed-off-by: Rewant Soni <resoni@redhat.com>

add clientProfile controller implementation to add the replicationDestinationInfo to the ceph csi configmap Signed-off-by: Rewant Soni <resoni@redhat.com>

Signed-off-by: Rewant Soni <resoni@redhat.com>

rewantsoni changed the title ~~Api replication~~ Implement the changes for ClientProfileReplication Jun 25, 2026

rewantsoni force-pushed the api-replication branch 2 times, most recently from 11f55b2 to 13d5e15 Compare June 29, 2026 14:32

rewantsoni marked this pull request as ready for review June 30, 2026 07:11

Madhu-1 reviewed Jul 7, 2026

View reviewed changes

rewantsoni force-pushed the api-replication branch 2 times, most recently from 74c24dd to a2b3e90 Compare July 8, 2026 08:46

rewantsoni requested a review from Madhu-1 July 9, 2026 16:27

rewantsoni force-pushed the api-replication branch from a2b3e90 to 0151403 Compare July 10, 2026 03:45

rewantsoni added 6 commits July 16, 2026 14:10

api: add the api changes for clientProfileReplication

c74492c

this commit does the following: 1. add the api changes required for clientProfileReplication and ClientProfile 2. Scaffolding the api/controller 3. add the generated changes Signed-off-by: Rewant Soni <resoni@redhat.com>

controller: add implementation for clientProfileReplication

9c5a941

implement the clientProfileReplication controller Signed-off-by: Rewant Soni <resoni@redhat.com>

controller: add clientProfile controller implementation

c648cd9

add clientProfile controller implementation to add the replicationDestinationInfo to the ceph csi configmap Signed-off-by: Rewant Soni <resoni@redhat.com>

add unit tests

c3ee170

Signed-off-by: Rewant Soni <resoni@redhat.com>

docs: add to pending release notes

725bdbf

Signed-off-by: Rewant Soni <resoni@redhat.com>

add generated changes

76164fb

Signed-off-by: Rewant Soni <resoni@redhat.com>

rewantsoni force-pushed the api-replication branch from 0151403 to 76164fb Compare July 16, 2026 08:42

This was referenced Jul 16, 2026

create and own clientprofilereplication from ceph csi op red-hat-storage/ocs-client-operator#674

Open

distribute clientProfileReplication when rdr is enabled red-hat-storage/ocs-operator#4041

Open


		reconcileErr := r.reconcilePhases()

		statusErr := r.Status().Update(r.ctx, &r.clientProfile)

Uh oh!

Conversation

rewantsoni commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe what this PR does

Is there anything that requires special attention

Uh oh!

rewantsoni commented Jun 30, 2026

Uh oh!

Madhu-1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rewantsoni commented Jun 25, 2026 •

edited

Loading