Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update doc for disaster recovery #4905

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

yati1998
Copy link
Contributor

Volume Replication has been added to csi-addons
as a feature in it sometime back. But the doc still uses the volume replication operator to enable
mirroring and create related resources for
disaster recovery.
this commit updates the document to use csi-addons instead of creating volumereplication sidecar.

@yati1998 yati1998 requested a review from Madhu-1 October 14, 2024 03:24
@mergify mergify bot added ci/skip/e2e skip running e2e CI jobs ci/skip/multi-arch-build skip building on multiple architectures component/docs Issues and PRs related to documentation labels Oct 14, 2024
@yati1998 yati1998 force-pushed the mirror-doc branch 4 times, most recently from 415bc44 to 8617034 Compare October 14, 2024 05:55
```

``` bash
kubectl edit cm rook-ceph-operator-config -nrook-ceph
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cephcsi doesnt should not use Rook

docs/disaster-recovery.md Outdated Show resolved Hide resolved
docs/disaster-recovery.md Outdated Show resolved Hide resolved
CSI-Addons supports the Volume Replication feature that provides common
and reusable APIs for storage disaster recovery.
It is based on [csi-addons/spec](https://github.com/csi-addons/spec) specification
and can be used by any storage provider.

>:bulb: For more information, please refer to the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

point to the csi-addons operator replication doc

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/disaster-recovery.md Outdated Show resolved Hide resolved
docs/disaster-recovery.md Outdated Show resolved Hide resolved
Comment on lines 27 to 28
>:bulb: For more information, please refer to the
> [volume-replication-operator](https://github.com/csi-addons/volume-replication-operator).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still pointing to the volume-replication-operator which is replaced by csi-addons, can you please change this to point to replication doc in kubernetes-csi-addons

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no proper documentation which covers the volume replication functionality, it is just the doc that has yaml structure. We will first need to update that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets update the required documentation in kuberenetes-csi-addons(copy/paste) and remove the reference from here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works, will update

Volume Replication has been added to csi-addons
as a feature in it sometime back. But the doc still
uses the volume replication operator to enable
mirroring and create related resources for
disaster recovery.
this commit updates the document to use csi-addons
instead of creating volumereplication sidecar.

Signed-off-by: yati1998 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/skip/e2e skip running e2e CI jobs ci/skip/multi-arch-build skip building on multiple architectures component/docs Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants