README
¶
PVC autoscaler for Kubernetes
PVC Autoscaler is an open-source project aimed at providing autoscaling functionality to Persistent Volume Claims (PVCs) in Kubernetes environments. It allows you to automatically scale your PVCs based on your workloads and the metrics collected.
Please note that PVC Autoscaler is currently in a heavy development phase. As such, it's not recommended for production usage at this point.
Motivation
The motivation behind the PVC Autoscaler project is to provide developers with an easy and efficient way of managing storage resources within their Kubernetes clusters. With the PVC Autoscaler, there's no need to manually adjust the size of your PVCs as your storage needs change. The Autoscaler handles this for you, freeing you up to focus on other areas of your development work.
Limitations
At this stage of development only one update is possible per PVC. This is due to the fact that different storage types of different cloud providers have constraints on multiple resizing that need to be researched.
Currently it only supports Prometheus for collecting metrics
Installation
PVC Autoscaler comes with a Helm chart for easy deployment in a Kubernetes cluster. You can find the chart in the charts directory of this repository.
To install the PVC Autoscaler using its Helm chart, navigate to the root directory of the repository and execute the following command:
helm install <release-name> ./charts -n kube-system
Replace <release-name> with the name you'd like to give to this Helm release.
Testing
To test PVC Autoscaler, you'll need a Kubernetes cluster that supports expandable storage classes, i.e. it contains allowVolumeExpansion: true. As an example you can consider:
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: gp3-expandable
provisioner: ebs.csi.aws.com
parameters:
type: gp3
fsType: ext4
reclaimPolicy: Delete
allowVolumeExpansion: true
Remember that if you work with EKS you need the EBS CSI Driver. Please refer to this page for mor info.
Contributions
Contributions to PVC Autoscaler are more than welcome! Whether you want to help me improve the code, add new features, fix bugs, or improve our documentation, I would be glad to receive your pull requests and issues.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Directories