https://github.com/dell/csm-replication
Dell Container Storage Modules (CSM) for Replication aims at extending native Kubernetes functionality to support Disaster Recovery workflows by utilizing storage array based replication.
https://github.com/dell/csm-replication
Last synced: 7 months ago
JSON representation
Dell Container Storage Modules (CSM) for Replication aims at extending native Kubernetes functionality to support Disaster Recovery workflows by utilizing storage array based replication.
- Host: GitHub
- URL: https://github.com/dell/csm-replication
- Owner: dell
- License: apache-2.0
- Created: 2021-06-02T17:14:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-10T05:36:31.000Z (7 months ago)
- Last Synced: 2025-06-10T06:25:27.849Z (7 months ago)
- Language: Go
- Homepage:
- Size: 20.1 MB
- Stars: 12
- Watchers: 17
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Dell Container Storage Modules (CSM) for Replication
[](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
[](LICENSE)
[](https://hub.docker.com/r/dellemc/dell-csi-replicator)
[](go.mod)
[](https://github.com/dell/csm-replication/releases/latest)
Dell CSM for Replication is part of the [CSM (Container Storage Modules)](https://github.com/dell/csm) open-source suite of Kubernetes storage enablers for Dell products.
This project aims at extending native Kubernetes functionality to support _Disaster Recovery_ workflows by utilizing storage array based replication.
CSM Replication project includes the following components:
* CSM Replication CRDs - [Custom Resource definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
* CSM Replication sidecar container for CSI drivers
* CSM Replication Controller - Multi-Cluster Controller
* repctl - helper utility for setup and queries
_*CSM Replication*_ sidecar is installed as part of the CSI driver controller pod and utilizes custom Dell CSI extensions to communicate
with Dell CSI drivers. It includes a set of Kubernetes controllers which keep watch on requests related to Persistent Volumes (PVs)
and Persistent Volume Claims(PVCs). It uses `dell-csi-extensions` APIs to perform replication related actions.
You can read more about the extensions [here](https://github.com/dell/dell-csi-extensions).
_*CSM Replication Controller*_ is a set of Kubernetes controllers which are _multi-cluster_ aware and can communicate with various Kubernetes API servers
to reconcile state. These controllers are responsible for the syncing of objects and the associated metadata.
This project has been created using [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder), and the various kubernetes controllers
have been implemented using [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). Additionally, this project uses [kustomize](https://github.com/kubernetes-sigs/kustomize) for generating various `yaml` manifests for Kubernetes objects.
For documentation, please visit [Container Storage Modules documentation](https://dell.github.io/csm-docs/).
## Table of Contents
* [Code of Conduct](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
* [Maintainer Guide](https://github.com/dell/csm/blob/main/docs/MAINTAINER_GUIDE.md)
* [Committer Guide](https://github.com/dell/csm/blob/main/docs/COMMITTER_GUIDE.md)
* [Contributing Guide](https://github.com/dell/csm/blob/main/docs/CONTRIBUTING.md)
* [List of Adopters](https://github.com/dell/csm/blob/main/docs/ADOPTERS.md)
* [Dell support](https://www.dell.com/support/incidents-online/en-us/contactus/product/container-storage-modules)
* [Security](https://github.com/dell/csm/blob/main/docs/SECURITY.md)
## Build
This project contains multiple go modules, and you can build multiple binaries & images with the provided Makefile.
### Dependencies
This project relies on the following tools which have to be installed in order to generate certain manifests.
| Tool | Version |
| ----------------- | ------------ |
| controller-gen | v0.15.0 |
| kustomize | v5.4.3 |
The above tools can also be installed by running the command `make tools`.
### Custom Resource Definitions
Run the command `make manifests` to build the CSM Replication Custom Resource Definitions (CRDs). This command invokes `controller-gen` to generate the CRDs.
The API code is annotated with `kubebuilder` tags which are used by the `controller-gen` generators. The generated definitions are present in the form
of a _kustomize_ recipe in the `config/crd` folder.
### Binaries
To build all the binaries associated with CSM Replication, run `make build`.
To compile individual binaries run:
- `make build-controller-manager` to build the CSM Replication Controller, _dell-replication-controller_.
- `make build-sidecar-manager` to build the CSM Replication sidecar, _dell-csi-replicator_.
- `make build-sidecar-migrator` to build the CSM Replication sidecar, _dell-csi-migrator_.
- `make build-sidecar-node-rescanner` to build the CSM Replication sidecar, _dell-csi-node-rescanner_.
#### Repctl
To build the repctl binary, run `cd repctl && make build`.
### Static manifests
In order to simplify installation for users who don't want to use `kustomize`, statically generated manifests are stored in the repository.
* deploy/controller.yaml - manifest for installing the _CSM Replication Controller_.
* deploy/role.yaml - manifest for creating ClusterRole for _CSM Replication Controller_.
* deploy/replicationcrds.all.yaml - manifest for install _CSM Replication CRDs_.
In case there are modifications done which update the CRD, run `make static-crd` and commit changes to the CRD file in the repository.
In case there are modifications done which update any manifests for the installation of the _CSM Replication Controller_, run
`make static-controller` and commit changes to the file `deploy/controller.yaml` in the repository.
### Container Images
There are various Makefile targets available for building and pushing container images
| Target | Description |
| --------- | ----------- |
| image-sidecar | Build `dell-csi-replicator` sidecar image |
| image-sidecar-push | Build `dell-csi-replicator` sidecar image & push to an image repo |
| image-controller | Build `dell-replication-controller` image |
| image-controller-push | Build `dell-replication-controller` image & push to an image repo |
| images | Build both `dell-csi-replicator` & `dell-replication-controller` images |
| images-push | Push both `dell-csi-replicator` & `dell-replication-controller` images |
**Note**: `make images` will also tag the built images with the release tags and push those tags to the image repo.
### RBAC manifests
For building the RBAC rules for the sidecar, run `make sidecar-rbac`.
For building the RBAC rules for the controller, run `make controller-rbac`.
### Custom Resource Definitions
You can run the command `make install` to install the Custom Resource Definitions in your Kubernetes cluster.
### CSM Replication sidecar
The CSM Replication sidecar container can only be installed as a sidecar within the CSI driver controller pod. The kubernetes controllers which
run as part of the sidecar container, communicate with the CSI drivers using [gRPC](https://grpc.io/) over a Unix Domain Socket (UDS). The address for this socket
can be passed as an argument to the sidecar container.
The [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) permissions required by the kubernetes controllers are present in the file
`config/sidecar-rbac/role.yaml` and should be included in the CSI driver's RBAC permissions.
You can also run the `dell-csi-replicator` process directly in your Kubernetes cluster by running the command `make run-sidecar`.
Make sure that the kubernetes user has the desired RBAC permissions as described above.
### CSM Replication Controller
You can install the CSM Replication Controller by running the command `make deploy-controller`. The namespace `dell-replication-controller` must exist in the cluster before this installation.
You can also run the `dell-replication-controller` process directly in your Kubernetes cluster by running the command `make run-controller`.
Make sure that the kubernetes user has the desired RBAC permissions.
#### Platform Notes
If you wish to install CSM Replication Controller with repctl on your openSUSE server, when referring to this [section](https://dell.github.io/csm-docs/docs/deployment/helm/modules/installation/replication/install-repctl/), you need to install `glibc-devel-static` devel package before running `make build`.
## Testing
Click [here](/TESTING.md) for details on how to test.