Skip to content

Commit

Permalink
Merge pull request #444 from prasadkatti/master
Browse files Browse the repository at this point in the history
docs: cleanup install with helm readme
  • Loading branch information
andyzhangx authored May 11, 2024
2 parents 7f3f30b + 33f0a64 commit c4b2c5f
Showing 1 changed file with 5 additions and 76 deletions.
81 changes: 5 additions & 76 deletions helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,17 @@ local-volume-provisioner in your Kubernetes with `helm install` directly.
- [Custom your deployment with values file](#custom-your-deployment-with-values-file)
- [Install local-volume-provisioner](#install-local-volume-provisioner)
- [Generate yaml files with `helm template` and install with `kubectl`](#generate-yaml-files-with-helm-template-and-install-with-kubectl)
- [helm version \< v3.0.0](#helm-version--v300)
- [Install using helm repo](#install-using-helm-repo)
- [Install with `helm install` directly](#install-with-helm-install-directly)
- [helm version \>= v3.0.0](#helm-version---v300)
- [Install with `helm install` directly](#install-with-helm-install-directly-1)
- [Configurations](#configurations)
- [Examples](#examples)

## Install Helm

Please follow [official
instructions](https://helm.sh/docs/using_helm/#installing-helm) to install
`helm` client and server in your Kubernetes cluster.
instructions](https://helm.sh/docs/intro/install/) to install `helm`.

Required helm version: >= 2.7.2+

## Custom your deployment with values file
## Customize your deployment with values file

Our chart provides a variety of options to configure deployment, see [provisioner/values.yaml](./provisioner/values.yaml).

Expand All @@ -41,75 +36,9 @@ Helm templating is used to generate the provisioner's DaemonSet, ConfigMap and
other necessary objects' specs. The generated specs can be further customized
as needed (usually not necessary), and then deployed using kubectl.

**helm template** uses 3 sources of information:

1. Provisioner's chart templates
2. Provisioner's default values.yaml which contains variables used for rendering a template.
3. (Optional) User's customized values.yaml as a part of helm template command. User's provided
values will override default values of Provisioner's values.yaml.

Here is basic workflow:

### helm version < v3.0.0

Install via helm template:

```console
git clone --depth=1 https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner.git
helm template ./helm/provisioner -f <path-to-your-values-file> --name <release-name> --namespace <namespace> > local-volume-provisioner.generated.yaml
edit local-volume-provisioner.generated.yaml if necessary
kubectl create -f local-volume-provisioner.generated.yaml
```

Delete:

```console
kubectl delete -f local-volume-provisioner.generated.yaml
```

Upgrade:

**Update your custom values to match the new chart parameter**

```console
# Teardown the old provisioner
kubectl delete -f local-volume-provisioner.generated.yaml

# Update your custom values to match the new chart parameter

# Apply the new generated.yaml
kubectl create -f local-volume-provisioner.generated.yaml
```

### Install with `helm install` directly

Helm provides an easy interface to install applications and sources into
Kubernetes cluster. You can install local-volume-provisioner with `helm
install` command directly. Here is basic workflow:

Install:

```console
helm install ./helm/provisioner -f <path-to-your-values-file> --namespace <namespace> --name <release-name>
```

Note: set your preferred namespace and release name, e.g. `helm install ./helm/provisioner -f helm/examples/gke.yaml --namespace kube-system --name local-volume-provisioner`

Delete:

```console
helm delete --purge <release-name>
```

Upgrade: **This action will `recreate` the running pod**

**Update your custom values to match the new chart parameter**

```console
helm upgrade ./helm/provisioner -f <path-to-your-values-file> <release-name>
```

### helm version >= v3.0.0
### Install using helm repo

Install by adding the repo as a Helm repo:

Expand Down Expand Up @@ -179,7 +108,7 @@ helm upgrade --reset-value -f <path-to-your-values-file> <release-name> --namesp

`--reset-values` will reset custom values to the values from the new chart version. `-f` apply the custom values file on top.

Please refer [helm docs](https://helm.sh/docs/using_helm/#using-helm) for more
Please refer [helm docs](https://helm.sh/docs/intro/using_helm/) for more
information.

## Configurations
Expand Down

0 comments on commit c4b2c5f

Please sign in to comment.