https://github.com/tkestack/volume-decorator
https://github.com/tkestack/volume-decorator
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/tkestack/volume-decorator
- Owner: tkestack
- License: other
- Created: 2019-11-05T10:33:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-15T07:30:37.000Z (about 6 years ago)
- Last Synced: 2025-05-14T16:42:03.490Z (about 1 year ago)
- Language: Go
- Size: 150 KB
- Stars: 14
- Watchers: 7
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# volume-decorator
Controller that maintains more runtime information for Kubernetes volume(PVC), such as application identities, real usage, etc.
## Features
- Check volume availability when a workload with volumes created.
- Collect workloads attached by of a volume.
- Maintain realtime status of volumes, such as `Pending`, `Expanding`, etc.
- Collect current mounted nodes of a volume.
- Collect real usage bytes of a volume.
## Prerequisites
These build instructions assume you have a Linux build environment with:
- Docker
- git
- make
- golang version > 1.11, with GO111MODULE=on
- revive `go get -u github.com/mgechev/revive`
## Build
To make the binary, just run:
```bash
make volume-decorator
```
The binary will be located at `output/bin/volume-decorator`.
## Usage
`volume-decorator` can be deployed inside the kubernetes cluster:
1. Create the RBAC objects needed by `volume-decorator`:
```bash
kubectl -f deploy/kubernetes/rbac.yaml
```
2. Create a deployment to run the `volume-decorator`:
```bash
kubectl -f deploy/kubernetes/deployment.yaml
```
## Examples
There are a large number of examples in [examples](examples/).