Docs: CRD Enhancements #2344

rakeshgm · 2025-11-20T16:09:24Z

This is based on the PR #2332 . This includes

DRCluster CRD Enhancements.
DRClusterConfig CRD Enhancements.
DRPolicy CRD Enhancements

Signed-off-by: Chris Blum <cblum@ibm.com> (cherry picked from commit 8e40c63) Signed-off-by: rakeshgm <rakeshgm@redhat.com>

raaizik · 2025-11-23T13:16:11Z

docs/drcluster-crd.md

+1. **S3 profile not found**
+
+    - Verify S3 profile name matches RamenConfig
+    - Check RamenConfig:
+
+        ```bash
+        kubectl get cm ramen-hub-operator-config -n ramen-system -o yaml
+        ```


Isn't that supposed to be handled in code with #1641? @ShyamsundarR

raaizik · 2025-11-23T13:18:41Z

docs/drcluster-crd.md

+
+1. **Configure S3 profiles carefully:**
+
+    - Test S3 connectivity before creating DRClusters


That's definitely supposed to be handled in code as part of #2046, among others

raaizik · 2025-11-23T13:21:49Z

docs/drclusterconfig-crd.md

+The **DRClusterConfig** custom resource provides cluster-specific
+disaster recovery configuration on managed clusters. It is a
+cluster-scoped resource that exists on each managed cluster (not on
+the hub) and serves two primary purposes:


I think the phrasing should be fixed to something else that adds the remark in parenthesis as a separate note perhaps. The way it's now makes it look like the two are mutually exclusive where it's not necessarily implied or understood right away to the reader.

raaizik · 2025-11-23T13:26:08Z

docs/drclusterconfig-crd.md

+**Requirements:**
+
+- Immutable after creation
+- Must be globally unique


Missing one (see #1819)

Suggested change

**Requirements:**

- Immutable after creation

- Must be globally unique

**Requirements:**

- Cannot be left blank

- Immutable after creation

- Must be globally unique

raaizik · 2025-11-23T13:28:03Z

docs/drclusterconfig-crd.md

+#### `clusterID` (string)
+
+The unique identifier for this cluster, derived from the kube-system
+namespace UID.
+
+**Source:** OCM ManagedCluster claim value for `id.k8s.io`


I'm wondering, post merge of #1854 -- will there still be a need to disclose this information in this manner? @ShyamsundarR

raaizik · 2025-11-23T13:30:35Z

docs/drclusterconfig-crd.md

+### `conditions` ([]metav1.Condition)
+
+Standard Kubernetes conditions.
+
+**Condition types:**
+
+- `Processed` - Configuration has been processed successfully
+- `Reachable` - S3 storage is reachable from this cluster


Hopefully this will update soon once #1641 is done

raaizik · 2025-11-23T13:32:28Z

docs/drclusterconfig-crd.md

+### S3 Not Reachable
+
+**Symptom:** `Reachable` condition is `False`.
+
+**Check:**
+
+1. **S3 secret exists:**
+
+   ```bash
+   kubectl get secret -n ramen-system | grep s3
+   ```
+
+1. **S3 credentials are correct:**
+
+   ```bash
+   kubectl get secret <s3-secret-name> -n ramen-system -o yaml
+   ```
+
+1. **Network connectivity to S3:**
+
+   ```bash
+   # Test from a pod
+   kubectl run -it --rm debug --image=amazon/aws-cli --restart=Never -- \
+     s3 ls --endpoint-url=https://s1.amazonaws.com s3://<bucket-name>
+   ```
+
+**Solution:** Verify S3 configuration in DRCluster and ensure network
+policies allow S3 access.


This will definitely be addressed in code instead of manual troubleshooting steps

raaizik · 2025-11-23T13:33:29Z

docs/drclusterconfig-crd.md

+### ClusterID Mismatch
+
+**Symptom:** Peer classes not matching across clusters.
+
+**Check:**
+
+```bash
+# Verify clusterID matches kube-system namespace UID
+kubectl get namespace kube-system -o jsonpath='{.metadata.uid}'
+kubectl get drclusterconfig drclusterconfig -o jsonpath='{.spec.clusterID}'
+```
+
+**Solution:** ClusterID should automatically match namespace UID. If not,
+check Ramen operator logs.


asn1809 · 2025-11-24T10:51:03Z

docs/drcluster-crd.md

+
+- When applications are active on this cluster, their PV metadata is stored
+    to S3 profiles of all peer clusters
+- When applications failover/relocate TO this cluster, PV metadata is


This needs to be re-worded? like secondary cluster instead of this cluster?

The CRD document talks in terms of singleton and this refers to the cluster in context of this document.

asn1809 · 2025-11-24T10:52:10Z

docs/drcluster-crd.md

+
+**Requirements:**
+
+- Must match an S3 profile name in RamenConfig


This is reverse right? The RamenConfig should be updated based on DRCluster's s3Profile.

Signed-off-by: rakeshgm <rakeshgm@redhat.com>

rakeshgm · 2025-11-26T09:54:18Z

@raaizik , can you review the DRClusterConfig CRD again. (doc is updated)

raaizik · 2025-11-26T15:06:06Z

@raaizik , can you review the DRClusterConfig CRD again. (doc is updated)

Sure. I see only some of my comments have been addressed though

Signed-off-by: rakeshgm <rakeshgm@redhat.com>

raaizik · 2025-12-04T13:30:37Z

LGTM

rakeshgm requested review from BenamarMk and ShyamsundarR as code owners November 20, 2025 16:09

write & update CRD docs

6aaf9d3

Signed-off-by: Chris Blum <cblum@ibm.com> (cherry picked from commit 8e40c63) Signed-off-by: rakeshgm <rakeshgm@redhat.com>

rakeshgm force-pushed the crd-docs branch from 922db5e to 3e7bb8d Compare November 20, 2025 16:11

rakeshgm requested review from abhijeet219 and asn1809 November 20, 2025 16:14

raaizik suggested changes Nov 23, 2025

View reviewed changes

asn1809 reviewed Nov 24, 2025

View reviewed changes

rakeshgm force-pushed the crd-docs branch 2 times, most recently from 8b7cb3d to 0159aad Compare November 26, 2025 09:42

enhance drcluster-crd doc

bcf0df6

Signed-off-by: rakeshgm <rakeshgm@redhat.com>

rakeshgm force-pushed the crd-docs branch from 0159aad to 4f0f251 Compare November 26, 2025 09:52

rakeshgm force-pushed the crd-docs branch from 4f0f251 to e0770c0 Compare December 3, 2025 14:28

raaizik approved these changes Dec 3, 2025

View reviewed changes

rakeshgm added 2 commits December 3, 2025 22:06

enhance drclusterConfig-crd doc

0873a72

Signed-off-by: rakeshgm <rakeshgm@redhat.com>

enhance drpolicy-crd doc

8a395f3

Signed-off-by: rakeshgm <rakeshgm@redhat.com>

rakeshgm force-pushed the crd-docs branch from e0770c0 to 8a395f3 Compare December 3, 2025 16:36


		1. Configure S3 profiles carefully:

		- Test S3 connectivity before creating DRClusters


		Requirements:

		- Must match an S3 profile name in RamenConfig

Docs: CRD Enhancements #2344

Are you sure you want to change the base?

Docs: CRD Enhancements #2344

Uh oh!

Conversation

rakeshgm commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

rakeshgm commented Nov 26, 2025

Uh oh!

raaizik commented Nov 26, 2025

Uh oh!

raaizik commented Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rakeshgm commented Nov 20, 2025 •

edited

Loading