{"id":13547366,"url":"https://github.com/opstree/dynamic-pv-scaler","last_synced_at":"2025-04-02T19:33:01.525Z","repository":{"id":64297376,"uuid":"242195159","full_name":"opstree/dynamic-pv-scaler","owner":"opstree","description":"A golang based Kubernetes application which can scale volume dynamically","archived":false,"fork":false,"pushed_at":"2022-09-07T18:01:54.000Z","size":611,"stargazers_count":113,"open_issues_count":1,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-03T15:38:40.101Z","etag":null,"topics":["aws","azure","dynamic","gcp","golang","hacktoberfest","hacktoberfest-accepted","kubernetes","minikube","persistent-volume-claim","quay","volume-resize"],"latest_commit_sha":null,"homepage":"https://opstree.github.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opstree.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-21T17:31:44.000Z","updated_at":"2024-08-22T06:13:29.000Z","dependencies_parsed_at":"2023-01-15T08:45:45.456Z","dependency_job_id":null,"html_url":"https://github.com/opstree/dynamic-pv-scaler","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opstree%2Fdynamic-pv-scaler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opstree%2Fdynamic-pv-scaler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opstree%2Fdynamic-pv-scaler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opstree%2Fdynamic-pv-scaler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opstree","download_url":"https://codeload.github.com/opstree/dynamic-pv-scaler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246880355,"owners_count":20848847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","azure","dynamic","gcp","golang","hacktoberfest","hacktoberfest-accepted","kubernetes","minikube","persistent-volume-claim","quay","volume-resize"],"created_at":"2024-08-01T12:00:54.629Z","updated_at":"2025-04-02T19:33:00.107Z","avatar_url":"https://github.com/opstree.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./static/dynamic-pv-scaler.svg\" height=\"180\" width=\"180\"\u003e\n\u003c/p\u003e\n\n[![GitHub Super-Linter](https://github.com/opstree/dynamic-pv-scaler/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/opstree/dynamic-pv-scaler)\n[![Go Report Card](https://goreportcard.com/badge/github.com/opstree/dynamic-pv-scaler)](https://goreportcard.com/report/github.com/opstree/dynamic-pv-scaler)\n[![Maintainability](https://api.codeclimate.com/v1/badges/e60ff968a326babe871f/maintainability)](https://codeclimate.com/github/opstree/dynamic-pv-scaler/maintainability)\n[![Docker Repository on Quay](https://img.shields.io/badge/container-ready-green \"Docker Repository on Quay\")](https://quay.io/repository/opstree/dynamic-pv-scaler)\n[![Apache License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/opstree/dynamic-pv-scaler)\n\n## Volume Booster\n\nA golang based Kubernetes application which has been created to overcome the scaling issue of Persistent Volume in Kubernetes. This can scale the Persistent Volume on the basis of threshold which you have set.\n\n## Getting Started\n\n### Architecture\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./static/dynamic-pv-scaler-arch.png\"\u003e\n\u003c/p\u003e\n\n### Pre-requisites\n\nSorry none of these pre-requisites can be compromised. So you guys have to meet these requirements :slightly_smiling_face:\n\n- Kubernetes cluster version should be greater than 1.11+\n- Prometheus should be have the information of Persistent Volume\n- In storageclass, *allowVolumeExpansion* flag should be `true`\n\nExample:-\n\n```yaml\n---\napiVersion: storage.k8s.io/v1\nkind: StorageClass\nmetadata:\n  name: standard\nprovisioner: kubernetes.io/aws-ebs\nparameters:\n  type: gp2\nreclaimPolicy: Retain\nallowVolumeExpansion: true # This should be true for every storage class\nmountOptions:\n  - debug\nvolumeBindingMode: Immediate\n```\n\nThat's it\n\n### Configuration\n\nWe are using helm to maintain the deployment and release in Kubernetes cluster. [Hit Me](./deploy/helm). But for configuration part this application accepts a yaml file `.config.yaml`:\n\n```yaml\n---\n- namespace: database\n  scale_percentage: 50\n  threshold_percentage: 80\n  pvc_name: data-mysql-0\n```\n\nConfiguration file overview:-\n\n| **Field** | **Default Value** | **Possible Values** | **Description** |\n|-----------|-------------------|---------------------|-----------------|\n| namespace | - | *Any valid k8s namespace* | Persistent Volume's namespace which needs to be watched |\n| scale_percentage | - | *Any integer* | How much percent you want to scale your pv |\n| threshold_percentage | - | *Any integer* | The target percentage after which you want to scale the pv |\n| pvc_name | - | *Any valid k8s pvc name* | Name of the pvc which you want to scale |\n\nMake sure you have updated the configuration in [values.yaml](./deploy/helm/values.yaml).\n\n### Installation\n\nSimply use the helm chart to install it on your flavor of Kubernetes.\n\n```shell\n# Deploy the PV Scaler\nhelm upgrade dynamic-pv-scaler ./deploy/helm --install --namespace dynamic-pv-scaler\n```\n\nVerify the installation\n\n```shell\nhelm test dynamic-pv-scaler --namespace dynamic-pv-scaler\nkubectl get pods -n dynamic-pv-scaler\n```\n\n### Logging\n\nThe application's logging interface is designed to print logs in JSON stdout. Example logs:-\n\n![](./static/dynamic-pv-scaler-logging.png)\n\n## Development\n\nPlease see our [development documentation](./DEVELOPMENT.md) for details.\n\n## Release\n\nPlease see our [release documentation](./CHANGELOG.md) for details.\n\n## Contact\n\nIf you have any suggestion or query. Contact us at\n\nopensource@opstree.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopstree%2Fdynamic-pv-scaler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopstree%2Fdynamic-pv-scaler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopstree%2Fdynamic-pv-scaler/lists"}