https://github.com/dell/karavi-resiliency
A Kubernetes pod monitor for safely terminating pods with persistent volumes in case of node failures
https://github.com/dell/karavi-resiliency
Last synced: 3 months ago
JSON representation
A Kubernetes pod monitor for safely terminating pods with persistent volumes in case of node failures
- Host: GitHub
- URL: https://github.com/dell/karavi-resiliency
- Owner: dell
- License: apache-2.0
- Created: 2021-02-02T12:46:34.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-26T15:38:15.000Z (4 months ago)
- Last Synced: 2025-09-26T17:38:16.935Z (4 months ago)
- Language: Go
- Homepage:
- Size: 1.84 MB
- Stars: 13
- Watchers: 21
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# :lock: **Important Notice**
Starting with the release of **Container Storage Modules v1.16.0**, this repository will no longer be maintained as an open source project. Future development will continue under a closed source model. This change reflects our commitment to delivering even greater value to our customers by enabling faster innovation and more deeply integrated features with the Dell storage portfolio.
For existing customers using Dell’s Container Storage Modules, you will continue to receive:
* **Ongoing Support & Community Engagement**
You will continue to receive high-quality support through Dell Support and our community channels. Your experience of engaging with the Dell community remains unchanged.
* **Streamlined Deployment & Updates**
Deployment and update processes will remain consistent, ensuring a smooth and familiar experience.
* **Access to Documentation & Resources**
All documentation and related materials will remain publicly accessible, providing transparency and technical guidance.
* **Continued Access to Current Open Source Version**
The current open-source version will remain available under its existing license for those who rely on it.
Moving to a closed source model allows Dell’s development team to accelerate feature delivery and enhance integration across our Enterprise Kubernetes Storage solutions ultimately providing a more seamless and robust experience.
We deeply appreciate the contributions of the open source community and remain committed to supporting our customers through this transition.
For questions or access requests, please contact the maintainers via [Dell Support](https://www.dell.com/support/kbdoc/en-in/000188046/container-storage-interface-csi-drivers-and-container-storage-modules-csm-how-to-get-support).
# Dell Container Storage Modules (CSM) for Resiliency
[](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://hub.docker.com/r/dellemc/podmon)
[](go.mod)
[](https://github.com/dell/karavi-resiliency/releases/latest)
[](https://github.com/dell/karavi-resiliency/releases)
CSM for Resiliency is part of the [CSM (Container Storage Modules)](https://github.com/dell/csm) open-source suite of Kubernetes storage enablers for Dell products. CSM for Resiliency is a project designed to make Kubernetes Applications, including those that utilize persistent storage, more resilient to various failures. The first component of CSM for Resiliency is a pod monitor that is specifically designed to protect stateful applications from various failures. It is not a standalone application, but rather is deployed as a _sidecar_ to Dell CSI (Container Storage Interface) drivers, in both the driver's controller pods and the driver's node pods. Deploying CSM for Resiliency as a sidecar allows it to make direct requests to the driver through the Unix domain socket that Kubernetes sidecars use to make CSI requests.
Some of the methods CSM for Resiliency invokes in the driver are standard CSI methods, such as NodeUnpublishVolume, NodeUnstageVolume, and ControllerUnpublishVolume. CSM for Resiliency also uses proprietary calls that are not part of the standard CSI specification. Currently, there is only one, ValidateVolumeHostConnectivity that returns information on whether a host is connected to the storage system and/or whether any I/O activity has happened in the recent past from a list of specified volumes. This allows CSM for Resiliency to make more accurate determinations about the state of the system and its persistent volumes.
Accordingly, CSM for Resiliency is adapted to, and qualified with each Dell CSI driver it is to be used with. Different storage systems have different nuances and characteristics that CSM for Resiliency must take into account.
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)
- [About](#about)
## Building CSM for Resiliency
If you wish to clone and build CSM for Resiliency, a Linux host is required with the following installed:
| Component | Version | Additional Information |
| --------------- | --------- | ---------------------------------------------------------------------- |
| Podman | v4.4.1+ | [Podman installation](https://podman.io/docs/installation) |
| Buildah | v1.29.1+ | [Buildah installation](https://www.redhat.com/sysadmin/getting-started-buildah) |
| Golang | v1.21+ | [Golang installation](https://go.dev/dl/) |
| git | latest | [Git installation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) |
Once all prerequisites are on the Linux host, follow the steps below to clone, build and deploy CSM for Resiliency:
1. Clone the repository: `git clone https://github.com/dell/karavi-resiliency.git`
2. Define and export the following environment variables to point to your Podman registry:
```sh
export REGISTRY_HOST=
export REGISTRY_PORT=
export VERSION=
```
3. At the root of the source tree, run the following to build and deploy: `make`
## Testing CSM for Resiliency
From the root directory where the repo was cloned, the unit tests can be executed as follows:
```sh
make unit-test
```
## Versioning
This project is adhering to [Semantic Versioning](https://semver.org/).
## About
Dell Container Storage Modules (CSM) is 100% open source and community-driven. All components are available
under [Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0.html) on
GitHub.