Skip to content

Commit

Permalink
Bumping docs to 1.0.5 release
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewFarley committed Oct 25, 2022
1 parent 308cc50 commit 72ce208
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .github/farley-publish-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ cd helm-chart && ./update-templates-from-foundational-template.sh && cd ..
# Lint check
helm lint ./helm-chart --set name=test,namespace=test
# Bump version.
export PREVIOUS_RELEASE_TAG=1.0.3 # <---- NOTE: UPDATE ME BEFORE RUNNING THE BELOW
export CI_COMMIT_TAG=1.0.4 # <---- NOTE: UPDATE ME BEFORE RUNNING THE BELOW
export PREVIOUS_RELEASE_TAG=1.0.4 # <---- NOTE: UPDATE ME BEFORE RUNNING THE BELOW
export CI_COMMIT_TAG=1.0.5 # <---- NOTE: UPDATE ME BEFORE RUNNING THE BELOW
sed -i "s/1.0.0/$CI_COMMIT_TAG/g" helm-chart/Chart.yaml
sed -i "s/latest/$CI_COMMIT_TAG/g" helm-chart/values.yaml
# Package
Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kubernetes Volume / Disk Autoscaler (via Prometheus)

<a href="https://hub.docker.com/r/devopsnirvana/kubernetes-volume-autoscaler"><img src="https://img.shields.io/docker/pulls/devopsnirvana/kubernetes-volume-autoscaler?style=plastic" alt="Docker Hub Pulls"></a> <a href="https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/releases/tag/1.0.4"><img src="https://img.shields.io/docker/v/devopsnirvana/kubernetes-volume-autoscaler/1.0.4?label=Latest%20Release&style=plastic" alt="Latest Release"></a> <a href="https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/stargazers"><img src="https://img.shields.io/github/stars/DevOps-Nirvana/Kubernetes-Volume-Autoscaler?style=social" alt="Stargazers on Github"></a>
<a href="https://hub.docker.com/r/devopsnirvana/kubernetes-volume-autoscaler"><img src="https://img.shields.io/docker/pulls/devopsnirvana/kubernetes-volume-autoscaler?style=plastic" alt="Docker Hub Pulls"></a> <a href="https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/releases/tag/1.0.5"><img src="https://img.shields.io/docker/v/devopsnirvana/kubernetes-volume-autoscaler/1.0.5?label=Latest%20Release&style=plastic" alt="Latest Release"></a> <a href="https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/stargazers"><img src="https://img.shields.io/github/stars/DevOps-Nirvana/Kubernetes-Volume-Autoscaler?style=social" alt="Stargazers on Github"></a>

This repository contains a [Kubernetes controller](https://kubernetes.io/docs/concepts/architecture/controller/) that automatically increases the size of a Persistent Volume Claim in Kubernetes when it is nearing full. Initially engineered based on AWS EKS, this should support any Kubernetes cluster or cloud provider which supports dynamically hot-resizing storage volumes in Kubernetes.

Expand Down Expand Up @@ -107,15 +107,15 @@ helm uninstall volume-autoscaler
# the namespace you can run the first few commands below...

# IF YOU USE `infrastructure` AS THE NAMESPACE FOR PROMETHEUS SIMPLY...
kubectl --namespace infrastructure apply https://devops-nirvana.s3.amazonaws.com/volume-autoscaler/volume-autoscaler-1.0.4.yaml
kubectl --namespace infrastructure apply https://devops-nirvana.s3.amazonaws.com/volume-autoscaler/volume-autoscaler-1.0.5.yaml

# OR, IF YOU NEED TO CHANGE THE NAMESPACE...
# #1: Download the yaml...
wget https://devops-nirvana.s3.amazonaws.com/volume-autoscaler/volume-autoscaler-1.0.4.yaml
wget https://devops-nirvana.s3.amazonaws.com/volume-autoscaler/volume-autoscaler-1.0.5.yaml
# #1: Or download with curl
curl https://devops-nirvana.s3.amazonaws.com/volume-autoscaler/volume-autoscaler-1.0.4.yaml -o volume-autoscaler-1.0.4.yaml
curl https://devops-nirvana.s3.amazonaws.com/volume-autoscaler/volume-autoscaler-1.0.5.yaml -o volume-autoscaler-1.0.5.yaml
# #2: Then replace the namespace in this, replacing
cat volume-autoscaler-1.0.4.yaml | sed 's/"infrastructure"/"PROMETHEUS_NAMESPACE_HERE"/g' > ./to_be_applied.yaml
cat volume-autoscaler-1.0.5.yaml | sed 's/"infrastructure"/"PROMETHEUS_NAMESPACE_HERE"/g' > ./to_be_applied.yaml
# #3: If you wish to have slack notifications, edit this to_be_applied.yaml and embed your webhook on the value: line for SLACK_WEBHOOK and set the SLACK_CHANNEL as well accordingly
# #4: Finally, apply it...
kubectl --namespace REPLACEME_WITH_PROMETHEUS_NAMESPACE apply ./to_be_applied.yaml
Expand Down Expand Up @@ -206,6 +206,12 @@ This controller also supports publishing prometheus metrics automatically. It h
# Release History
### [Current Release: 1.0.5 - Oct 26, 2022](https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/releases/tag/1.0.5)
```
Handling low max disk size edge-case better (thanks @GuillaumeOuint)
Human-readable debug output much improved
```

### [Release: 1.0.4 - Oct 24, 2022](https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/releases/tag/1.0.4)
```
Generate informational Prometheus metrics (version number and settings)
Expand Down Expand Up @@ -244,8 +250,6 @@ Some basic documentation and installation help/guides

# TODO

Current Release: 1.0.4

This todo list is mostly for the Author(s), but any contributions are also welcome. Please [submit an Issue](https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/issues) for issues/requests, or an [Pull Request](https://github.com/DevOps-Nirvana/Kubernetes-Volume-Autoscaler/pulls) if you added some code. These items are generally put in order of most-important first.

* Listen/watch to events of the PV/PVC, or listen/read from Prometheus to monitor and ensure the resizing happens, log and/or slack it accordingly
Expand Down

0 comments on commit 72ce208

Please sign in to comment.