Updated README

4 years ago · 0519e31940
1 changed files with 4 additions and 72 deletions
--- a/charts/local-path-provisioner/v0.1.0/README.md
+++ b/charts/local-path-provisioner/v0.1.0/README.md
@ -6,13 +6,7 @@ utilize the local storage in each node. Based on the user configuration, the Loc
 Persistent Volume feature](https://kubernetes.io/blog/2018/04/13/local-persistent-volumes-beta/), but make it a simpler
 solution than the built-in `local` volume feature in Kubernetes.

-## TL;DR;
-
-```console
-$ git clone https://github.com/rancher/local-path-provisioner.git
-$ cd local-path-provisioner
-$ helm install --name local-path-storage --namespace local-path-storage ./deploy/chart/
-```
+This Helm Chart is based on the [official local-path-provisioner chart](https://github.com/rancher/local-path-provisioner/tree/master/deploy/chart) and on previous work on the [Interlegis local-path-provisioner chart](https://github.com/interlegis/il-charts/tree/master/local-path-provisioner). 

 ## Introduction

@ -23,31 +17,6 @@ This chart bootstraps a [Local Path Provisioner](https://github.com/rancher/loca

 - Kubernetes 1.12+ with Beta APIs enabled

-## Installing the Chart
-
-To install the chart with the release name `local-path-storage`:
-
-```console
-$ git clone https://github.com/rancher/local-path-provisioner.git
-$ cd local-path-provisioner
-$ helm install ./deploy/chart/ --name local-path-storage --namespace local-path-storage
-```
-
-The command deploys Local Path Provisioner on the Kubernetes cluster in the default configuration. The
-[configuration](#configuration) section lists the parameters that can be configured during installation.
-
-> **Tip**: List all releases using `helm list`
-
-## Uninstalling the Chart
-
-To uninstall/delete the `local-path-storage` deployment:
-
-```console
-$ helm delete --purge local-path-storage
-```
-
-The command removes all the Kubernetes components associated with the chart and deletes the release.
-
 ## Configuration

 The following table lists the configurable parameters of the Local Path Provisioner for Kubernetes chart and their
@ -63,7 +32,8 @@ default values.
 | `storageClass.defaultClass`         | If true, set the created `StorageClass` as the cluster's default `StorageClass` | `false`                                                                             |
 | `storageClass.name`                 | The name to assign the created StorageClass                                     | local-path                                                                          |
 | `storageClass.reclaimPolicy`        | ReclaimPolicy field of the class                                                | Delete                                                                              |
-| `nodePathMap`                       | Configuration of where to store the data on each node                           | `[{node: DEFAULT_PATH_FOR_NON_LISTED_NODES, paths: [/opt/local-path-provisioner]}]` |
+| `storageClass.hostDir`              | Default host path for volumes. Ignored if using customNodePathMap.              | `/opt/local-path-provisioner`                                                       |
+| `customNodePathMap`                 | Custom configuration of where to store the data on each node                    | `[]`                                                                                |
 | `resources`                         | Local Path Provisioner resource requests & limits                               | `{}`                                                                                |
 | `rbac.create`                       | If true, create & use RBAC resources                                            | `true`                                                                              |
 | `serviceAccount.create`             | If true, create the Local Path Provisioner service account                      | `true`                                                                              |
@ -76,41 +46,3 @@ default values.
 | `configmap.name`                    | configmap name                                                                  | `local-path-config`                                                                 |
 | `configmap.helperPod`               | helper pod yaml file                                                            | apiVersion: v1<br>kind: Pod<br>metadata:<br>&emsp;name: helper-pod<br>spec:<br>&emsp;containers:<br>&emsp;- name: helper-pod<br>&emsp;&emsp;image: busybox |

-
-Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
-
-```console
-$ helm install ./deploy/chart/ --name local-path-storage --namespace local-path-storage --set storageClass.provisionerName=rancher.io/local-path
-```
-
-Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
-chart. For example,
-
-```console
-$ helm install --name local-path-storage --namespace local-path-storage ./deploy/chart/ -f values.yaml
-```
-
-> **Tip**: You can use the default [values.yaml](values.yaml)
-
-## RBAC
-
-By default the chart will install the recommended RBAC roles and rolebindings.
-
-You need to have the flag `--authorization-mode=RBAC` on the api server. See the following document for how to enable
-[RBAC](https://kubernetes.io/docs/admin/authorization/rbac/).
-
-To determine if your cluster supports RBAC, run the following command:
-
-```console
-$ kubectl api-versions | grep rbac
-```
-
-If the output contains "beta", you may install the chart with RBAC enabled (see below).
-
-### Enable RBAC role/rolebinding creation
-
-To enable the creation of RBAC resources (On clusters with RBAC). Do the following:
-
-```console
-$ helm install ./deploy/chart/ --name local-path-storage --namespace local-path-storage --set rbac.create=true
-```