From db501da34d8fa0e112c186dc9eb72a315e98ff82 Mon Sep 17 00:00:00 2001 From: Sean Malloy Date: Thu, 23 Jul 2020 22:11:17 -0500 Subject: [PATCH 1/2] Clean Up End User Helm Documentation * Correct helm install command in documentation * Add link to helm install docs from main README --- README.md | 5 +++++ charts/descheduler/README.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index edbbaa04b..38dcf9987 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,11 @@ kubectl create -f kubernetes/configmap.yaml kubectl create -f kubernetes/cronjob.yaml ``` +### Install Using Helm + +Starting with release v0.18.0 there is an official helm chart that can be used to install the +descheduler. See the [helm chart README](https://github.com/kubernetes-sigs/descheduler/blob/master/charts/descheduler/README.md) for detailed instructions. + ## User Guide See the [user guide](docs/user-guide.md) in the `/docs` directory. diff --git a/charts/descheduler/README.md b/charts/descheduler/README.md index a45d76a71..84e48828f 100644 --- a/charts/descheduler/README.md +++ b/charts/descheduler/README.md @@ -6,7 +6,7 @@ ```shell helm repo add descheduler https://kubernetes-sigs.github.io/descheduler/ -$ helm install descheduler/descheduler --name my-release +helm install --name my-release descheduler/descheduler-helm-chart ``` ## Introduction From 8d5ab05aa0f3f520d5a2f64695c5dd2690357ff9 Mon Sep 17 00:00:00 2001 From: Sean Malloy Date: Thu, 23 Jul 2020 22:14:22 -0500 Subject: [PATCH 2/2] Add Helm Badge To README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 38dcf9987..46afac21f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Go Report Card](https://goreportcard.com/badge/kubernetes-sigs/descheduler)](https://goreportcard.com/report/sigs.k8s.io/descheduler) +![Release Charts](https://github.com/kubernetes-sigs/descheduler/workflows/Release%20Charts/badge.svg) # Descheduler for Kubernetes